changeset 11538:6eded7561d9d

Add undocumented polyaffine function to documentation.
author Rik <octave@nomad.inbox5.com>
date Fri, 14 Jan 2011 16:58:44 -0800
parents a4b0e292107f
children 6bac61388876
files doc/ChangeLog doc/interpreter/octave.texi doc/interpreter/poly.txi scripts/ChangeLog scripts/polynomial/polyaffine.m
diffstat 5 files changed, 21 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Fri Jan 14 16:24:07 2011 -0800
+++ b/doc/ChangeLog	Fri Jan 14 16:58:44 2011 -0800
@@ -1,3 +1,8 @@
+2011-01-14  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/octave.texi, interpreter/poly.txi: Add undocumented 
+	polyaffine to documentation.
+
 2011-01-14  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/container.txi: Add undocumented nfields to documentation.
--- a/doc/interpreter/octave.texi	Fri Jan 14 16:24:07 2011 -0800
+++ b/doc/interpreter/octave.texi	Fri Jan 14 16:58:44 2011 -0800
@@ -670,7 +670,7 @@
 * Evaluating Polynomials::
 * Finding Roots::
 * Products of Polynomials::
-* Derivatives and Integrals::
+* Derivatives / Integrals / Transforms::
 * Polynomial Interpolation::
 * Miscellaneous Functions::
 
--- a/doc/interpreter/poly.txi	Fri Jan 14 16:24:07 2011 -0800
+++ b/doc/interpreter/poly.txi	Fri Jan 14 16:58:44 2011 -0800
@@ -41,7 +41,7 @@
 * Evaluating Polynomials::
 * Finding Roots::
 * Products of Polynomials::
-* Derivatives and Integrals::
+* Derivatives / Integrals / Transforms::
 * Polynomial Interpolation::
 * Miscellaneous Functions::
 @end menu
@@ -103,8 +103,8 @@
 
 @DOCSTRING(residue)
 
-@node Derivatives and Integrals
-@section Derivatives and Integrals
+@node Derivatives / Integrals / Transforms
+@section Derivatives / Integrals / Transforms
 
 Octave comes with functions for computing the derivative and the integral
 of a polynomial.  The functions @code{polyderiv} and @code{polyint}
@@ -126,6 +126,8 @@
 
 @DOCSTRING(polyint)
 
+@DOCSTRING(polyaffine)
+
 @node Polynomial Interpolation
 @section Polynomial Interpolation
 
--- a/scripts/ChangeLog	Fri Jan 14 16:24:07 2011 -0800
+++ b/scripts/ChangeLog	Fri Jan 14 16:58:44 2011 -0800
@@ -1,3 +1,7 @@
+2011-01-14  Rik  <octave@nomad.inbox5.com>
+
+	* ploynomial/polyaffine.m: Improve docstring.
+
 2011-01-14  Rik  <octave@nomad.inbox5.com>
 
 	* general/interp1.m, general/interp2.m, polynomial/mkpp.m,
--- a/scripts/polynomial/polyaffine.m	Fri Jan 14 16:24:07 2011 -0800
+++ b/scripts/polynomial/polyaffine.m	Fri Jan 14 16:58:44 2011 -0800
@@ -18,10 +18,10 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} polyaffine (@var{f}, @var{mu})
-## Return the coefficients of the polynomial whose coefficients are given by
-## vector @var{f} after an affine tranformation.  If @var{f} is the vector
-## representing the polynomial f(x), then @code{@var{g} = polyaffine (@var{f},
-## @var{mu})} is the vector representing 
+## Return the coefficients of the polynomial vector @var{f} after an affine
+## tranformation.  If @var{f} is the vector representing the polynomial f(x),
+## then @code{@var{g} = polyaffine (@var{f}, @var{mu})} is the vector
+## representing:
 ##
 ## @example
 ## g(x) = f((x-@var{mu}(1))/@var{mu}(2)).
@@ -69,6 +69,7 @@
 
 endfunction
 
+
 %!test
 %! f = [1/5 4/5 -7/5 -2];
 %!
@@ -79,7 +80,7 @@
 %! x = linspace (-4, 4, 100);
 %!
 %! assert (polyval(f, x, [], mu), polyval (g, x), 1e-10);
-%!
+
 %!demo
 %! f = [1/5 4/5 -7/5 -2];
 %!