changeset 7096:81bed50b9feb

[project @ 2007-11-02 16:13:43 by jwe]
author jwe
date Fri, 02 Nov 2007 16:13:44 +0000
parents efd16513ff8f
children e8c94e473c68
files doc/interpreter/dynamic.txi doc/interpreter/emacs.txi doc/interpreter/sparse.txi liboctave/DASPK-opts.in scripts/ChangeLog scripts/optimization/glpk.m scripts/plot/bar.m scripts/plot/barh.m src/DLD-FUNCTIONS/balance.cc src/DLD-FUNCTIONS/rand.cc src/file-io.cc src/help.cc src/syscalls.cc
diffstat 13 files changed, 81 insertions(+), 102 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/dynamic.txi
+++ b/doc/interpreter/dynamic.txi
@@ -1364,11 +1364,11 @@
 @end example
 
 
-The example above uses @code{mxGetDimensions},
-@code{mxGetNumberOfElements}, @code{mxGetNumberOfDimensions}, to work with
-the dimensional parameters of multi-dimensional arrays.  The also exists
-the functions @code{mxGetM}, and @code{mxGetN} that probe the number of
-rows and columns in a matrix.
+The example above uses the functions @code{mxGetDimensions},
+@code{mxGetNumberOfElements}, and @code{mxGetNumberOfDimensions} to work
+with the dimensions of multi-dimensional arrays.  The functions
+@code{mxGetM}, and @code{mxGetN} are also available to find the number
+of rows and columns in a matrix.
 
 @node Character Strings in Mex-Files
 @subsection Character Strings in Mex-Files
@@ -1392,12 +1392,12 @@
 @end group
 @end example
 
-There are a couple of additional functions available in mex-files of
-interest in the treatment of strings.  These are @code{mxCreateString},
-@code{mxArrayToString} and @code{mxCreateCharMatrixFromStrings}.  A
-string in a mex-file is considered to be a vector rather than a
-matrix.  This is perhaps an arbitrary distinction as the data in the
-mxArray for the matrix is consecutive in any case.
+Other functions in the mex interface for handling character strings are
+@code{mxCreateString}, @code{mxArrayToString}, and
+@code{mxCreateCharMatrixFromStrings}.  In a mex-file, a character string
+is considered to be a vector rather than a matrix.  This is perhaps an
+arbitrary distinction as the data in the mxArray for the matrix is
+consecutive in any case.
 
 @node Cell Arrays with Mex-Files
 @subsection Cell Arrays with Mex-Files
--- a/doc/interpreter/emacs.txi
+++ b/doc/interpreter/emacs.txi
@@ -480,15 +480,8 @@
 @node Using the Emacs Info Reader for Octave
 @appendixsec Using the Emacs Info Reader for Octave
 
