Mercurial > octave

annotate examples/code/@FIRfilter/FIRfilter_aggregation.m @ 21070:fd97ed44f2da

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use more coding conventions in Object Oriented reference example code. * examples/code/@FIRfilter/FIRfilter.m, examples/code/@FIRfilter/FIRfilter_aggregation.m, examples/code/@FIRfilter/subsasgn.m, examples/code/@FIRfilter/subsref.m, examples/code/@polynomial/display.m, examples/code/@polynomial/double.m, examples/code/@polynomial/get.m, examples/code/@polynomial/mtimes.m, examples/code/@polynomial/numel.m, examples/code/@polynomial/polynomial.m, examples/code/@polynomial/polynomial_superiorto.m, examples/code/@polynomial/polyval.m, examples/code/@polynomial/roots.m, examples/code/@polynomial/set.m, examples/code/@polynomial/subsasgn.m, examples/code/@polynomial/subsref.m: Remove "Function File" from deftypefn. Use names of variables in error messages. Surround invalid items in error messages with single quotes. Use meaningful variable names.
author Rik <rik@octave.org>
date Thu, 14 Jan 2016 09:59:07 -0800
parents 73ab962bc52d
children 28de41192f3c
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 -*-
21070
fd97ed44f2da doc: Use more coding conventions in Object Oriented reference example code.
Rik <rik@octave.org>
parents: 21059
diff changeset
2 ## @deftypefn {} {} FIRfilter ()
fd97ed44f2da doc: Use more coding conventions in Object Oriented reference example code.
Rik <rik@octave.org>
parents: 21059
diff changeset
3 ## @deftypefnx {} {} 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
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
9 if (nargin > 1)
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
10 print_usage ();
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
11 endif
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
12
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
13 if (nargin == 0)
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
14 f.polynomial = @polynomial ([1]);
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
15 else
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
16 if (! isa (p, "polynomial"))
21070
fd97ed44f2da doc: Use more coding conventions in Object Oriented reference example code.
Rik <rik@octave.org>
parents: 21059
diff changeset
17 error ("@FIRfilter: P must be a polynomial object");
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
18 endif
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
19
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
20 f.polynomial = p;
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
21 endif
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
22
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
23 f = class (f, "FIRfilter");
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 19033
diff changeset
24
9251
f8b8ab529913 improve OOP documentation
Robert T. Short <octave@phaselockedsystems.com>
parents:
diff changeset
25 endfunction