Mercurial > octave-antonio
view scripts/polynomial/mpoles.m @ 20165:f1d0f506ee78 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed optimization, polynomial, signal script directories.
* scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/pqpnonneg.m,
scripts/optimization/qp.m, scripts/optimization/sqp.m,
scripts/polynomial/compan.m, scripts/polynomial/mkpp.m,
scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m,
scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m,
scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m,
scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m,
scripts/polynomial/polyint.m, scripts/polynomial/polyout.m,
scripts/polynomial/polyval.m, scripts/polynomial/ppder.m,
scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m,
scripts/polynomial/ppval.m, scripts/polynomial/residue.m,
scripts/polynomial/roots.m, scripts/polynomial/spline.m,
scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m,
scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m,
scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m,
scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m,
scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m,
scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m,
scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m,
scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m,
scripts/signal/sinewave.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m,
scripts/signal/synthesis.m, scripts/signal/unwrap.m,
scripts/signal/yulewalker.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 21:50:57 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2007-2015 Ben Abbott ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}) ## @deftypefnx {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol}) ## @deftypefnx {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol}, @var{reorder}) ## Identify unique poles in @var{p} and their associated multiplicity. ## ## The output is ordered from largest pole to smallest pole. ## ## If the relative difference of two poles is less than @var{tol} then they are ## considered to be multiples. The default value for @var{tol} is 0.001. ## ## If the optional parameter @var{reorder} is zero, poles are not sorted. ## ## The output @var{multp} is a vector specifying the multiplicity of the poles. ## @code{@var{multp}(n)} refers to the multiplicity of the Nth pole ## @code{@var{p}(@var{idxp}(n))}. ## ## For example: ## ## @example ## @group ## p = [2 3 1 1 2]; ## [m, n] = mpoles (p) ## @result{} m = [1; 1; 2; 1; 2] ## @result{} n = [2; 5; 1; 4; 3] ## @result{} p(n) = [3, 2, 2, 1, 1] ## @end group ## @end example ## ## @seealso{residue, poly, roots, conv, deconv} ## @end deftypefn ## Author: Ben Abbott <bpabbott@mac.com> ## Created: Sept 30, 2007 function [multp, indx] = mpoles (p, tol, reorder) if (nargin < 1 || nargin > 3) print_usage (); endif if (nargin < 2 || isempty (tol)) tol = 0.001; endif if (nargin < 3 || isempty (reorder)) reorder = true; endif Np = numel (p); ## Force the poles to be a column vector. p = p(:); ## Sort the poles according to their magnitidues, largest first. if (reorder) ## Sort with smallest magnitude first. [p, ordr] = sort (p); ## Reverse order, largest maginitude first. n = Np:-1:1; p = p(n); ordr = ordr(n); else ordr = 1:Np; endif ## Find pole multiplicty by comparing the relative differnce in the ## poles. multp = zeros (Np, 1); indx = []; n = find (multp == 0, 1); while (n) dp = abs (p-p(n)); if (p(n) == 0.0) if (any (abs (p) > 0 & isfinite (p))) p0 = mean (abs (p(abs (p) > 0 & isfinite (p)))); else p0 = 1; endif else p0 = abs (p(n)); endif k = find (dp < tol * p0); ## Poles can only be members of one multiplicity group. if (numel (indx)) k = k(! ismember (k, indx)); endif m = 1:numel (k); multp(k) = m; indx = [indx; k]; n = find (multp == 0, 1); endwhile multp = multp(indx); indx = ordr(indx); endfunction %!test %! [mp, n] = mpoles ([0 0], 0.01); %! assert (mp, [1; 2]);