octave-nkf: scripts/polynomial/polyaffine.m annotate

annotate scripts/polynomial/polyaffine.m @ 14327:4d917a6a858b stable

doc: Use Octave coding conventions in @example blocks of docstrings. * accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m, celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m, contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m, dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m, ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m, flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m, idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m, isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m, logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m, moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m, polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m, randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m, shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m, strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m, subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m, voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in @example blocks of docstrings.

author	Rik <octave@nomad.inbox5.com>
date	Sat, 04 Feb 2012 22:12:50 -0800
parents	72c96de7a403
children	ce2b59a6d0e5

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 14104 diff changeset	1 ## Copyright (C) 2009-2012 Tony Richardson, Jaroslav Hajek
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	2 ##
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	3 ## This file is part of Octave.
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	4 ##
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	6 ## under the terms of the GNU General Public License as published by
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	8 ## your option) any later version.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	9 ##
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	13 ## General Public License for more details.
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	14 ##
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10821 diff changeset	17 ## <http://www.gnu.org/licenses/>.
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	18
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	19 ## -- texinfo --
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	20 ## @deftypefn {Function File} {} polyaffine (@var{f}, @var{mu})
11538 6eded7561d9d Add undocumented polyaffine function to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	21 ## Return the coefficients of the polynomial vector @var{f} after an affine
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11538 diff changeset	22 ## transformation. If @var{f} is the vector representing the polynomial f(x),
11538 6eded7561d9d Add undocumented polyaffine function to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	23 ## then @code{@var{g} = polyaffine (@var{f}, @var{mu})} is the vector
6eded7561d9d Add undocumented polyaffine function to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	24 ## representing:
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9758 diff changeset	25 ##
9116 a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	26 ## @example
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	27 ## g(x) = f( (x - @var{mu}(1)) / @var{mu}(2) )
9116 a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	28 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	29 ##
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	30 ## @seealso{polyval, polyfit}
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	31 ## @end deftypefn
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	32
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	33
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	34 function g = polyaffine (f, mu)
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	35
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	36 if (nargin != 2)
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	37 print_usage ();
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	38 endif
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	39
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	40 if (! isvector (f))
11588 d5bd2766c640 style fixes for warning and error messages in script files John W. Eaton <jwe@octave.org> parents: 11587 diff changeset	41 error ("polyaffine: F must be a vector");
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	42 endif
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	43
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	44 if (! isvector (mu) \|\| length (mu) != 2)
11588 d5bd2766c640 style fixes for warning and error messages in script files John W. Eaton <jwe@octave.org> parents: 11587 diff changeset	45 error ("polyaffine: MU must be a two-element vector");
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	46 endif
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	47
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	48 lf = length (f);
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	49
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	50 ## Ensure that f is a row vector
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	51 if (rows (f) > 1)
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	52 f = f.';
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	53 endif
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	54
9116 a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	55 g = f;
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	56
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	57 ## Scale.
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	58 if (mu(2) != 1)
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	59 g = g ./ (mu(2) .^ (lf-1:-1:0));
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	60 endif
79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	61
9116 a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	62 ## Translate.
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	63 if (mu(1) != 0)
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	64 w = (-mu(1)) .^ (0:lf-1);
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	65 ii = lf:-1:1;
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	66 g = g(ii) * (toeplitz (w) .* pascal (lf, -1));
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	67 g = g(ii);
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	68 endif
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	69
9114 79e90381b402 merge polytrans & polyscale -> polyaffine, make compatible with polyval Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	70 endfunction
9116 a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	71
11538 6eded7561d9d Add undocumented polyaffine function to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	72
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	73 %!demo
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	74 %! f = [1/5 4/5 -7/5 -2];
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	75 %! g = polyaffine (f, [1, 1.2]);
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	76 %! x = linspace (-4, 4, 100);
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	77 %! plot(x, polyval (f, x), x, polyval (g, x));
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	78 %! legend ("original", "affine");
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	79 %! axis ([-4 4 -3 5]);
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	80 %! grid ("on");
614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	81
9116 a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	82 %!test
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	83 %! f = [1/5 4/5 -7/5 -2];
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	84 %! mu = [1, 1.2];
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	85 %! g = polyaffine (f, mu);
a8be2f7c81ee improve docs for polyaffine, fix bugs Jaroslav Hajek <highegg@gmail.com> parents: 9114 diff changeset	86 %! x = linspace (-4, 4, 100);
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 11588 diff changeset	87 %! assert (polyval (f, x, [], mu), polyval (g, x), 1e-10);
11538 6eded7561d9d Add undocumented polyaffine function to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	88

Mercurial > hg > octave-nkf

annotate scripts/polynomial/polyaffine.m @ 14327:4d917a6a858b stable