-You can also set up the Emacs Info reader for dealing with the results
-of Octave's @samp{help -i}.  For this, the package @file{gnuserv} needs
-to be installed, which unfortunately still does not come with GNU Emacs
-(it does with XEmacs).  It can be retrieved from any GNU Emacs Lisp Code
-Directory archive, e.g.@:
-@url{ftp://ftp.cis.ohio-state.edu/pub/gnu/emacs/elisp-archive},
-in the @file{packages} subdirectory.  A recent version of gnuserv is
-available from
-@url{http://www.meltin.net/hacks/emacs/src/gnuserv-3.12.2.tar.gz}.
+You may also use the Emacs Info reader with Octave's @code{doc} function.
+For this, the package @file{gnuserv} needs to be installed.
 
 If @file{gnuserv} is installed, add the lines
 @lisp
@@ -507,10 +500,6 @@
 that the Emacs variable @code{octave-help-files} is set correctly).  In
 this case, use @code{info_program ("info-emacs-octave-help")}.
 
-If you use Octave from within Emacs, these settings are best done in the
-@file{~/.emacs-octave} startup file (or the file pointed to by the Emacs
-variable @code{inferior-octave-startup-file}).
-
-@c Local Variables:
-@c TeX-command-default: "Texinfo"
-@c End:
+If you use Octave from within Emacs, it is best to add these settings to
+your @file{~/.emacs-octave} startup file (or the file pointed to by the
+Emacs variable @code{inferior-octave-startup-file}).
--- a/doc/interpreter/sparse.txi
+++ b/doc/interpreter/sparse.txi
@@ -792,8 +792,9 @@
 
 @item If the matrix is not square, or any of the previous solvers flags
 a singular or near singular matrix, find a minimum norm solution using
-CXSPARSE@footnote{CHOLMOD, UMFPACK and CXSPARSE are written by Tim Davis
-and are available at http://www.cise.ufl.edu/research/sparse/}.
+CXSPARSE@footnote{The CHOLMOD, UMFPACK and CXSPARSE packages were
+written by Tim Davis and are available at
+http://www.cise.ufl.edu/research/sparse/}.
 @end enumerate
 
 The band density is defined as the number of non-zero values in the matrix
@@ -1137,7 +1138,3 @@
 @end ifset
 @end ifset
 @end ifset
-
-@c Local Variables: ***
-@c Mode: texinfo ***
-@c End: ***
--- a/liboctave/DASPK-opts.in
+++ b/liboctave/DASPK-opts.in
@@ -133,7 +133,7 @@
 tried if the @code{\"compute consistent initial condition\"} option has
 been set to 1 (default is 5).
 
-Note that the maximum number of Newton iterations allowed in all is
+Note that the maximum total number of Newton iterations allowed is
 @code{MXNIT*MXNJ*MXNH} if the @code{\"compute consistent initial
 condition\"} option has been set to 1 and @code{MXNIT*MXNJ} if it is
 set to 2.
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,7 @@
+2007-11-02  Kai Habel  <kai.habel@gmx.de>
+
+	* plot/bar.m, plot/barh.m: Doc fix.
+
 2007-10-31  John W. Eaton  <jwe@octave.org>
 
 	* plot/__go_draw_axes__.m: Call undo_string_escapes on obj.keylabel.
--- a/scripts/optimization/glpk.m
+++ b/scripts/optimization/glpk.m
@@ -115,26 +115,25 @@
 ## following values
 ## @table @code
 ## @item "F"
-## Free (unbounded) variable (the constraint is ignored).
+## A free (unbounded) constraint (the constraint is ignored).
 ## @item "U"
-## Variable with upper bound (@code{A(i,:)*x <= b(i)}).
+## An inequality constraint with an upper bound (@code{A(i,:)*x <= b(i)}).
 ## @item "S"
-## Fixed Variable (@code{A(i,:)*x = b(i)}).
+## An equality constraint (@code{A(i,:)*x = b(i)}).
 ## @item "L"
-## Variable with lower bound (@code{A(i,:)*x >= b(i)}).
+## An inequality with a lower bound (@code{A(i,:)*x >= b(i)}).
 ## @item "D"
-## Double-bounded variable (@code{A(i,:)*x >= -b(i)} @emph{and}
-## (@code{A(i,:)*x <= b(i)}).
+## An inequality constraint with both upper and lower bounds
+## (@code{A(i,:)*x >= -b(i)} @emph{and} (@code{A(i,:)*x <= b(i)}).
 ## @end table
 ## 
 ## @item vartype
 ## A column array containing the types of the variables.
 ## @table @code
-## @item "F"
-## "C"
-## Continuous variable.
-## "I"
-## Integer variable
+## @item "C"
+## A continuous variable.
+## @item "I"
+## An integer variable.
 ## @end table
 ## 
 ## @item sense
--- a/scripts/plot/bar.m
+++ b/scripts/plot/bar.m
@@ -18,37 +18,29 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{h} =} bar (@var{x}, @var{y}, @var{p1}, @var{v1}, @dots{})
-## @deftypefnx {Function File} {[@var{xb}, @var{yb}] =} bar (@dots{})
-## Given two vectors of x-y data, @code{bar} produce a bar graph.
+## @deftypefn {Function File}  bar (@var{x}, @var{y})
+## @deftypefnx {Function File} bar (@var{y})
+## @deftypefnx {Function File} bar (@var{x}, @var{y}, @var{w})
+## @deftypefnx {Function File} bar (@var{x}, @var{y}, @var{w}, @var{style})
+## @deftypefnx {Function File} {@var{h} =} bar (...,@var{prop}, @var{val})
+## Produce a bar graph from two vectors of x-y data.
 ##
 ## If only one argument is given, it is taken as a vector of y-values
 ## and the x coordinates are taken to be the indices of the elements.
 ##
+## The default width of 0.8 for the bars can be changed using @var{w}. 
+##
 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a
 ## separate bar graph plotted on the same graph. By default the columns
 ## are plotted side-by-side. This behavior can be changed by the @var{style}
 ## argument, which can take the values @code{"grouped"} (the default),
 ## or @code{"stacked"}.
 ##
-## If two output arguments are specified, the data are generated but
-## not plotted.  For example,
-##
-## @example
-## bar (x, y);
-## @end example
+## The optional return value @var{h} provides a handle to the patch object.
+## Properties of the patch graphics object can be changed using 
+## @var{prop}, @var{val} pairs.
 ##
-## @noindent
-## and
-##
-## @example
-## [xb, yb] = bar (x, y);
-## plot (xb, yb);
-## @end example
-##
-## @noindent
-## are equivalent.
-## @seealso{hbar, plot}
+## @seealso{barh, plot}
 ## @end deftypefn
 
 ## Author: jwe
--- a/scripts/plot/barh.m
+++ b/scripts/plot/barh.m
@@ -17,36 +17,28 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{h} =} barh (@var{x}, @var{y}, @var{style})
-## @deftypefnx {Function File} {[@var{xb}, @var{yb}] =} barh (@dots{})
-## Given two vectors of x-y data, @code{bar} produce a horizontal bar graph.
+## @deftypefn {Function File}  barh (@var{x}, @var{y})
+## @deftypefnx {Function File} barh (@var{y})
+## @deftypefnx {Function File} barh (@var{x}, @var{y}, @var{w})
+## @deftypefnx {Function File} barh (@var{x}, @var{y}, @var{w}, @var{style})
+## @deftypefnx {Function File} {@var{h} =} barh (...,@var{prop}, @var{val})
+## Produce a horizontal bar graph from two vectors of x-y data.
 ##
 ## If only one argument is given, it is taken as a vector of y-values
 ## and the x coordinates are taken to be the indices of the elements.
 ##
+## The default width of 0.8 for the bars can be changed using @var{w}. 
+##
 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a
 ## separate bar graph plotted on the same graph. By default the columns
 ## are plotted side-by-side. This behavior can be changed by the @var{style}
 ## argument, which can take the values @code{"grouped"} (the default),
 ## or @code{"stacked"}.
 ##
-## If two output arguments are specified, the data are generated but
-## not plotted.  For example,
-##
-## @example
-## barh (x, y);
-## @end example
+## The optional return value @var{h} provides a handle to the patch object.
+## Properties of the patch graphics object can be changed using 
+## @var{prop}, @var{val} pairs.
 ##
-## @noindent
-## and
-##
-## @example
-## [xb, yb] = barh (x, y);
-## plot (xb, yb);
-## @end example
-##
-## @noindent
-## are equivalent.
 ## @seealso{bar, plot}
 ## @end deftypefn
 
--- a/src/DLD-FUNCTIONS/balance.cc
+++ b/src/DLD-FUNCTIONS/balance.cc
@@ -77,20 +77,20 @@
 @deftypefnx {Loadable Function} {[@var{dd}, @var{aa}] =} balance (@var{a}, @var{opt})\n\
 @deftypefnx {Loadable Function} {[@var{cc}, @var{dd}, @var{aa}, @var{bb}] =} balance (@var{a}, @var{b}, @var{opt})\n\
 \n\
-@code{[dd, aa] = balance (a)} returns @code{aa = dd \\ a * dd}.\n\
-@code{aa} is a matrix whose row and column norms are roughly equal in\n\
-magnitude, and @code{dd} = @code{p * d}, where @code{p} is a permutation\n\
+Compute @code{aa = dd \\ a * dd} in which @code{aa} is a matrix whose\n\
+row and column norms are roughly equal in magnitude, and\n\
+@code{dd} = @code{p * d}, in which @code{p} is a permutation\n\
 matrix and @code{d} is a diagonal matrix of powers of two.  This allows\n\
 the equilibration to be computed without roundoff.  Results of\n\
 eigenvalue calculation are typically improved by balancing first.\n\
 \n\
-@code{[cc, dd, aa, bb] = balance (a, b)} returns @code{aa = cc*a*dd} and\n\
-@code{bb = cc*b*dd)}, where @code{aa} and @code{bb} have non-zero\n\
+If four output values are requested, compute @code{aa = cc*a*dd} and\n\
+@code{bb = cc*b*dd)}, in which @code{aa} and @code{bb} have non-zero\n\
 elements of approximately the same magnitude and @code{cc} and @code{dd}\n\
 are permuted diagonal matrices as in @code{dd} for the algebraic\n\
 eigenvalue problem.\n\
 \n\
-The eigenvalue balancing option @code{opt} is selected as follows:\n\
+The eigenvalue balancing option @code{opt} may be one of:\n\
 \n\
 @table @asis\n\
 @item @code{\"N\"}, @code{\"n\"}\n\
--- a/src/DLD-FUNCTIONS/rand.cc
+++ b/src/DLD-FUNCTIONS/rand.cc
@@ -341,8 +341,9 @@
 available, otherwise from cpu time, wall clock time and the current\n\
 fraction of a second.\n\
 \n\
-@code{rand} uses the Mersenne Twister with a period of 2^19937-1\n\
-(See M. Matsumoto and T. Nishimura, ``Mersenne Twister: A 623-dimensionally\n\
+To compute the psuedo-random sequence, @code{rand} uses the Mersenne\n\
+Twister with a period of 2^19937-1 (See M. Matsumoto and T. Nishimura,\n\
+``Mersenne Twister: A 623-dimensionally\n\
 equidistributed uniform pseudorandom number generator'', ACM Trans. on\n\
 Modeling and Computer Simulation Vol. 8, No. 1, January pp.3-30 1998,\n\
 @url{http://www.math.keio.ac.jp/~matumoto/emt.html}).\n\
@@ -350,8 +351,8 @@
 several returned values together, otherwise the generator state\n\
 can be learned after reading 624 consecutive values.\n\
 \n\
-@code{rand} includes a second random number generator, that was the\n\
-previous generator used in Octave. The new generator is used by default\n\
+Older versions of Octave used a different random number generator.\n\
+The new generator is used by default\n\
 as it is significantly faster than the old generator, and produces\n\
 random numbers with a significantly longer cycle time. However, in\n\
 some circumstances it might be desirable to obtain the same random\n\
@@ -649,9 +650,13 @@
 @end example\n\
 @item @code{F (n1, n2)} for @code{0 < n1}, @code{0 < n2}\n\
 @example\n\
-r1 = 2 * randg (n1 / 2) / n1 ## r1 equals 1 if n1 is infinite\n\
-r2 = 2 * randg (n2 / 2) / n2 ## r2 equals 1 if n2 is infinite\n\
+@group\n\
+## r1 equals 1 if n1 is infinite\n\
+r1 = 2 * randg (n1 / 2) / n1\n\
+## r2 equals 1 if n2 is infinite\n\
+r2 = 2 * randg (n2 / 2) / n2\n\
 r = r1 / r2\n\n\
+@end group\n\
 @end example\n\
 @item negative @code{binomial (n, p)} for @code{n > 0}, @code{0 < p <= 1}\n\
 @example\n\
--- a/src/file-io.cc
+++ b/src/file-io.cc
@@ -1424,10 +1424,11 @@
 default, @code{fread} returns a double precision array.  The special\n\
 form @samp{*TYPE} is shorthand for @samp{TYPE=>TYPE}.\n\
 \n\
-The conversion and repeat counts may be combined.  For example,\n\
-@samp{32*single=>single} causes @code{fread} to read blocks of single\n\
-precision floating point values and return an array of single precision\n\
-values instead of the default array of double precision values.\n\
+The conversion and repeat counts may be combined.  For example, the\n\
+specification @samp{32*single=>single} causes @code{fread} to read\n\
+blocks of single precision floating point values and return an array\n\
+of single precision values instead of the default array of double\n\
+precision values.\n\
 \n\
 The optional argument @var{skip} specifies the number of bytes to skip\n\
 after each element (or block of elements) is read.  If it is not\n\
--- a/src/help.cc
+++ b/src/help.cc
@@ -2130,7 +2130,7 @@
 @deftypefn {Built-in Function} {@var{val} =} info_program ()\n\
 @deftypefnx {Built-in Function} {@var{old_val} =} info_program (@var{new_val})\n\
 Query or set the internal variable that specifies the name of the\n\
-info program to run.  The default initial value is\n\
+info program to run.  The default value is\n\
 @code{\"@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info\"}\n\
 in which @var{octave-home} is the directory where all of Octave is\n\
 installed, @var{version} is the Octave version number, and @var{arch}\n\
--- a/src/syscalls.cc
+++ b/src/syscalls.cc
@@ -1294,7 +1294,7 @@
 be less than zero and @var{msg} will contain a system-dependent error\n\
 message.  The value of @var{status} contains additional system-dependent\n\
 information about the subprocess that exited.\n\
-@seealso{WNOHANG, WUNTRACED, WCONTINUED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\
+@seealso{WCONTINUED, WCOREDUMP, WEXITSTATUS, WIFCONTINUED, WIFSIGNALED, WIFSTOPPED, WNOHANG, WSTOPSIG, WTERMSIG, WUNTRACED}\n\
 @end deftypefn")
 {
   octave_value_list retval;