annotate scripts/polynomial/polyout.m @ 14868:5d3a684236b0

maint: Use Octave coding conventions for cuddling parentheses in scripts directory * lin2mu.m, loadaudio.m, wavread.m, accumarray.m, bicubic.m, celldisp.m, colon.m, cplxpair.m, dblquad.m, divergence.m, genvarname.m, gradient.m, int2str.m, interp1.m, interp1q.m, interp2.m, interpn.m, loadobj.m, nthargout.m, __isequal__.m, __splinen__.m, quadgk.m, quadl.m, quadv.m, rat.m, rot90.m, rotdim.m, saveobj.m, subsindex.m, triplequad.m, delaunay3.m, griddata.m, inpolygon.m, tsearchn.m, voronoi.m, get_first_help_sentence.m, which.m, gray2ind.m, pink.m, dlmwrite.m, strread.m, textread.m, textscan.m, housh.m, ishermitian.m, issymmetric.m, krylov.m, logm.m, null.m, rref.m, compare_versions.m, copyfile.m, dump_prefs.m, edit.m, fileparts.m, getappdata.m, isappdata.m, movefile.m, orderfields.m, parseparams.m, __xzip__.m, rmappdata.m, setappdata.m, swapbytes.m, unpack.m, ver.m, fminbnd.m, fminunc.m, fsolve.m, glpk.m, lsqnonneg.m, qp.m, sqp.m, configure_make.m, copy_files.m, describe.m, get_description.m, get_forge_pkg.m, install.m, installed_packages.m, is_architecture_dependent.m, load_package_dirs.m, print_package_description.m, rebuild.m, repackage.m, save_order.m, shell.m, allchild.m, ancestor.m, area.m, axes.m, axis.m, clabel.m, close.m, colorbar.m, comet.m, comet3.m, contour.m, cylinder.m, ezmesh.m, ezsurf.m, findobj.m, fplot.m, hist.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m, mesh.m, meshz.m, pareto.m, pcolor.m, peaks.m, plot3.m, plotmatrix.m, plotyy.m, polar.m, print.m, __add_datasource__.m, __add_default_menu__.m, __axes_limits__.m, __bar__.m, __clabel__.m, __contour__.m, __errcomm__.m, __errplot__.m, __ezplot__.m, __file_filter__.m, __fltk_print__.m, __ghostscript__.m, __gnuplot_print__.m, __go_draw_axes__.m, __go_draw_figure__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m, __pie__.m, __plt__.m, __print_parse_opts__.m, __quiver__.m, __scatter__.m, __stem__.m, __tight_eps_bbox__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m, __uiputfile_fltk__.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m, ribbon.m, scatter.m, semilogy.m, shading.m, slice.m, subplot.m, surface.m, surfl.m, surfnorm.m, text.m, uigetfile.m, uiputfile.m, whitebg.m, deconv.m, mkpp.m, pchip.m, polyaffine.m, polyder.m, polygcd.m, polyout.m, polyval.m, ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, splinefit.m, addpref.m, getpref.m, setpref.m, ismember.m, setxor.m, arch_fit.m, arch_rnd.m, arch_test.m, autoreg_matrix.m, diffpara.m, fftconv.m, filter2.m, hanning.m, hurst.m, periodogram.m, triangle_sw.m, sinc.m, spectral_xdf.m, spencer.m, stft.m, synthesis.m, unwrap.m, yulewalker.m, bicgstab.m, gmres.m, pcg.m, pcr.m, __sprand_impl__.m, speye.m, spfun.m, sprandn.m, spstats.m, svds.m, treelayout.m, treeplot.m, bessel.m, factor.m, legendre.m, perms.m, primes.m, magic.m, toeplitz.m, corr.m, cov.m, mean.m, median.m, mode.m, qqplot.m, quantile.m, ranks.m, zscore.m, logistic_regression_likelihood.m, bartlett_test.m, chisquare_test_homogeneity.m, chisquare_test_independence.m, kolmogorov_smirnov_test.m, run_test.m, u_test.m, wilcoxon_test.m, z_test.m, z_test_2.m, bin2dec.m, dec2base.m, mat2str.m, strcat.m, strchr.m, strjust.m, strtok.m, substr.m, untabify.m, assert.m, demo.m, example.m, fail.m, speed.m, test.m, now.m: Use Octave coding conventions for cuddling parentheses in scripts directory.
author Rik <octave@nomad.inbox5.com>
date Tue, 17 Jul 2012 07:08:39 -0700
parents f3d52523cde1
children bc924baa2c4e
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
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
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
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
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
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
99
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
100 %!assert (polyout ([3 2 1]), "3*s^2 + 2*s^1 + 1")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
101 %!assert (polyout ([3 2 1], "x"), "3*x^2 + 2*x^1 + 1")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
102 %!assert (polyout ([3 2 1], "wxyz"), "3*wxyz^2 + 2*wxyz^1 + 1")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
103 %!assert (polyout ([5 4 3 2 1], "1"),"5*1^4 + 4*1^3 + 3*1^2 + 2*1^1 + 1")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
104
12804
a44ec6d33cc9 codesprint: Wrote 5 tests for polyout.m
David Wells <drwells@vt.edu>
parents: 11589
diff changeset
105 %!error polyout ([])
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
106