Mercurial > hg > octave-nkf

annotate scripts/polynomial/polyout.m @ 14138:72c96de7a403 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents 614505385171
children 4d917a6a858b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14104
diff changeset
1 ## Copyright (C) 1995-2012 Auburn University. All rights reserved.
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
2 ##
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
4 ##
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
9 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## General Public License for more details.
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
14 ##
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
18
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} polyout (@var{c})
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
21 ## @deftypefnx {Function File} {} polyout (@var{c}, @var{x})
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
22 ## @deftypefnx {Function File} {@var{str} =} polyout (@dots{})
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
23 ## Write formatted polynomial
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4898
diff changeset
24 ## @tex
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4898
diff changeset
25 ## $$ c(x) = c_1 x^n + \ldots + c_n x + c_{n+1} $$
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4898
diff changeset
26 ## @end tex
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 8286
diff changeset
27 ## @ifnottex
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
28 ##
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
29 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
30 ## c(x) = c(1) * x^n + @dots{} + c(n) x + c(n+1)
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
31 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
32 ##
8517
81d6ab3ac93c Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents: 8286
diff changeset
33 ## @end ifnottex
14104
614505385171 doc: Overhaul docstrings for polynomial functions.
Rik <octave@nomad.inbox5.com>
parents: 13963
diff changeset
34 ## and return it as a string or write it to the screen (if @var{nargout} is
614505385171 doc: Overhaul docstrings for polynomial functions.
Rik <octave@nomad.inbox5.com>
parents: 13963
diff changeset
35 ## zero). @var{x} defaults to the string @code{"s"}.
614505385171 doc: Overhaul docstrings for polynomial functions.
Rik <octave@nomad.inbox5.com>
parents: 13963
diff changeset
36 ## @seealso{polyreduce}
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5443
diff changeset
37 ## @end deftypefn
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
38
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
39 ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
40 ## Created: May 1995
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
41 ## Nov 1998: Correctly handles complex coefficients
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3424
diff changeset
42
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
43 function y = polyout (c, x)
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
44
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
45 if (nargin < 1) || (nargin > 2) || (nargout < 0) || (nargout > 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
46 print_usage ();
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
47 endif
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
48
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3457
diff changeset
49 if (! isvector (c))
8685
983ac67dc3d4 polyout.m: additional style fixes
John W. Eaton <jwe@octave.org>
parents: 8684
diff changeset
50 error ("polyout: first argument must be a vector");
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
51 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3424
diff changeset
52
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
53 if (nargin == 1)
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
54 x = "s";
8684
6d15bc6c4c15 polyout.m: Replace com2str with num2str.
Thomas D. Dean <tomdean@speakeasy.org>
parents: 8517
diff changeset
55 elseif (! ischar (x))
8685
983ac67dc3d4 polyout.m: additional style fixes
John W. Eaton <jwe@octave.org>
parents: 8684
diff changeset
56 error ("polyout: second argument must be a string");
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
57 endif
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
58
8684
6d15bc6c4c15 polyout.m: Replace com2str with num2str.
Thomas D. Dean <tomdean@speakeasy.org>
parents: 8517
diff changeset
59 n = length (c);
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
60 if(n > 0)
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
61 n1 = n+1;
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
62
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
63 tmp = coeff (c(1));
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
64 for ii = 2:n
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
65 if (real (c(ii)) < 0)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10224
diff changeset
66 ns = " - ";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10224
diff changeset
67 c(ii) = -c(ii);
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
68 else
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
69 ns = " + ";
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
70 endif
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
71
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
72 tmp = sprintf ("%s*%s^%d%s%s", tmp, x, n1-ii, ns, coeff (c(ii)));
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3424
diff changeset
73
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
74 endfor
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
75 else
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
76 tmp = " ";
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
77 endif
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
78
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
79 if(nargout == 0)
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
80 disp (tmp);
3424
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
81 else
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
82 y = tmp;
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
83 endif
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
84
61e40232a4e8 [project @ 2000-01-13 07:19:43 by jwe]
jwe
parents:
diff changeset
85 endfunction
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
86
8684
6d15bc6c4c15 polyout.m: Replace com2str with num2str.
Thomas D. Dean <tomdean@speakeasy.org>
parents: 8517
diff changeset
87 function str = coeff (c)
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
88 if (imag (c))
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
89 if (real (c))
8684
6d15bc6c4c15 polyout.m: Replace com2str with num2str.
Thomas D. Dean <tomdean@speakeasy.org>
parents: 8517
diff changeset
90 str = sprintf ("(%s)", num2str (c, 5));
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
91 else
8684
6d15bc6c4c15 polyout.m: Replace com2str with num2str.
Thomas D. Dean <tomdean@speakeasy.org>
parents: 8517
diff changeset
92 str = num2str (c, 5);
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
93 endif
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
94 else
8684
6d15bc6c4c15 polyout.m: Replace com2str with num2str.
Thomas D. Dean <tomdean@speakeasy.org>
parents: 8517
diff changeset
95 str = num2str (c, 5);
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4030
diff changeset
96 endif
8684
6d15bc6c4c15 polyout.m: Replace com2str with num2str.
Thomas D. Dean <tomdean@speakeasy.org>
parents: 8517
diff changeset
97 endfunction
12804
a44ec6d33cc9 codesprint: Wrote 5 tests for polyout.m
David Wells <drwells@vt.edu>
parents: 11589
diff changeset
98
a44ec6d33cc9 codesprint: Wrote 5 tests for polyout.m
David Wells <drwells@vt.edu>
parents: 11589
diff changeset
99 %!assert (polyout ([3 2 1]), '3*s^2 + 2*s^1 + 1')
a44ec6d33cc9 codesprint: Wrote 5 tests for polyout.m
David Wells <drwells@vt.edu>
parents: 11589
diff changeset
100 %!assert (polyout ([3 2 1], 'x'), '3*x^2 + 2*x^1 + 1')
a44ec6d33cc9 codesprint: Wrote 5 tests for polyout.m
David Wells <drwells@vt.edu>
parents: 11589
diff changeset
101 %!assert (polyout ([3 2 1], 'wxyz'), '3*wxyz^2 + 2*wxyz^1 + 1')
a44ec6d33cc9 codesprint: Wrote 5 tests for polyout.m
David Wells <drwells@vt.edu>
parents: 11589
diff changeset
102 %!assert (polyout ([5 4 3 2 1], '1'),'5*1^4 + 4*1^3 + 3*1^2 + 2*1^1 + 1')
a44ec6d33cc9 codesprint: Wrote 5 tests for polyout.m
David Wells <drwells@vt.edu>
parents: 11589
diff changeset
103 %!error polyout ([])