Mercurial > octave-nkf

annotate examples/@polynomial/polynomial.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 567e3e4ab74d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 ## -*- texinfo -*-
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 9284
diff changeset
2 ## @deftypefn {Function File} {} polynomial ()
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## @deftypefnx {Function File} {} polynomial (@var{a})
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 9284
diff changeset
4 ## Create a polynomial object representing the polynomial
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ##
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## @example
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## a0 + a1 * x + a2 * x^2 + @dots{} + an * x^n
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## @end example
9284
567e3e4ab74d fix up examples/@polynomial
Robert T. Short <octave@phaselockedsystems.com>
parents: 8664
diff changeset
9 ##
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 9284
diff changeset
10 ## @noindent
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 9284
diff changeset
11 ## from a vector of coefficients [a0 a1 a2 @dots{} an].
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## @end deftypefn
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
13
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 function p = polynomial (a)
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 if (nargin == 0)
9284
567e3e4ab74d fix up examples/@polynomial
Robert T. Short <octave@phaselockedsystems.com>
parents: 8664
diff changeset
16 p.poly = [0];
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 p = class (p, "polynomial");
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
18 elseif (nargin == 1)
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 if (strcmp (class (a), "polynomial"))
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 p = a;
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 elseif (isvector (a) && isreal (a))
9284
567e3e4ab74d fix up examples/@polynomial
Robert T. Short <octave@phaselockedsystems.com>
parents: 8664
diff changeset
22 p.poly = a(:).';
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 p = class (p, "polynomial");
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 else
9284
567e3e4ab74d fix up examples/@polynomial
Robert T. Short <octave@phaselockedsystems.com>
parents: 8664
diff changeset
25 error ("polynomial: expecting real vector");
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 endif
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 else
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 print_usage ();
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 endif
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 endfunction