Mercurial > hg > octave-nkf

annotate examples/@FIRfilter/FIRfilter.m @ 14093:050bc580cb60 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Various docstring improvements before 3.6.0 release. * NEWS, aspell-octave.en.pws, intro.txi, oop.txi, testfun.txi, tips.txi, FIRfilter.m, FIRfilter_aggregation.m, polynomial.m, polynomial_superiorto.m, usejava.m, pcg.m, pcr.m, nchoosek.m, validatestring.m, assert.m, weekday.m, cellfun.cc, error.cc, strfns.cc: Various docstring improvements before 3.6.0 release.
author Rik <octave@nomad.inbox5.com>
date Wed, 21 Dec 2011 19:46:57 -0800
parents f8b8ab529913
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