Mercurial > hg > octave-nkf

annotate examples/code/@FIRfilter/FIRfilter.m @ 20441:83792dd9bcc1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use in-place operators in m-files where possible. * scripts/audio/@audioplayer/set.m, scripts/audio/@audiorecorder/set.m, scripts/audio/mu2lin.m, scripts/elfun/cosd.m, scripts/general/del2.m, scripts/general/profexplore.m, scripts/general/quadl.m, scripts/general/rat.m, scripts/general/rotdim.m, scripts/help/get_first_help_sentence.m, scripts/help/private/__strip_html_tags__.m, scripts/image/cubehelix.m, scripts/io/textread.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/onenormest.m, scripts/optimization/fminsearch.m, scripts/optimization/lsqnonneg.m, scripts/optimization/qp.m, scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/specular.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/hist.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/private/__stem__.m, scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/findobj.m, scripts/plot/util/print.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/rotate.m, scripts/polynomial/pchip.m, scripts/polynomial/polyaffine.m, scripts/polynomial/polyder.m, scripts/polynomial/private/__splinefit__.m, scripts/polynomial/residue.m, scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m, scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/freqz.m, scripts/signal/hamming.m, scripts/signal/hanning.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/signal/stft.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/private/__sprand_impl__.m, scripts/sparse/qmr.m, scripts/sparse/sprandsym.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/gls.m, scripts/statistics/models/logistic_regression.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/wilcoxon_test.m, scripts/time/datevec.m: Use in-place operators in m-files where possible.
author Rik <rik@octave.org>
date Tue, 26 May 2015 21:07:42 -0700
parents c8240a60dd01
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
1 ## -*- texinfo -*-
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 9251
diff changeset
2 ## @deftypefn {Function File} {} FIRfilter ()
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
3 ## @deftypefnx {Function File} {} FIRfilter (@var{p})
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 9251
diff changeset
4 ## Create a FIR filter with polynomial @var{p} as coefficient vector.
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
5 ## @end deftypefn
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
6
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
7 function f = FIRfilter (p)
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
8
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
9 f.polynomial = [];
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
10 if (nargin == 0)
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
11 p = @polynomial ([1]);
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
12 elseif (nargin == 1)
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
13 if (!isa (p, "polynomial"))
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
14 error ("FIRfilter: expecting polynomial as input argument");
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
15 endif
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
16 else
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
17 print_usage ();
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
18 endif
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
19 f = class (f, "FIRfilter", p);
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
20 endfunction