changeset 8787:5b23faa8113c

Documentation fixes.
author Olaf Till <olaf.till@uni-jena.de>
date Wed, 18 Feb 2009 00:30:29 -0500
parents dbd428efbf56
children d0bc587fce55
files src/ChangeLog src/DLD-FUNCTIONS/daspk.cc src/DLD-FUNCTIONS/dasrt.cc src/DLD-FUNCTIONS/dassl.cc src/DLD-FUNCTIONS/lsode.cc
diffstat 5 files changed, 34 insertions(+), 28 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2009-02-17  Olaf Till  <olaf.till@uni-jena.de>
+
+	* DLD-FUNCTIONS/lsode.cc, DLD-FUNCTIONS/daspk.cc, 
+	DLD-FUNCTIONS/dassl.cc, DLD-FUNCTIONS/dasrt.cc: Documentation fixes.
+
 2009-02-17  Kai Habel  <kai.habel@gmx.de>
 
 	* DLD-FUNCTIONS/convhulln.cc (Fconvhulln): Compute convex hull
--- a/src/DLD-FUNCTIONS/daspk.cc
+++ b/src/DLD-FUNCTIONS/daspk.cc
@@ -206,10 +206,9 @@
 row of the output @var{x} is @var{x_0} and the first row\n\
 of the output @var{xdot} is @var{xdot_0}.\n\
 \n\
-The first argument, @var{fcn}, is a string or a two element cell array\n\
-of strings, inline or function handle, that names the function, to call\n\
-to compute the vector of residuals for the set of equations. It must\n\
-have the form\n\
+The first argument, @var{fcn}, is a string, inline, or function handle\n\
+that names the function @math{f} to call to compute the vector of\n\
+residuals for the set of equations.  It must have the form\n\
 \n\
 @example\n\
 @var{res} = f (@var{x}, @var{xdot}, @var{t})\n\
@@ -219,9 +218,10 @@
 in which @var{x}, @var{xdot}, and @var{res} are vectors, and @var{t} is a\n\
 scalar.\n\
 \n\
-If @var{fcn} is a two-element string array, the first element names\n\
-the function @math{f} described above, and the second element names\n\
-a function to compute the modified Jacobian\n\
+If @var{fcn} is a two-element string array or a two-element cell array\n\
+of strings, inlines, or function handles, the first element names\n\
+the function @math{f} described above, and the second element names a\n\
+function to compute the modified Jacobian\n\
 @tex\n\
 $$\n\
 J = {\\partial f \\over \\partial x}\n\
--- a/src/DLD-FUNCTIONS/dasrt.cc
+++ b/src/DLD-FUNCTIONS/dasrt.cc
@@ -249,9 +249,9 @@
 @var{t_out} will be the point at which the stopping condition was met,\n\
 and may not correspond to any element of the vector @var{t}.\n\
 \n\
-The first argument, @var{fcn}, is a string, or cell array of strings or\n\
-inline or function handles, that names the function to call to compute\n\
-the vector of residuals for the set of equations. It must have the form\n\
+The first argument, @var{fcn}, is a string, inline, or function handle\n\
+that names the function @math{f} to call to compute the vector of\n\
+residuals for the set of equations.  It must have the form\n\
 \n\
 @example\n\
 @var{res} = f (@var{x}, @var{xdot}, @var{t})\n\
@@ -261,9 +261,10 @@
 in which @var{x}, @var{xdot}, and @var{res} are vectors, and @var{t} is a\n\
 scalar.\n\
 \n\
-If @var{fcn} is a two-element string array, or two element cell array,\n\
-the first element names the function @math{f} described above, and the\n\
-second element names a function to compute the modified Jacobian\n\
+If @var{fcn} is a two-element string array or a two-element cell array\n\
+of strings, inlines, or function handles, the first element names\n\
+the function @math{f} described above, and the second element names a\n\
+function to compute the modified Jacobian\n\
 \n\
 @tex\n\
 $$\n\
--- a/src/DLD-FUNCTIONS/dassl.cc
+++ b/src/DLD-FUNCTIONS/dassl.cc
@@ -209,10 +209,9 @@
 row of the output @var{x} is @var{x_0} and the first row\n\
 of the output @var{xdot} is @var{xdot_0}.\n\
 \n\
-The first argument, @var{fcn}, is a string or a two element cell array\n\
-of strings, inline or function handle, that names the function, to call\n\
-to compute the vector of residuals for the set of equations. It must\n\
-have the form\n\
+The first argument, @var{fcn}, is a string, inline, or function handle\n\
+that names the function @math{f} to call to compute the vector of\n\
+residuals for the set of equations.  It must have the form\n\
 \n\
 @example\n\
 @var{res} = f (@var{x}, @var{xdot}, @var{t})\n\
@@ -222,9 +221,10 @@
 in which @var{x}, @var{xdot}, and @var{res} are vectors, and @var{t} is a\n\
 scalar.\n\
 \n\
-If @var{fcn} is a two-element string array, the first element names\n\
-the function @math{f} described above, and the second element names\n\
-a function to compute the modified Jacobian\n\
+If @var{fcn} is a two-element string array or a two-element cell array\n\
+of strings, inlines, or function handles, the first element names\n\
+the function @math{f} described above, and the second element names a\n\
+function to compute the modified Jacobian\n\
 \n\
 @iftex\n\
 @tex\n\
--- a/src/DLD-FUNCTIONS/lsode.cc
+++ b/src/DLD-FUNCTIONS/lsode.cc
@@ -192,10 +192,9 @@
 state of the system @var{x_0}, so that the first row of the output\n\
 is @var{x_0}.\n\
 \n\
-The first argument, @var{fcn}, is a string, or cell array of strings,\n\
-inline or function handles, that names the function to call to compute\n\
-the vector of right hand sides for the set of equations. The function\n\
-must have the form\n\
+The first argument, @var{fcn}, is a string, inline, or function handle\n\
+that names the function @math{f} to call to compute the vector of right\n\
+hand sides for the set of equations.  The function must have the form\n\
 \n\
 @example\n\
 @var{xdot} = f (@var{x}, @var{t})\n\
@@ -204,10 +203,11 @@
 @noindent\n\
 in which @var{xdot} and @var{x} are vectors and @var{t} is a scalar.\n\
 \n\
-If @var{fcn} is a two-element string array, the first element names the\n\
-function @math{f} described above, and the second element names a function\n\
-to compute the Jacobian of @math{f}.  The Jacobian function must have the\n\
-form\n\
+If @var{fcn} is a two-element string array or a two-element cell array\n\
+of strings, inlines, or function handles, the first element names\n\
+the function @math{f} described above, and the second element names a\n\
+function to compute the Jacobian of @math{f}.  The Jacobian function\n\
+must have the form\n\
 \n\
 @example\n\
 @var{jac} = j (@var{x}, @var{t})\n\