Mercurial > octave

annotate examples/code/@polynomial/polynomial.m @ 21059:73ab962bc52d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use newer coding conventions in examples/code directory. * FIRfilter.m, FIRfilter_aggregation.m, display.m, subsasgn.m, subsref.m, display.m, end.m, get.m, numel.m, plot.m, polynomial.m, polynomial_superiorto.m, polyval.m, roots.m, set.m, subsasgn.m, subsref.m, celldemo.cc, fortrandemo.cc, funcdemo.cc, globaldemo.cc, oct_demo.cc, paramdemo.cc, stringdemo.cc: Use newer coding conventions in examples/code directory.
author Rik <rik@octave.org>
date Wed, 13 Jan 2016 16:21:24 -0800
parents 25d676f9619c
children fd97ed44f2da
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)
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
15
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
16 if (nargin > 1)
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
17 print_usage ();
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
18 endif
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
19
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 if (nargin == 0)
9284
567e3e4ab74d fix up examples/@polynomial
Robert T. Short <octave@phaselockedsystems.com>
parents: 8664
diff changeset
21 p.poly = [0];
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 p = class (p, "polynomial");
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
23 else
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 if (strcmp (class (a), "polynomial"))
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 p = a;
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 elseif (isvector (a) && isreal (a))
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
27 p.poly = a(:).'; # force row vector
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 p = class (p, "polynomial");
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 else
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 19033
diff changeset
30 error ("@polynomial: expecting real vector");
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 endif
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 endif
21059
73ab962bc52d doc: Use newer coding conventions in examples/code directory.
Rik <rik@octave.org>
parents: 20726
diff changeset
33
8223
0c91b9a17dcf Commit missing files from previous change
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 endfunction