Mercurial > octave-nkf
changeset 10840:89f4d7e294cc
Grammarcheck .cc files
line wrap: on
line diff
--- a/liboctave/ChangeLog Fri Jul 30 18:59:31 2010 -0400 +++ b/liboctave/ChangeLog Sat Jul 31 11:18:11 2010 -0700 @@ -1,3 +1,8 @@ +2010-07-31 Rik <octave@nomad.inbox5.com> + + * DASPK-opts.in, DASRT-opts.in, DASSL-opts.in, LSODE-opts.in, + Quad-opts.in: Grammarcheck .cc files + 2010-07-29 Jaroslav Hajek <highegg@gmail.com> * dim-vector.cc (dim_vector::dim_max (void)): Turn it into a function.
--- a/liboctave/DASPK-opts.in Fri Jul 30 18:59:31 2010 -0400 +++ b/liboctave/DASPK-opts.in Sat Jul 31 11:18:11 2010 -0700 @@ -26,6 +26,7 @@ Absolute tolerance. May be either vector or scalar. If a vector, it must match the dimension of the state vector, and the relative tolerance must also be a vector of the same length. + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -61,6 +62,7 @@ <= rtol(i) * abs (Y(i)) + atol(i) @end group @end example + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -90,6 +92,7 @@ @enumerate @item Given Y_d, calculate Y_a and Y'_d + @item Given Y', calculate Y. @end enumerate @@ -102,6 +105,7 @@ If this option is set to a nonzero value, you must also set the @code{\"algebraic variables\"} option to declare which variables in the problem are algebraic. + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "0" @@ -113,6 +117,7 @@ DOC_ITEM Set to a nonzero value to use the initial condition heuristics options described below. + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "0" @@ -128,8 +133,10 @@ @table @code @item MXNIT Maximum number of Newton iterations (default is 5). + @item MXNJ Maximum number of Jacobian evaluations (default is 6). + @item MXNH Maximum number of values of the artificial stepsize parameter to be tried if the @code{\"compute consistent initial condition\"} option has @@ -139,11 +146,14 @@ @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. + @item LSOFF Set to a nonzero value to disable the linesearch algorithm (default is 0). + @item STPTOL Minimum scaled step in linesearch algorithm (default is eps^(2/3)). + @item EPINIT Swing factor in the Newton iteration convergence test. The test is applied to the residual vector, premultiplied by the approximate @@ -152,6 +162,7 @@ where @code{EPCON} = 0.33 is the analogous test constant used in the time steps. The default is @code{EPINIT} = 0.01. @end table + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -172,6 +183,7 @@ DOC_ITEM Set this option to a nonzero value to display detailed information about the initial condition calculation (default is 0). + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "0" @@ -184,6 +196,7 @@ Set to a nonzero value to exclude algebraic variables from the error test. You must also set the @code{\"algebraic variables\"} option to declare which variables in the problem are algebraic (default is 0). + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "0" @@ -201,6 +214,7 @@ This option is required by the @code{compute consistent initial condition\"} and @code{\"exclude algebraic variables from error test\"} options. + END_DOC_ITEM TYPE = "Array<octave_idx_type>" SET_ARG_TYPE = const $TYPE& @@ -230,9 +244,12 @@ @enumerate @item To have constraint checking only in the initial condition calculation. + @item To enforce constraint checking during the integration. + @item To enforce both options 1 and 2. @end enumerate + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "0" @@ -250,18 +267,23 @@ @table @asis @item -2 Less than zero. + @item -1 Less than or equal to zero. + @item 0 Not constrained. + @item 1 Greater than or equal to zero. + @item 2 Greater than zero. @end table This option only has an effect if the @code{\"enforce inequality constraints\"} option is nonzero. + END_DOC_ITEM TYPE = "Array<octave_idx_type>" SET_ARG_TYPE = const $TYPE& @@ -290,6 +312,7 @@ about the scaling of your problem, you can help to alleviate this problem by specifying an initial stepsize (default is computed automatically). + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" @@ -301,6 +324,7 @@ DOC_ITEM Restrict the maximum order of the solution method. This option must be between 1 and 5, inclusive (default is 5). + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "5"
--- a/liboctave/DASRT-opts.in Fri Jul 30 18:59:31 2010 -0400 +++ b/liboctave/DASRT-opts.in Sat Jul 31 11:18:11 2010 -0700 @@ -26,6 +26,7 @@ Absolute tolerance. May be either vector or scalar. If a vector, it must match the dimension of the state vector, and the relative tolerance must also be a vector of the same length. + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -54,12 +55,14 @@ tolerance must also be a vector of the same length. The local error test applied at each integration step is + @example @group abs (local error in x(i)) <= ... rtol(i) * abs (Y(i)) + atol(i) @end group @end example + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -87,6 +90,7 @@ scaling difficulties on the first step. If you know a great deal about the scaling of your problem, you can help to alleviate this problem by specifying an initial stepsize. + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" @@ -98,6 +102,7 @@ DOC_ITEM Restrict the maximum order of the solution method. This option must be between 1 and 5, inclusive. + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "-1" @@ -109,6 +114,7 @@ DOC_ITEM Setting the maximum stepsize will avoid passing over very large regions. + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0"
--- a/liboctave/DASSL-opts.in Fri Jul 30 18:59:31 2010 -0400 +++ b/liboctave/DASSL-opts.in Sat Jul 31 11:18:11 2010 -0700 @@ -26,6 +26,7 @@ Absolute tolerance. May be either vector or scalar. If a vector, it must match the dimension of the state vector, and the relative tolerance must also be a vector of the same length. + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -61,6 +62,7 @@ <= rtol(i) * abs (Y(i)) + atol(i) @end group @end example + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -87,6 +89,7 @@ If nonzero, @code{dassl} will attempt to compute a consistent set of initial conditions. This is generally not reliable, so it is best to provide a consistent set and leave this option set to zero. + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "0" @@ -101,6 +104,7 @@ value. However, it is probably best to try leaving this option set to zero first, and only setting it to a nonzero value if that doesn't work very well. + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "0" @@ -114,6 +118,7 @@ scaling difficulties on the first step. If you know a great deal about the scaling of your problem, you can help to alleviate this problem by specifying an initial stepsize. + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" @@ -125,6 +130,7 @@ DOC_ITEM Restrict the maximum order of the solution method. This option must be between 1 and 5, inclusive. + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "-1" @@ -136,6 +142,7 @@ DOC_ITEM Setting the maximum stepsize will avoid passing over very large regions (default is not specified). + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0"
--- a/liboctave/LSODE-opts.in Fri Jul 30 18:59:31 2010 -0400 +++ b/liboctave/LSODE-opts.in Sat Jul 31 11:18:11 2010 -0700 @@ -25,6 +25,7 @@ DOC_ITEM Absolute tolerance. May be either vector or scalar. If a vector, it must match the dimension of the state vector. + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" @@ -59,6 +60,7 @@ rtol * abs (y(i)) + atol(i) @end group @end example + END_DOC_ITEM TYPE = "double" INIT_VALUE = "::sqrt (DBL_EPSILON)" @@ -75,12 +77,14 @@ @item \"adams\" @itemx \"non-stiff\" No Jacobian used (even if it is available). + @item \"bdf\" -@item \"stiff\" +@itemx \"stiff\" Use stiff backward differentiation formula (BDF) method. If a function to compute the Jacobian is not supplied, @code{lsode} will compute a finite difference approximation of the Jacobian matrix. @end table + END_DOC_ITEM TYPE = "std::string" SET_ARG_TYPE = "const $TYPE&" @@ -101,6 +105,7 @@ DOC_ITEM The step size to be attempted on the first step (default is determined automatically). + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" @@ -113,6 +118,7 @@ Restrict the maximum order of the solution method. If using the Adams method, this option must be between 1 and 12. Otherwise, it must be between 1 and 5, inclusive. + END_DOC_ITEM TYPE = "octave_idx_type" INIT_VALUE = "-1" @@ -124,6 +130,7 @@ DOC_ITEM Setting the maximum stepsize will avoid passing over very large regions (default is not specified). + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" @@ -134,6 +141,7 @@ NAME = "minimum step size" DOC_ITEM The minimum absolute step size allowed (default is 0). + END_DOC_ITEM TYPE = "double" INIT_VALUE = "0.0"
--- a/liboctave/Quad-opts.in Fri Jul 30 18:59:31 2010 -0400 +++ b/liboctave/Quad-opts.in Sat Jul 31 11:18:11 2010 -0700 @@ -22,6 +22,7 @@ NAME = "absolute tolerance" DOC_ITEM Absolute tolerance; may be zero for pure relative error test. + END_DOC_ITEM TYPE = "double" INIT_VALUE = "::sqrt (DBL_EPSILON)" @@ -31,9 +32,10 @@ OPTION NAME = "relative tolerance" DOC_ITEM -Nonnegative relative tolerance. If the absolute tolerance is zero, +Non-negative relative tolerance. If the absolute tolerance is zero, the relative tolerance must be greater than or equal to @code{max (50*eps, 0.5e-28)}. + END_DOC_ITEM TYPE = "double" INIT_VALUE = "::sqrt (DBL_EPSILON)" @@ -45,6 +47,7 @@ DOC_ITEM Absolute tolerance for single precision; may be zero for pure relative error test. + END_DOC_ITEM TYPE = "float" INIT_VALUE = "::sqrt (FLT_EPSILON)" @@ -54,7 +57,7 @@ OPTION NAME = "single precision relative tolerance" DOC_ITEM -Nonnegative relative tolerance for single precision. If the absolute +Non-negative relative tolerance for single precision. If the absolute tolerance is zero, the relative tolerance must be greater than or equal to @code{max (50*eps, 0.5e-28)}. END_DOC_ITEM
--- a/src/ChangeLog Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ChangeLog Sat Jul 31 11:18:11 2010 -0700 @@ -1,3 +1,37 @@ +2010-07-31 Rik <octave@nomad.inbox5.com> + + * DLD-FUNCTIONS/__magick_read__.cc, DLD-FUNCTIONS/__voronoi__.cc, + DLD-FUNCTIONS/amd.cc, DLD-FUNCTIONS/balance.cc, + DLD-FUNCTIONS/besselj.cc, DLD-FUNCTIONS/betainc.cc, + DLD-FUNCTIONS/ccolamd.cc, DLD-FUNCTIONS/cellfun.cc, + DLD-FUNCTIONS/chol.cc, DLD-FUNCTIONS/colamd.cc, DLD-FUNCTIONS/conv2.cc, + DLD-FUNCTIONS/convhulln.cc, DLD-FUNCTIONS/daspk.cc, + DLD-FUNCTIONS/dasrt.cc, DLD-FUNCTIONS/dassl.cc, + DLD-FUNCTIONS/dmperm.cc, DLD-FUNCTIONS/dot.cc, DLD-FUNCTIONS/eigs.cc, + DLD-FUNCTIONS/fftn.cc, DLD-FUNCTIONS/fftw.cc, DLD-FUNCTIONS/filter.cc, + DLD-FUNCTIONS/find.cc, DLD-FUNCTIONS/gammainc.cc, DLD-FUNCTIONS/gcd.cc, + DLD-FUNCTIONS/getrusage.cc, DLD-FUNCTIONS/givens.cc, + DLD-FUNCTIONS/hess.cc, DLD-FUNCTIONS/hex2num.cc, DLD-FUNCTIONS/inv.cc, + DLD-FUNCTIONS/kron.cc, DLD-FUNCTIONS/lookup.cc, DLD-FUNCTIONS/lsode.cc, + DLD-FUNCTIONS/lu.cc, DLD-FUNCTIONS/luinc.cc, + DLD-FUNCTIONS/matrix_type.cc, DLD-FUNCTIONS/max.cc, + DLD-FUNCTIONS/md5sum.cc, DLD-FUNCTIONS/onCleanup.cc, + DLD-FUNCTIONS/qr.cc, DLD-FUNCTIONS/quad.cc, DLD-FUNCTIONS/qz.cc, + DLD-FUNCTIONS/rand.cc, DLD-FUNCTIONS/regexp.cc, DLD-FUNCTIONS/schur.cc, + DLD-FUNCTIONS/sparse.cc, DLD-FUNCTIONS/spparms.cc, + DLD-FUNCTIONS/str2double.cc, DLD-FUNCTIONS/strfind.cc, + DLD-FUNCTIONS/sub2ind.cc, DLD-FUNCTIONS/svd.cc, DLD-FUNCTIONS/syl.cc, + DLD-FUNCTIONS/symbfact.cc, DLD-FUNCTIONS/time.cc, + DLD-FUNCTIONS/tril.cc, DLD-FUNCTIONS/typecast.cc, + DLD-FUNCTIONS/urlwrite.cc, bitfcns.cc, data.cc, debug.cc, defaults.cc, + dirfns.cc, error.cc, file-io.cc, graphics.cc, help.cc, input.cc, + load-path.cc, load-save.cc, ls-oct-ascii.cc, mappers.cc, oct-hist.cc, + octave.cc, ov-base.cc, ov-cell.cc, ov-class.cc, ov-fcn-handle.cc, + ov-fcn-inline.cc, ov-null-mat.cc, ov-range.cc, ov-struct.cc, + ov-usr-fcn.cc, pager.cc, pr-output.cc, pt-eval.cc, pt-mat.cc, + sighandlers.cc, strfns.cc, symtab.cc, syscalls.cc, sysdep.cc, + toplev.cc, utils.cc, variables.cc: Grammarcheck .cc files + 2010-07-30 John W. Eaton <jwe@octave.org> * debug.cc (Fdbstack): Improve display.
--- a/src/DLD-FUNCTIONS/__magick_read__.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/__magick_read__.cc Sat Jul 31 11:18:11 2010 -0700 @@ -373,11 +373,11 @@ DEFUN_DLD (__magick_read__, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Function File} {@var{m} =} __magick_read__(@var{fname}, @var{index})\n\ -@deftypefnx{Function File} {[@var{m}, @var{colormap}] =} __magick_read__(@var{fname}, @var{index})\n\ -@deftypefnx{Function File} {[@var{m}, @var{colormap}, @var{alpha}] =} __magick_read__(@var{fname}, @var{index})\n\ -Read images with ImageMagick++. In general you should not be using this function.\n\ -Instead you should use @code{imread}.\n\ +@deftypefn {Function File} {@var{m} =} __magick_read__(@var{fname}, @var{index})\n\ +@deftypefnx {Function File} {[@var{m}, @var{colormap}] =} __magick_read__(@var{fname}, @var{index})\n\ +@deftypefnx {Function File} {[@var{m}, @var{colormap}, @var{alpha}] =} __magick_read__(@var{fname}, @var{index})\n\ +Read images with ImageMagick++. In general you should not be using this\n\ +function. Instead you should use @code{imread}.\n\ @seealso{imread}\n\ @end deftypefn") { @@ -822,10 +822,10 @@ DEFUN_DLD (__magick_write__, args, , "-*- texinfo -*-\n\ -@deftypefn {Function File} {} __magick_write__(@var{fname}, @var{fmt}, @var{img})\n\ +@deftypefn {Function File} {} __magick_write__(@var{fname}, @var{fmt}, @var{img})\n\ @deftypefnx {Function File} {} __magick_write__(@var{fname}, @var{fmt}, @var{img}, @var{map})\n\ -Write images with ImageMagick++. In general you should not be using this function.\n\ -Instead you should use @code{imwrite}.\n\ +Write images with ImageMagick++. In general you should not be using this\n\ +function. Instead you should use @code{imwrite}.\n\ @seealso{imread}\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/__voronoi__.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/__voronoi__.cc Sat Jul 31 11:18:11 2010 -0700 @@ -55,7 +55,7 @@ DEFUN_DLD (__voronoi__, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{tri} =} __voronoi__ (@var{point})\n\ +@deftypefn {Loadable Function} {@var{tri} =} __voronoi__ (@var{point})\n\ @deftypefnx {Loadable Function} {@var{tri} =} __voronoi__ (@var{point}, @var{options})\n\ Undocumented internal function.\n\ @end deftypefn")
--- a/src/DLD-FUNCTIONS/amd.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/amd.cc Sat Jul 31 11:18:11 2010 -0700 @@ -52,7 +52,7 @@ DEFUN_DLD (amd, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{p} =} amd (@var{s})\n\ +@deftypefn {Loadable Function} {@var{p} =} amd (@var{s})\n\ @deftypefnx {Loadable Function} {@var{p} =} amd (@var{s}, @var{opts})\n\ \n\ Returns the approximate minimum degree permutation of a matrix. This\n\ @@ -77,7 +77,7 @@ absorption. The default is not to perform aggressive absorption.\n\ @end table\n\ \n\ -The author of the code itself is Timothy A. Davis (davis@@cise.ufl.edu),\n\ +The author of the code itself is Timothy A. Davis @email{davis@@cise.ufl.edu},\n\ University of Florida (see @url{http://www.cise.ufl.edu/research/sparse/amd}).\n\ @seealso{symamd, colamd}\n\ @end deftypefn")
--- a/src/DLD-FUNCTIONS/balance.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/balance.cc Sat Jul 31 11:18:11 2010 -0700 @@ -49,7 +49,7 @@ DEFUN_DLD (balance, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{aa} =} balance (@var{a}, @var{opt})\n\ +@deftypefn {Loadable Function} {@var{aa} =} balance (@var{a}, @var{opt})\n\ @deftypefnx {Loadable Function} {[@var{dd}, @var{aa}] =} balance (@var{a}, @var{opt})\n\ @deftypefnx {Loadable Function} {[@var{d}, @var{p}, @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\ @@ -63,7 +63,7 @@ \n\ If two output values are requested, @code{balance} returns \n\ the diagonal @code{d} and the permutation @code{p} separately as vectors. \n\ -In this case, @code{dd = eye(n)(:,p) * diag (d)}, where @code{n} is the matrix \n\ +In this case, @code{dd = eye(n)(:,p) * diag (d)}, where @code{n} is the matrix\n\ size. \n\ \n\ If four output values are requested, compute @code{aa = cc*a*dd} and\n\
--- a/src/DLD-FUNCTIONS/besselj.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/besselj.cc Sat Jul 31 11:18:11 2010 -0700 @@ -379,7 +379,7 @@ DEFUN_DLD (besselj, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt})\n\ +@deftypefn {Loadable Function} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt})\n\ @deftypefnx {Loadable Function} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt})\n\ @deftypefnx {Loadable Function} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt})\n\ @deftypefnx {Loadable Function} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt})\n\ @@ -390,15 +390,21 @@ @item besselj\n\ Bessel functions of the first kind. If the argument @var{opt} is supplied, \n\ the result is multiplied by @code{exp(-abs(imag(x)))}.\n\ +\n\ @item bessely\n\ Bessel functions of the second kind. If the argument @var{opt} is supplied,\n\ the result is multiplied by @code{exp(-abs(imag(x)))}.\n\ +\n\ @item besseli\n\ -Modified Bessel functions of the first kind. If the argument @var{opt} is supplied,\n\ -the result is multiplied by @code{exp(-abs(real(x)))}.\n\ +\n\ +Modified Bessel functions of the first kind. If the argument @var{opt} is\n\ +supplied, the result is multiplied by @code{exp(-abs(real(x)))}.\n\ +\n\ @item besselk\n\ -Modified Bessel functions of the second kind. If the argument @var{opt} is supplied,\n\ -the result is multiplied by @code{exp(x)}.\n\ +\n\ +Modified Bessel functions of the second kind. If the argument @var{opt} is\n\ +supplied, the result is multiplied by @code{exp(x)}.\n\ +\n\ @item besselh\n\ Compute Hankel functions of the first (@var{k} = 1) or second (@var{k}\n\ = 2) kind. If the argument @var{opt} is supplied, the result is multiplied by\n\ @@ -422,15 +428,20 @@ @enumerate 0\n\ @item\n\ Normal return.\n\ +\n\ @item\n\ Input error, return @code{NaN}.\n\ +\n\ @item\n\ Overflow, return @code{Inf}.\n\ +\n\ @item\n\ Loss of significance by argument reduction results in less than\n\ half of machine accuracy.\n\ +\n\ @item\n\ Complete loss of significance by argument reduction, return @code{NaN}.\n\ +\n\ @item\n\ Error---no computation, algorithm termination condition not met,\n\ return @code{NaN}.\n\ @@ -539,15 +550,20 @@ @enumerate 0\n\ @item\n\ Normal return.\n\ +\n\ @item\n\ Input error, return @code{NaN}.\n\ +\n\ @item\n\ Overflow, return @code{Inf}.\n\ +\n\ @item\n\ Loss of significance by argument reduction results in less than half\n\ of machine accuracy.\n\ +\n\ @item\n\ Complete loss of significance by argument reduction, return @code{NaN}.\n\ +\n\ @item\n\ Error---no computation, algorithm termination condition not met,\n\ return @code{NaN}.\n\
--- a/src/DLD-FUNCTIONS/betainc.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/betainc.cc Sat Jul 31 11:18:11 2010 -0700 @@ -46,12 +46,15 @@ \n\ @c Set example in small font to prevent overfull line\n\ @smallexample\n\ +@group\n\ x\n\ /\n\ betainc (x, a, b) = beta (a, b)^(-1) | t^(a-1) (1-t)^(b-1) dt.\n\ /\n\ t=0\n\ +@end group\n\ @end smallexample\n\ +\n\ @end ifnottex\n\ \n\ If x has more than one component, both @var{a} and @var{b} must be\n\
--- a/src/DLD-FUNCTIONS/ccolamd.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/ccolamd.cc Sat Jul 31 11:18:11 2010 -0700 @@ -53,17 +53,19 @@ DEFUN_DLD (ccolamd, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{p} =} ccolamd (@var{s})\n\ +@deftypefn {Loadable Function} {@var{p} =} ccolamd (@var{s})\n\ @deftypefnx {Loadable Function} {@var{p} =} ccolamd (@var{s}, @var{knobs})\n\ @deftypefnx {Loadable Function} {@var{p} =} ccolamd (@var{s}, @var{knobs}, @var{cmember})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} ccolamd (@dots{})\n\ \n\ -Constrained column approximate minimum degree permutation. @code{@var{p} =\n\ -ccolamd (@var{s})} returns the column approximate minimum degree permutation\n\ -vector for the sparse matrix @var{s}. For a non-symmetric matrix @var{s},\n\ +Constrained column approximate minimum degree permutation.\n\ +@code{@var{p} = ccolamd (@var{s})} returns the column approximate minimum degree\n\ +permutation vector for the sparse matrix @var{s}. For a non-symmetric matrix\n\ +@var{s},\n\ @code{@var{s} (:, @var{p})} tends to have sparser LU factors than @var{s}.\n\ @code{chol (@var{s} (:, @var{p})' * @var{s} (:, @var{p}))} also tends to be\n\ -sparser than @code{chol (@var{s}' * @var{s})}. @code{@var{p} = ccolamd\n\ +sparser than @code{chol (@var{s}' * @var{s})}.\n\ +@code{@var{p} = ccolamd\n\ (@var{s}, 1)} optimizes the ordering for @code{lu (@var{s} (:, @var{p}))}.\n\ The ordering is followed by a column elimination tree post-ordering.\n\ \n\ @@ -99,14 +101,14 @@ @var{j} is in constraint set @var{c} (@var{c} must be in the range 1 to\n\ @var{n}). In the output permutation @var{p}, all columns in set 1 appear\n\ first, followed by all columns in set 2, and so on. @code{@var{cmember} =\n\ -ones(1,n)} if not present or empty. @code{ccolamd (@var{s}, [], 1 :\n\ -@var{n})} returns @code{1 : @var{n}}\n\ +ones(1,n)} if not present or empty.\n\ +@code{ccolamd (@var{s}, [], 1 : @var{n})} returns @code{1 : @var{n}}\n\ \n\ -@code{@var{p} = ccolamd (@var{s})} is about the same as @code{@var{p} =\n\ -colamd (@var{s})}. @var{knobs} and its default values differ. @code{colamd}\n\ -always does aggressive absorption, and it finds an ordering suitable for\n\ -both @code{lu (@var{s} (:, @var{p}))} and @code{chol (@var{S} (:, @var{p})'\n\ -* @var{s} (:, @var{p}))}; it cannot optimize its ordering for\n\ +@code{@var{p} = ccolamd (@var{s})} is about the same as\n\ +@code{@var{p} = colamd (@var{s})}. @var{knobs} and its default values differ. \n\ +@code{colamd} always does aggressive absorption, and it finds an ordering\n\ +suitable for both @code{lu (@var{s} (:, @var{p}))} and @code{chol (@var{S} (:,\n\ +@var{p})' * @var{s} (:, @var{p}))}; it cannot optimize its ordering for\n\ @code{lu (@var{s} (:, @var{p}))} to the extent that\n\ @code{ccolamd (@var{s}, 1)} can.\n\ \n\ @@ -114,8 +116,8 @@ about the ordering and the validity of the input matrix @var{s}. Ordering\n\ statistics are in @code{@var{stats} (1 : 3)}. @code{@var{stats} (1)} and\n\ @code{@var{stats} (2)} are the number of dense or empty rows and columns\n\ -ignored by CCOLAMD and @code{@var{stats} (3)} is the number of garbage\n\ -collections performed on the internal data structure used by CCOLAMD\n\ +ignored by @sc{ccolamd} and @code{@var{stats} (3)} is the number of garbage\n\ +collections performed on the internal data structure used by @sc{ccolamd}\n\ (roughly of size @code{2.2 * nnz (@var{s}) + 4 * @var{m} + 7 * @var{n}}\n\ integers).\n\ \n\ @@ -127,7 +129,7 @@ index in the column index given by @code{@var{stats} (5)}, or zero if no\n\ such row index exists. @code{@var{stats} (7)} is the number of duplicate\n\ or out-of-order row indices. @code{@var{stats} (8 : 20)} is always zero in\n\ -the current version of CCOLAMD (reserved for future use).\n\ +the current version of @sc{ccolamd} (reserved for future use).\n\ \n\ The authors of the code itself are S. Larimore, T. Davis (Univ. of Florida)\n\ and S. Rajamanickam in collaboration with J. Bilbert and E. Ng. Supported\n\ @@ -333,7 +335,7 @@ DEFUN_DLD (csymamd, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{p} =} csymamd (@var{s})\n\ +@deftypefn {Loadable Function} {@var{p} =} csymamd (@var{s})\n\ @deftypefnx {Loadable Function} {@var{p} =} csymamd (@var{s}, @var{knobs})\n\ @deftypefnx {Loadable Function} {@var{p} =} csymamd (@var{s}, @var{knobs}, @var{cmember})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} csymamd (@dots{})\n\ @@ -382,7 +384,7 @@ index in the column index given by @code{@var{stats} (5)}, or zero if no\n\ such row index exists. @code{@var{stats} (7)} is the number of duplicate\n\ or out-of-order row indices. @code{@var{stats} (8:20)} is always zero in\n\ -the current version of CCOLAMD (reserved for future use).\n\ +the current version of @sc{ccolamd} (reserved for future use).\n\ \n\ The authors of the code itself are S. Larimore, T. Davis (Uni of Florida)\n\ and S. Rajamanickam in collaboration with J. Bilbert and E. Ng. Supported\n\
--- a/src/DLD-FUNCTIONS/cellfun.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/cellfun.cc Sat Jul 31 11:18:11 2010 -0700 @@ -109,18 +109,25 @@ @table @code\n\ @item isempty\n\ Return 1 for empty elements.\n\ +\n\ @item islogical\n\ Return 1 for logical elements.\n\ +\n\ @item isreal\n\ Return 1 for real elements.\n\ +\n\ @item length\n\ Return a vector of the lengths of cell elements.\n\ +\n\ @item ndims\n\ Return the number of dimensions of each element.\n\ +\n\ @item prodofsize\n\ Return the product of dimensions of each element.\n\ +\n\ @item size\n\ Return the size along the @var{k}-th dimension.\n\ +\n\ @item isclass\n\ Return 1 for elements of @var{class}.\n\ @end table\n\ @@ -131,7 +138,7 @@ argument, the function must accept a single argument named @var{x}, and\n\ it must return a string value. The function can take one or more arguments,\n\ with the inputs arguments given by @var{c}, @var{d}, etc. Equally the\n\ -function can return one or more output arguments. For example\n\ +function can return one or more output arguments. For example:\n\ \n\ @example\n\ @group\n\ @@ -141,8 +148,8 @@ @end example\n\ \n\ The number of output arguments of @code{cellfun} matches the number of output\n\ -arguments of the function. The outputs of the function will be collected into the\n\ -output arguments of @code{cellfun} like this:\n\ +arguments of the function. The outputs of the function will be collected into\n\ +the output arguments of @code{cellfun} like this:\n\ \n\ @example\n\ @group\n\ @@ -158,15 +165,15 @@ 1 4 9\n\ @end group\n\ @end example\n\ +\n\ Note that per default the output argument(s) are arrays of the same size as the\n\ -input arguments.\n\ -Input arguments that are singleton (1x1) cells will be automatically expanded\n\ -to the size of the other arguments.\n\ +input arguments. Input arguments that are singleton (1x1) cells will be\n\ +automatically expanded to the size of the other arguments.\n\ \n\ If the parameter 'UniformOutput' is set to true (the default), then the function\n\ -must return scalars which will be concatenated into the\n\ -return array(s). If 'UniformOutput' is false, the outputs are concatenated into\n\ -a cell array (or cell arrays). For example\n\ +must return scalars which will be concatenated into the return array(s). If\n\ +'UniformOutput' is false, the outputs are concatenated into a cell array (or\n\ +cell arrays). For example\n\ \n\ @example\n\ @group\n\ @@ -187,7 +194,7 @@ @var{func}, given by @var{s}. This is a structure with the elements\n\ 'identifier', 'message' and 'index', giving respectively the error\n\ identifier, the error message, and the index into the input arguments\n\ -of the element that caused the error. For example\n\ +of the element that caused the error. For example:\n\ \n\ @example\n\ @group\n\ @@ -1281,7 +1288,7 @@ DEFUN_DLD (mat2cell, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{b} =} mat2cell (@var{a}, @var{m}, @var{n})\n\ +@deftypefn {Loadable Function} {@var{b} =} mat2cell (@var{a}, @var{m}, @var{n})\n\ @deftypefnx {Loadable Function} {@var{b} =} mat2cell (@var{a}, @var{d1}, @var{d2}, @dots{})\n\ @deftypefnx {Loadable Function} {@var{b} =} mat2cell (@var{a}, @var{r})\n\ Convert the matrix @var{a} to a cell array. If @var{a} is 2-D, then\n\ @@ -1453,9 +1460,9 @@ DEFUN_DLD (cellslices, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{sl} =} cellslices (@var{x}, @var{lb}, @var{ub}, @var{dim})\n\ -Given an array @var{x}, this function produces a cell array of slices from the array\n\ -determined by the index vectors @var{lb}, @var{ub}, for lower and upper bounds, respectively.\n\ -In other words, it is equivalent to the following code:\n\ +Given an array @var{x}, this function produces a cell array of slices from the\n\ +array determined by the index vectors @var{lb}, @var{ub}, for lower and upper\n\ +bounds, respectively. In other words, it is equivalent to the following code:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/chol.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/chol.cc Sat Jul 31 11:18:11 2010 -0700 @@ -63,7 +63,7 @@ DEFUN_DLD (chol, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{r} =} chol (@var{a})\n\ +@deftypefn {Loadable Function} {@var{r} =} chol (@var{a})\n\ @deftypefnx {Loadable Function} {[@var{r}, @var{p}] =} chol (@var{a})\n\ @deftypefnx {Loadable Function} {[@var{r}, @var{p}, @var{q}] =} chol (@var{s})\n\ @deftypefnx {Loadable Function} {[@var{r}, @var{p}, @var{q}] =} chol (@var{s}, 'vector')\n\ @@ -79,6 +79,7 @@ @example\n\ @var{r}' * @var{r} = @var{a}.\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ Called with one output argument @code{chol} fails if @var{a} or @var{s} is\n\ @@ -98,6 +99,7 @@ @example\n\ @var{r}' * @var{r} = @var{q}' * @var{a} * @var{q}.\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ The sparsity preserving permutation is generally returned as a matrix.\n\ @@ -111,6 +113,7 @@ @example\n\ @var{r}' * @var{r} = a (@var{q}, @var{q}).\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ Called with either a sparse or full matrix and using the 'lower' flag,\n\ @@ -123,6 +126,7 @@ @example\n\ @var{l} * @var{l}' = @var{a}.\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ In general the lower triangular factorization is significantly faster for\n\ @@ -598,6 +602,7 @@ @item\n\ @var{R1}'*@var{R1} = @var{R}'*@var{R} + @var{u}*@var{u}'\n\ if @var{op} is \"+\"\n\ +\n\ @item\n\ @var{R1}'*@var{R1} = @var{R}'*@var{R} - @var{u}*@var{u}'\n\ if @var{op} is \"-\"\n\ @@ -606,7 +611,9 @@ If @var{op} is \"-\", @var{info} is set to\n\ @itemize\n\ @item 0 if the downdate was successful,\n\ +\n\ @item 1 if @var{R}'*@var{R} - @var{u}*@var{u}' is not positive definite,\n\ +\n\ @item 2 if @var{R} is singular.\n\ @end itemize\n\ \n\ @@ -808,15 +815,17 @@ DEFUN_DLD (cholinsert, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {[@var{R1}, @var{info}] =} cholinsert (@var{R}, @var{j}, @var{u})\n\ -Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\ -positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\ -return the Cholesky@tie{}factorization of\n\ +Given a Cholesky@tie{}factorization of a real symmetric or complex Hermitian\n\ +positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper\n\ +triangular, return the Cholesky@tie{}factorization of\n\ @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\ @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\ On return, @var{info} is set to\n\ @itemize\n\ @item 0 if the insertion was successful,\n\ +\n\ @item 1 if @var{A1} is not positive definite,\n\ +\n\ @item 2 if @var{R} is singular.\n\ @end itemize\n\ \n\ @@ -992,9 +1001,10 @@ DEFUN_DLD (choldelete, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{R1} =} choldelete (@var{R}, @var{j})\n\ -Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\ -positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\ -return the Cholesky@tie{}factorization of @w{A(p,p)}, where @w{p = [1:j-1,j+1:n+1]}.\n\ +Given a Cholesky@tie{}factorization of a real symmetric or complex Hermitian\n\ +positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper\n\ +triangular, return the Cholesky@tie{}factorization of @w{A(p,p)}, where @w{p =\n\ +[1:j-1,j+1:n+1]}.\n\ @seealso{chol, cholupdate, cholinsert}\n\ @end deftypefn") { @@ -1124,9 +1134,9 @@ DEFUN_DLD (cholshift, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{R1} =} cholshift (@var{R}, @var{i}, @var{j})\n\ -Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\ -positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\ -return the Cholesky@tie{}factorization of\n\ +Given a Cholesky@tie{}factorization of a real symmetric or complex Hermitian\n\ +positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper\n\ +triangular, return the Cholesky@tie{}factorization of\n\ @w{@var{A}(p,p)}, where @w{p} is the permutation @*\n\ @code{p = [1:i-1, shift(i:j, 1), j+1:n]} if @w{@var{i} < @var{j}} @*\n\ or @*\n\
--- a/src/DLD-FUNCTIONS/colamd.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/colamd.cc Sat Jul 31 11:18:11 2010 -0700 @@ -210,14 +210,15 @@ DEFUN_DLD (colamd, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{p} =} colamd (@var{s})\n\ +@deftypefn {Loadable Function} {@var{p} =} colamd (@var{s})\n\ @deftypefnx {Loadable Function} {@var{p} =} colamd (@var{s}, @var{knobs})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} colamd (@var{s})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} colamd (@var{s}, @var{knobs})\n\ \n\ -Column approximate minimum degree permutation. @code{@var{p} = colamd\n\ -(@var{s})} returns the column approximate minimum degree permutation\n\ -vector for the sparse matrix @var{s}. For a non-symmetric matrix @var{s},\n\ +Column approximate minimum degree permutation.\n\ +@code{@var{p} = colamd (@var{s})} returns the column approximate minimum degree\n\ +permutation vector for the sparse matrix @var{s}. For a non-symmetric matrix\n\ +@var{s},\n\ @code{@var{s} (:,@var{p})} tends to have sparser LU factors than @var{s}.\n\ The Cholesky factorization of @code{@var{s} (:,@var{p})' * @var{s}\n\ (:,@var{p})} also tends to be sparser than that of @code{@var{s}' *\n\ @@ -237,23 +238,23 @@ about the ordering and the validity of the input matrix @var{s}. Ordering\n\ statistics are in @code{@var{stats} (1:3)}. @code{@var{stats} (1)} and\n\ @code{@var{stats} (2)} are the number of dense or empty rows and columns\n\ -ignored by COLAMD and @code{@var{stats} (3)} is the number of garbage\n\ -collections performed on the internal data structure used by COLAMD\n\ +ignored by @sc{colamd} and @code{@var{stats} (3)} is the number of garbage\n\ +collections performed on the internal data structure used by @sc{colamd}\n\ (roughly of size @code{2.2 * nnz(@var{s}) + 4 * @var{m} + 7 * @var{n}}\n\ integers).\n\ \n\ Octave built-in functions are intended to generate valid sparse matrices,\n\ with no duplicate entries, with ascending row indices of the nonzeros\n\ in each column, with a non-negative number of entries in each column (!)\n\ -and so on. If a matrix is invalid, then COLAMD may or may not be able\n\ +and so on. If a matrix is invalid, then @sc{colamd} may or may not be able\n\ to continue. If there are duplicate entries (a row index appears two or\n\ more times in the same column) or if the row indices in a column are out\n\ -of order, then COLAMD can correct these errors by ignoring the duplicate\n\ +of order, then @sc{colamd} can correct these errors by ignoring the duplicate\n\ entries and sorting each column of its internal copy of the matrix\n\ @var{s} (the input matrix @var{s} is not repaired, however). If a matrix\n\ -is invalid in other ways then COLAMD cannot continue, an error message is\n\ +is invalid in other ways then @sc{colamd} cannot continue, an error message is\n\ printed, and no output arguments (@var{p} or @var{stats}) are returned.\n\ -COLAMD is thus a simple way to check a sparse matrix to see if it's\n\ +@sc{colamd} is thus a simple way to check a sparse matrix to see if it's\n\ valid.\n\ \n\ @code{@var{stats} (4:7)} provide information if COLAMD was able to\n\ @@ -264,12 +265,12 @@ index in the column index given by @code{@var{stats} (5)}, or zero if no\n\ such row index exists. @code{@var{stats} (7)} is the number of duplicate\n\ or out-of-order row indices. @code{@var{stats} (8:20)} is always zero in\n\ -the current version of COLAMD (reserved for future use).\n\ +the current version of @sc{colamd} (reserved for future use).\n\ \n\ The ordering is followed by a column elimination tree post-ordering.\n\ \n\ The authors of the code itself are Stefan I. Larimore and Timothy A.\n\ -Davis (davis@@cise.ufl.edu), University of Florida. The algorithm was\n\ +Davis @email{davis@@cise.ufl.edu}, University of Florida. The algorithm was\n\ developed in collaboration with John Gilbert, Xerox PARC, and Esmond\n\ Ng, Oak Ridge National Laboratory. (see\n\ @url{http://www.cise.ufl.edu/research/sparse/colamd})\n\ @@ -449,7 +450,7 @@ DEFUN_DLD (symamd, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{p} =} symamd (@var{s})\n\ +@deftypefn {Loadable Function} {@var{p} =} symamd (@var{s})\n\ @deftypefnx {Loadable Function} {@var{p} =} symamd (@var{s}, @var{knobs})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} symamd (@var{s})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} symamd (@var{s}, @var{knobs})\n\ @@ -505,7 +506,7 @@ \n\ \n\ The authors of the code itself are Stefan I. Larimore and Timothy A.\n\ -Davis (davis@@cise.ufl.edu), University of Florida. The algorithm was\n\ +Davis @email{davis@@cise.ufl.edu}, University of Florida. The algorithm was\n\ developed in collaboration with John Gilbert, Xerox PARC, and Esmond\n\ Ng, Oak Ridge National Laboratory. (see\n\ @url{http://www.cise.ufl.edu/research/sparse/colamd})\n\ @@ -646,7 +647,7 @@ DEFUN_DLD (etree, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{p} =} etree (@var{s})\n\ +@deftypefn {Loadable Function} {@var{p} =} etree (@var{s})\n\ @deftypefnx {Loadable Function} {@var{p} =} etree (@var{s}, @var{typ})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{q}] =} etree (@var{s}, @var{typ})\n\ \n\
--- a/src/DLD-FUNCTIONS/conv2.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/conv2.cc Sat Jul 31 11:18:11 2010 -0700 @@ -51,7 +51,7 @@ DEFUN_DLD (conv2, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {y =} conv2 (@var{a}, @var{b}, @var{shape})\n\ +@deftypefn {Loadable Function} {y =} conv2 (@var{a}, @var{b}, @var{shape})\n\ @deftypefnx {Loadable Function} {y =} conv2 (@var{v1}, @var{v2}, @var{M}, @var{shape})\n\ \n\ Returns 2D convolution of @var{a} and @var{b} where the size\n\ @@ -60,8 +60,10 @@ @table @asis\n\ @item @var{shape} = 'full'\n\ returns full 2-D convolution\n\ +\n\ @item @var{shape} = 'same'\n\ same size as a. 'central' part of convolution\n\ +\n\ @item @var{shape} = 'valid'\n\ only parts which do not include zero-padded edges\n\ @end table\n\ @@ -246,8 +248,10 @@ @table @asis\n\ @item @var{shape} = 'full'\n\ returns full n-D convolution\n\ +\n\ @item @var{shape} = 'same'\n\ same size as a. 'central' part of convolution\n\ +\n\ @item @var{shape} = 'valid'\n\ only parts which do not include zero-padded edges\n\ @end table\n\
--- a/src/DLD-FUNCTIONS/convhulln.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/convhulln.cc Sat Jul 31 11:18:11 2010 -0700 @@ -53,7 +53,7 @@ DEFUN_DLD (convhulln, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{h} =} convhulln (@var{p})\n\ +@deftypefn {Loadable Function} {@var{h} =} convhulln (@var{p})\n\ @deftypefnx {Loadable Function} {@var{h} =} convhulln (@var{p}, @var{opt})\n\ @deftypefnx {Loadable Function} {[@var{h}, @var{v}] =} convhulln (@dots{})\n\ Return an index vector to the points of the enclosing convex hull.\n\
--- a/src/DLD-FUNCTIONS/daspk.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/daspk.cc Sat Jul 31 11:18:11 2010 -0700 @@ -232,6 +232,7 @@ dx d xdot\n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ The modified Jacobian function must have the form\n\ @@ -260,7 +261,7 @@ discontinuity in the derivative.\n\ \n\ After a successful computation, the value of @var{istate} will be\n\ -greater than zero (consistent with the Fortran version of @sc{Daspk}).\n\ +greater than zero (consistent with the Fortran version of @sc{daspk}).\n\ \n\ If the computation is not successful, the value of @var{istate} will be\n\ less than zero and @var{msg} will contain additional information.\n\
--- a/src/DLD-FUNCTIONS/dasrt.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/dasrt.cc Sat Jul 31 11:18:11 2010 -0700 @@ -298,22 +298,22 @@ @end example\n\ \n\ and return a vector of the constraint function values.\n\ -If the value of any of the constraint functions changes sign, @sc{Dasrt}\n\ +If the value of any of the constraint functions changes sign, @sc{dasrt}\n\ will attempt to stop the integration at the point of the sign change.\n\ \n\ If the name of the constraint function is omitted, @code{dasrt} solves\n\ the same problem as @code{daspk} or @code{dassl}.\n\ \n\ Note that because of numerical errors in the constraint functions\n\ -due to round-off and integration error, @sc{Dasrt} may return false\n\ +due to round-off and integration error, @sc{dasrt} may return false\n\ roots, or return the same root at two or more nearly equal values of\n\ @var{T}. If such false roots are suspected, the user should consider\n\ smaller error tolerances or higher precision in the evaluation of the\n\ constraint functions.\n\ \n\ If a root of some constraint function defines the end of the problem,\n\ -the input to @sc{Dasrt} should nevertheless allow integration to a\n\ -point slightly past that root, so that @sc{Dasrt} can locate the root\n\ +the input to @sc{dasrt} should nevertheless allow integration to a\n\ +point slightly past that root, so that @sc{dasrt} can locate the root\n\ by interpolation.\n\ \n\ The third and fourth arguments to @code{dasrt} specify the initial\n\ @@ -322,7 +322,7 @@ including the time corresponding to the initial condition.\n\ \n\ The set of initial states and derivatives are not strictly required to\n\ -be consistent. In practice, however, @sc{Dassl} is not very good at\n\ +be consistent. In practice, however, @sc{dassl} is not very good at\n\ determining a consistent set for you, so it is best if you ensure that\n\ the initial values result in the function evaluating to zero.\n\ \n\ @@ -332,7 +332,7 @@ discontinuity in the derivative.\n\ \n\ After a successful computation, the value of @var{istate} will be\n\ -greater than zero (consistent with the Fortran version of @sc{Dassl}).\n\ +greater than zero (consistent with the Fortran version of @sc{dassl}).\n\ \n\ If the computation is not successful, the value of @var{istate} will be\n\ less than zero and @var{msg} will contain additional information.\n\
--- a/src/DLD-FUNCTIONS/dassl.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/dassl.cc Sat Jul 31 11:18:11 2010 -0700 @@ -226,6 +226,7 @@ $$\n\ @end tex\n\ @ifnottex\n\ +\n\ @example\n\ @group\n\ df df\n\ @@ -233,6 +234,7 @@ dx d xdot\n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ The modified Jacobian function must have the form\n\ @@ -251,7 +253,7 @@ including the time corresponding to the initial condition.\n\ \n\ The set of initial states and derivatives are not strictly required to\n\ -be consistent. In practice, however, @sc{Dassl} is not very good at\n\ +be consistent. In practice, however, @sc{dassl} is not very good at\n\ determining a consistent set for you, so it is best if you ensure that\n\ the initial values result in the function evaluating to zero.\n\ \n\ @@ -261,7 +263,7 @@ discontinuity in the derivative.\n\ \n\ After a successful computation, the value of @var{istate} will be\n\ -greater than zero (consistent with the Fortran version of @sc{Dassl}).\n\ +greater than zero (consistent with the Fortran version of @sc{dassl}).\n\ \n\ If the computation is not successful, the value of @var{istate} will be\n\ less than zero and @var{msg} will contain additional information.\n\
--- a/src/DLD-FUNCTIONS/dmperm.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/dmperm.cc Sat Jul 31 11:18:11 2010 -0700 @@ -133,7 +133,7 @@ DEFUN_DLD (dmperm, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{p} =} dmperm (@var{s})\n\ +@deftypefn {Loadable Function} {@var{p} =} dmperm (@var{s})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{q}, @var{r}, @var{s}] =} dmperm (@var{s})\n\ \n\ @cindex Dulmage-Mendelsohn decomposition\n\ @@ -195,10 +195,10 @@ @cindex Structural Rank\n\ Calculates the structural rank of a sparse matrix @var{s}. Note that\n\ only the structure of the matrix is used in this calculation based on\n\ -a Dulmage-Mendelsohn permutation to block triangular form. As such the numerical\n\ -rank of the matrix @var{s} is bounded by @code{sprank (@var{s}) >=\n\ -rank (@var{s})}. Ignoring floating point errors @code{sprank (@var{s}) ==\n\ -rank (@var{s})}.\n\ +a Dulmage-Mendelsohn permutation to block triangular form. As such the\n\ +numerical rank of the matrix @var{s} is bounded by\n\ +@code{sprank (@var{s}) >= rank (@var{s})}. Ignoring floating point errors\n\ +@code{sprank (@var{s}) == rank (@var{s})}.\n\ @seealso{dmperm}\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/dot.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/dot.cc Sat Jul 31 11:18:11 2010 -0700 @@ -111,8 +111,8 @@ given, calculate the dot products along this dimension.\n\ \n\ This is equivalent to doing @code{sum (conj (@var{X}) .* @var{Y}, @var{dim})},\n\ -but avoids forming a temporary array and is faster.\n\ -When @var{X} and @var{Y} are column vectors, the result is equivalent to\n\ +but avoids forming a temporary array and is faster. When @var{X} and @var{Y}\n\ +are column vectors, the result is equivalent to\n\ @code{ @var{X}'*@var{Y} }.\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/eigs.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/eigs.cc Sat Jul 31 11:18:11 2010 -0700 @@ -286,9 +286,9 @@ The return arguments of @code{eigs} depend on the number of return arguments\n\ requested. With a single return argument, a vector @var{d} of length @var{k}\n\ is returned containing the @var{k} eigenvalues that have been found. With two\n\ -return arguments, @var{v} is a @var{n}-by-@var{k} matrix whose columns are\n\ -the @var{k} eigenvectors corresponding to the returned eigenvalues. The\n\ -eigenvalues themselves are returned in @var{d} in the form of a\n\ +return arguments, @var{v} is a @var{n}-by-@var{k} matrix whose columns are the\n\ +@var{k} eigenvectors corresponding to the returned eigenvalues. The eigenvalues\n\ +themselves are returned in @var{d} in the form of a\n\ @var{n}-by-@var{k} matrix, where the elements on the diagonal are the\n\ eigenvalues.\n\ \n\
--- a/src/DLD-FUNCTIONS/fftn.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/fftn.cc Sat Jul 31 11:18:11 2010 -0700 @@ -157,7 +157,7 @@ ". The optional vector argument @var{size} may be used specify the\n\ dimensions of the array to be used. If an element of @var{size} is\n\ smaller than the corresponding dimension, then the dimension is\n\ -truncated prior to performing the FFT. Otherwise if an element\n\ +truncated prior to performing the FFT@. Otherwise if an element\n\ of @var{size} is larger than the corresponding dimension @var{a}\n\ is resized and padded with zeros.\n\ @seealso {ifftn, fft, fft2, fftw}\n\ @@ -174,7 +174,7 @@ ". The optional vector argument @var{size} may be used specify the\n\ dimensions of the array to be used. If an element of @var{size} is\n\ smaller than the corresponding dimension, then the dimension is\n\ -truncated prior to performing the inverse FFT. Otherwise if an element\n\ +truncated prior to performing the inverse FFT@. Otherwise if an element\n\ of @var{size} is larger than the corresponding dimension @var{a}\n\ is resized and padded with zeros.\n\ @seealso {fftn, ifft, ifft2, fftw}\n\
--- a/src/DLD-FUNCTIONS/fftw.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/fftw.cc Sat Jul 31 11:18:11 2010 -0700 @@ -34,7 +34,7 @@ DEFUN_DLD (fftw, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{method} =} fftw ('planner')\n\ +@deftypefn {Loadable Function} {@var{method} =} fftw ('planner')\n\ @deftypefnx {Loadable Function} {} fftw ('planner', @var{method})\n\ @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom')\n\ @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom', @var{wisdom})\n\ @@ -42,8 +42,8 @@ Manage @sc{fftw} wisdom data. Wisdom data can be used to significantly\n\ accelerate the calculation of the FFTs but implies an initial cost\n\ in its calculation. When the @sc{fftw} libraries are initialized, they read\n\ -a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing wisdom\n\ -to be shared between applications other than Octave. Alternatively, the\n\ +a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing\n\ +wisdom to be shared between applications other than Octave. Alternatively, the\n\ @code{fftw} function can be used to import wisdom. For example\n\ \n\ @example\n\
--- a/src/DLD-FUNCTIONS/filter.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/filter.cc Sat Jul 31 11:18:11 2010 -0700 @@ -283,7 +283,7 @@ DEFUN_DLD (filter, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {y =} filter (@var{b}, @var{a}, @var{x})\n\ +@deftypefn {Loadable Function} {y =} filter (@var{b}, @var{a}, @var{x})\n\ @deftypefnx {Loadable Function} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, @var{si})\n\ @deftypefnx {Loadable Function} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, [], @var{dim})\n\ @deftypefnx {Loadable Function} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, @var{si}, @var{dim})\n\ @@ -299,10 +299,13 @@ \n\ @c Set example in small font to prevent overfull line\n\ @smallexample\n\ +@group\n\ N M\n\ SUM a(k+1) y(n-k) = SUM b(k+1) x(n-k) for 1<=n<=length(x)\n\ k=0 k=0\n\ +@end group\n\ @end smallexample\n\ +\n\ @end ifnottex\n\ \n\ @noindent\n\ @@ -325,10 +328,13 @@ \n\ @c Set example in small font to prevent overfull line\n\ @smallexample\n\ +@group\n\ N M\n\ y(n) = - SUM c(k+1) y(n-k) + SUM d(k+1) x(n-k) for 1<=n<=length(x)\n\ k=1 k=0\n\ +@end group\n\ @end smallexample\n\ +\n\ @end ifnottex\n\ \n\ @noindent\n\ @@ -369,6 +375,7 @@ k=1\n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/find.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/find.cc Sat Jul 31 11:18:11 2010 -0700 @@ -338,13 +338,13 @@ DEFUN_DLD (find, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} find (@var{x})\n\ +@deftypefn {Loadable Function} {} find (@var{x})\n\ @deftypefnx {Loadable Function} {} find (@var{x}, @var{n})\n\ @deftypefnx {Loadable Function} {} find (@var{x}, @var{n}, @var{direction})\n\ Return a vector of indices of nonzero elements of a matrix, as a row if\n\ @var{x} is a row or as a column otherwise. To obtain a single index for\n\ each matrix element, Octave pretends that the columns of a matrix form one\n\ -long vector (like Fortran arrays are stored). For example,\n\ +long vector (like Fortran arrays are stored). For example:\n\ \n\ @example\n\ @group\n\ @@ -354,7 +354,7 @@ @end example\n\ \n\ If two outputs are requested, @code{find} returns the row and column\n\ -indices of nonzero elements of a matrix. For example,\n\ +indices of nonzero elements of a matrix. For example:\n\ \n\ @example\n\ @group\n\ @@ -365,7 +365,7 @@ @end example\n\ \n\ If three outputs are requested, @code{find} also returns a vector\n\ -containing the nonzero values. For example,\n\ +containing the nonzero values. For example:\n\ \n\ @example\n\ @group\n\ @@ -385,7 +385,7 @@ \n\ Note that this function is particularly useful for sparse matrices, as\n\ it extracts the non-zero elements as vectors, which can then be used to\n\ -create the original matrix. For example,\n\ +create the original matrix. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/gammainc.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/gammainc.cc Sat Jul 31 11:18:11 2010 -0700 @@ -35,7 +35,7 @@ DEFUN_DLD (gammainc, args, , "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} gammainc (@var{x}, @var{a})\n\ +@deftypefn {Mapping Function} {} gammainc (@var{x}, @var{a})\n\ @deftypefnx {Mapping Function} {} gammainc (@var{x}, @var{a}, \"lower\")\n\ @deftypefnx {Mapping Function} {} gammainc (@var{x}, @var{a}, \"upper\")\n\ Compute the normalized incomplete gamma function,\n\ @@ -47,11 +47,13 @@ @ifnottex\n\ \n\ @smallexample\n\ +@group\n\ x\n\ 1 /\n\ gammainc (x, a) = --------- | exp (-t) t^(a-1) dt\n\ gamma (a) /\n\ t=0\n\ +@end group\n\ @end smallexample\n\ \n\ @end ifnottex\n\
--- a/src/DLD-FUNCTIONS/gcd.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/gcd.cc Sat Jul 31 11:18:11 2010 -0700 @@ -84,9 +84,11 @@ $g = v_1 a_1 + v_2 a_2 + \\cdots$\n\ @end tex\n\ @ifnottex\n\ +\n\ @example\n\ @var{g} = @var{v1} .* @var{a1} + @var{v2} .* @var{a2} + @dots{}\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ For backward compatibility with previous versions of this function, when\n\
--- a/src/DLD-FUNCTIONS/getrusage.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/getrusage.cc Sat Jul 31 11:18:11 2010 -0700 @@ -66,7 +66,7 @@ Return a structure containing a number of statistics about the current\n\ Octave process. Not all fields are available on all systems. If it is\n\ not possible to get CPU time statistics, the CPU time slots are set to\n\ -zero. Other missing data are replaced by NaN. Here is a list of all\n\ +zero. Other missing data are replaced by NaN@. Here is a list of all\n\ the possible fields that can be present in the structure returned by\n\ @code{getrusage}:\n\ \n\
--- a/src/DLD-FUNCTIONS/givens.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/givens.cc Sat Jul 31 11:18:11 2010 -0700 @@ -33,7 +33,7 @@ DEFUN_DLD (givens, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{g} =} givens (@var{x}, @var{y})\n\ +@deftypefn {Loadable Function} {@var{g} =} givens (@var{x}, @var{y})\n\ @deftypefnx {Loadable Function} {[@var{c}, @var{s}] =} givens (@var{x}, @var{y})\n\ @tex\n\ Return a $2\\times 2$ orthogonal matrix\n\ @@ -52,7 +52,7 @@ @code{@var{g} [@var{x}; @var{y}] = [*; 0]} with @var{x} and @var{y} scalars.\n\ @end ifnottex\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/hess.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/hess.cc Sat Jul 31 11:18:11 2010 -0700 @@ -38,7 +38,7 @@ DEFUN_DLD (hess, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{h} =} hess (@var{a})\n\ +@deftypefn {Loadable Function} {@var{h} =} hess (@var{a})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{h}] =} hess (@var{a})\n\ @cindex Hessenberg decomposition\n\ Compute the Hessenberg decomposition of the matrix @var{a}.\n\
--- a/src/DLD-FUNCTIONS/hex2num.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/hex2num.cc Sat Jul 31 11:18:11 2010 -0700 @@ -124,7 +124,7 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{s} =} num2hex (@var{n})\n\ Typecast a double precision number or vector to a 16 character hexadecimal\n\ -string of the IEEE 754 representation of the number. For example\n\ +string of the IEEE 754 representation of the number. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/inv.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/inv.cc Sat Jul 31 11:18:11 2010 -0700 @@ -39,7 +39,7 @@ DEFUN_DLD (inv, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{x}, @var{rcond}] =} inv (@var{a})\n\ +@deftypefn {Loadable Function} {[@var{x}, @var{rcond}] =} inv (@var{a})\n\ @deftypefnx {Loadable Function} {[@var{x}, @var{rcond}] =} inverse (@var{a})\n\ Compute the inverse of the square matrix @var{a}. Return an estimate\n\ of the reciprocal condition number if requested, otherwise warn of an\n\
--- a/src/DLD-FUNCTIONS/kron.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/kron.cc Sat Jul 31 11:18:11 2010 -0700 @@ -177,13 +177,13 @@ DEFUN_DLD (kron, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} kron (@var{a}, @var{b})\n\ -Form the kronecker product of two matrices, defined block by block as\n\ +Form the Kronecker product of two matrices, defined block by block as\n\ \n\ @example\n\ x = [a(i, j) b]\n\ @end example\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/lookup.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/lookup.cc Sat Jul 31 11:18:11 2010 -0700 @@ -218,6 +218,7 @@ @item m\n\ @code{table(idx(i)) == val(i)} if @code{val(i)}\n\ occurs in table; otherwise, @code{idx(i)} is zero.\n\ +\n\ @item b\n\ @code{idx(i)} is a logical 1 or 0, indicating whether\n\ @code{val(i)} is contained in table or not.\n\ @@ -226,6 +227,7 @@ For numeric lookups\n\ the leftmost subinterval shall be extended to infinity (i.e., all indices\n\ at least 1)\n\ +\n\ @item r\n\ For numeric lookups\n\ the rightmost subinterval shall be extended to infinity (i.e., all indices\n\
--- a/src/DLD-FUNCTIONS/lsode.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/lsode.cc Sat Jul 31 11:18:11 2010 -0700 @@ -260,7 +260,7 @@ discontinuity in the derivative.\n\ \n\ After a successful computation, the value of @var{istate} will be 2\n\ -(consistent with the Fortran version of @sc{Lsode}).\n\ +(consistent with the Fortran version of @sc{lsode}).\n\ \n\ If the computation is not successful, @var{istate} will be something\n\ other than 2 and @var{msg} will contain additional information.\n\
--- a/src/DLD-FUNCTIONS/lu.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/lu.cc Sat Jul 31 11:18:11 2010 -0700 @@ -614,7 +614,8 @@ [@var{L}, @var{U}, @var{P}] = lu (@var{A});\n\ @end example\n\ \n\ -then a factorization of @code{@var{a}+@var{x}*@var{y}.'} can be obtained either as\n\ +then a factorization of @code{@var{a}+@var{x}*@var{y}.'} can be obtained either\n\ +as\n\ \n\ @example\n\ [@var{L1}, @var{U1}] = lu (@var{L}, @var{U}, @var{P}*@var{x}, @var{y})\n\
--- a/src/DLD-FUNCTIONS/luinc.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/luinc.cc Sat Jul 31 11:18:11 2010 -0700 @@ -39,7 +39,7 @@ DEFUN_DLD (luinc, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{l}, @var{u}, @var{p}, @var{q}] =} luinc (@var{a}, '0')\n\ +@deftypefn {Loadable Function} {[@var{l}, @var{u}, @var{p}, @var{q}] =} luinc (@var{a}, '0')\n\ @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{p}, @var{q}] =} luinc (@var{a}, @var{droptol})\n\ @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{p}, @var{q}] =} luinc (@var{a}, @var{opts})\n\ @cindex LU decomposition\n\
--- a/src/DLD-FUNCTIONS/matrix_type.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/matrix_type.cc Sat Jul 31 11:18:11 2010 -0700 @@ -38,23 +38,23 @@ DEFUN_DLD (matrix_type, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{type} =} matrix_type (@var{a})\n\ +@deftypefn {Loadable Function} {@var{type} =} matrix_type (@var{a})\n\ @deftypefnx {Loadable Function} {@var{type} =} matrix_type (@var{a}, 'nocompute')\n\ @deftypefnx {Loadable Function} {@var{a} =} matrix_type (@var{a}, @var{type})\n\ @deftypefnx {Loadable Function} {@var{a} =} matrix_type (@var{a}, 'upper', @var{perm})\n\ @deftypefnx {Loadable Function} {@var{a} =} matrix_type (@var{a}, 'lower', @var{perm})\n\ @deftypefnx {Loadable Function} {@var{a} =} matrix_type (@var{a}, 'banded', @var{nl}, @var{nu})\n\ -Identify the matrix type or mark a matrix as a particular type. This allows rapid\n\ -for solutions of linear equations involving @var{a} to be performed. Called with a\n\ -single argument, @code{matrix_type} returns the type of the matrix and caches it for\n\ -future use. Called with more than one argument, @code{matrix_type} allows the type\n\ -of the matrix to be defined.\n\ +Identify the matrix type or mark a matrix as a particular type. This allows\n\ +rapid for solutions of linear equations involving @var{a} to be performed. \n\ +Called with a single argument, @code{matrix_type} returns the type of the matrix\n\ +and caches it for future use. Called with more than one argument,\n\ +@code{matrix_type} allows the type of the matrix to be defined.\n\ \n\ -If the option 'nocompute' is given, the function will not attempt to guess the type if it is\n\ -still unknown. This is useful for debugging purposes.\n\ +If the option 'nocompute' is given, the function will not attempt to guess the\n\ +type if it is still unknown. This is useful for debugging purposes.\n\ \n\ -The possible matrix types depend on whether the matrix is full or sparse, and can be\n\ -one of the following\n\ +The possible matrix types depend on whether the matrix is full or sparse, and\n\ +can be one of the following\n\ \n\ @table @asis\n\ @item 'unknown'\n\ @@ -71,45 +71,46 @@ \n\ @item 'permuted diagonal'\n\ Permuted Diagonal matrix. The permutation does not need to be specifically\n\ -indicated, as the structure of the matrix explicitly gives this. (Sparse matrices\n\ -only)\n\ +indicated, as the structure of the matrix explicitly gives this. (Sparse\n\ +matrices only)\n\ \n\ @item 'upper'\n\ -Upper triangular. If the optional third argument @var{perm} is given, the matrix is\n\ -assumed to be a permuted upper triangular with the permutations defined by the\n\ -vector @var{perm}.\n\ +Upper triangular. If the optional third argument @var{perm} is given, the\n\ +matrix is assumed to be a permuted upper triangular with the permutations\n\ +defined by the vector @var{perm}.\n\ \n\ @item 'lower'\n\ -Lower triangular. If the optional third argument @var{perm} is given, the matrix is\n\ -assumed to be a permuted lower triangular with the permutations defined by the\n\ -vector @var{perm}.\n\ +Lower triangular. If the optional third argument @var{perm} is given, the\n\ +matrix is assumed to be a permuted lower triangular with the permutations\n\ +defined by the vector @var{perm}.\n\ \n\ @item 'banded'\n\ @itemx 'banded positive definite'\n\ -Banded matrix with the band size of @var{nl} below the diagonal and @var{nu} above\n\ -it. If @var{nl} and @var{nu} are 1, then the matrix is tridiagonal and treated\n\ -with specialized code. In addition the matrix can be marked as probably a\n\ -positive definite (Sparse matrices only)\n\ +Banded matrix with the band size of @var{nl} below the diagonal and @var{nu}\n\ +above it. If @var{nl} and @var{nu} are 1, then the matrix is tridiagonal and\n\ +treated with specialized code. In addition the matrix can be marked as probably\n\ +a positive definite (Sparse matrices only)\n\ \n\ @item 'singular'\n\ -The matrix is assumed to be singular and will be treated with a minimum norm solution\n\ +The matrix is assumed to be singular and will be treated with a minimum norm\n\ +solution\n\ \n\ @end table\n\ \n\ -Note that the matrix type will be discovered automatically on the first attempt to\n\ -solve a linear equation involving @var{a}. Therefore @code{matrix_type} is only\n\ -useful to give Octave hints of the matrix type. Incorrectly defining the\n\ +Note that the matrix type will be discovered automatically on the first attempt\n\ +to solve a linear equation involving @var{a}. Therefore @code{matrix_type} is\n\ +only useful to give Octave hints of the matrix type. Incorrectly defining the\n\ matrix type will result in incorrect results from solutions of linear equations,\n\ and so it is entirely the responsibility of the user to correctly identify the\n\ matrix type.\n\ \n\ -Also the test for positive definiteness is a low-cost test for a hermitian\n\ +Also the test for positive definiteness is a low-cost test for a Hermitian\n\ matrix with a real positive diagonal. This does not guarantee that the matrix\n\ is positive definite, but only that it is a probable candidate. When such a\n\ -matrix is factorized, a Cholesky factorization is first attempted, and if\n\ -that fails the matrix is then treated with an LU factorization. Once the\n\ -matrix has been factorized, @code{matrix_type} will return the correct\n\ -classification of the matrix.\n\ +matrix is factorized, a Cholesky factorization is first attempted, and if that\n\ +fails the matrix is then treated with an LU factorization. Once the matrix has\n\ +been factorized, @code{matrix_type} will return the correct classification of\n\ +the matrix.\n\ @end deftypefn") { int nargin = args.length ();
--- a/src/DLD-FUNCTIONS/max.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/max.cc Sat Jul 31 11:18:11 2010 -0700 @@ -331,6 +331,7 @@ @result{} 2.0000 3.0000 3.1416 3.1416\n\ @end group\n\ @end example\n\ +\n\ @noindent\n\ compares each element of the range @code{2:5} with @code{pi}, and\n\ returns a row vector of the minimum values.\n\ @@ -407,6 +408,7 @@ @result{} 3.1416 3.1416 4.0000 5.0000\n\ @end group\n\ @end example\n\ +\n\ @noindent\n\ compares each element of the range @code{2:5} with @code{pi}, and\n\ returns a row vector of the maximum values.\n\ @@ -566,7 +568,7 @@ @deftypefnx {Loadable Function} {} cummin (@var{x}, @var{dim})\n\ @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} cummin (@var{x})\n\ Return the cumulative minimum values along dimension @var{dim}. If @var{dim}\n\ -is unspecified it defaults to column-wise operation. For example,\n\ +is unspecified it defaults to column-wise operation. For example:\n\ \n\ @example\n\ @group\n\ @@ -577,12 +579,14 @@ \n\ \n\ The call\n\ +\n\ @example\n\ [w, iw] = cummin (x)\n\ @end example\n\ \n\ @noindent\n\ with @code{x} a vector, is equivalent to the following code:\n\ +\n\ @example\n\ @group\n\ w = iw = zeros (size (x));\n\ @@ -606,7 +610,7 @@ @deftypefnx {Loadable Function} {} cummax (@var{x}, @var{dim})\n\ @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} cummax (@var{x})\n\ Return the cumulative maximum values along dimension @var{dim}. If @var{dim}\n\ -is unspecified it defaults to column-wise operation. For example,\n\ +is unspecified it defaults to column-wise operation. For example:\n\ \n\ @example\n\ @group\n\ @@ -616,12 +620,14 @@ @end example\n\ \n\ The call\n\ +\n\ @example\n\ [w, iw] = cummax (x, dim)\n\ @end example\n\ \n\ @noindent\n\ with @code{x} a vector, is equivalent to the following code:\n\ +\n\ @example\n\ @group\n\ w = iw = zeros (size (x));\n\
--- a/src/DLD-FUNCTIONS/md5sum.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/md5sum.cc Sat Jul 31 11:18:11 2010 -0700 @@ -38,7 +38,7 @@ DEFUN_DLD (md5sum, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} md5sum (@var{file})\n\ +@deftypefn {Loadable Function} {} md5sum (@var{file})\n\ @deftypefnx {Loadable Function} {} md5sum (@var{str}, @var{opt})\n\ Calculates the MD5 sum of the file @var{file}. If the second parameter\n\ @var{opt} exists and is true, then calculate the MD5 sum of the\n\
--- a/src/DLD-FUNCTIONS/onCleanup.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/onCleanup.cc Sat Jul 31 11:18:11 2010 -0700 @@ -254,9 +254,9 @@ @deftypefn {Loadable Function} {@var{c} =} onCleanup (@var{action})\n\ Creates a special object that executes a given function upon destruction.\n\ If the object is copied to multiple variables (or cell or struct array elements)\n\ -or returned from a function, @var{action} will be executed after clearing the last\n\ -copy of the object. Note that if multiple local onCleanup variables are created, the\n\ -order in which they are called is unspecified.\n\ +or returned from a function, @var{action} will be executed after clearing the\n\ +last copy of the object. Note that if multiple local onCleanup variables are\n\ +created, the order in which they are called is unspecified.\n\ @seealso{unwind_protect}\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/qr.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/qr.cc Sat Jul 31 11:18:11 2010 -0700 @@ -74,7 +74,7 @@ DEFUN_DLD (qr, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{q}, @var{r}, @var{p}] =} qr (@var{a})\n\ +@deftypefn {Loadable Function} {[@var{q}, @var{r}, @var{p}] =} qr (@var{a})\n\ @deftypefnx {Loadable Function} {[@var{q}, @var{r}, @var{p}] =} qr (@var{a}, '0')\n\ @cindex QR factorization\n\ Compute the QR factorization of @var{a}, using standard @sc{lapack}\n\ @@ -772,9 +772,9 @@ @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization\n\ of @w{@var{A} + @var{u}*@var{v}'}, where @var{u} and @var{v} are\n\ column vectors (rank-1 update) or matrices with equal number of columns\n\ -(rank-k update). Notice that the latter case is done as a sequence of rank-1 updates;\n\ -thus, for k large enough, it will be both faster and more accurate to recompute\n\ -the factorization from scratch.\n\ +(rank-k update). Notice that the latter case is done as a sequence of rank-1\n\ +updates; thus, for k large enough, it will be both faster and more accurate to\n\ +recompute the factorization from scratch.\n\ \n\ The QR factorization supplied may be either full\n\ (Q is square) or economized (R is square).\n\
--- a/src/DLD-FUNCTIONS/quad.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/quad.cc Sat Jul 31 11:18:11 2010 -0700 @@ -176,7 +176,7 @@ DEFUN_DLD (quad, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {[@var{v}, @var{ier}, @var{nfun}, @var{err}] =} quad (@var{f}, @var{a}, @var{b}, @var{tol}, @var{sing})\n\ -Integrate a nonlinear function of one variable using Quadpack.\n\ +Integrate a nonlinear function of one variable using @sc{quadpack}.\n\ The first argument is the name of the function, the function handle or\n\ the inline function to call to compute the value of the integrand. It\n\ must have the form\n\
--- a/src/DLD-FUNCTIONS/qz.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/qz.cc Sat Jul 31 11:18:11 2010 -0700 @@ -304,6 +304,7 @@ @var{lambda}\n\ @end ifnottex\n\ of @math{(A - s B)}.\n\ +\n\ @item @code{[AA, BB, Q, Z, V, W, lambda] = qz (A, B)}\n\ \n\ Computes qz decomposition, generalized eigenvectors, and \n\ @@ -314,6 +315,7 @@ $$ AA = Q^T AZ, BB = Q^T BZ $$\n\ @end tex\n\ @ifnottex\n\ +\n\ @example\n\ @group\n\ \n\ @@ -323,6 +325,7 @@ \n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ with @var{Q} and @var{Z} orthogonal (unitary)= @var{I}\n\ \n\ @@ -331,7 +334,8 @@ As in form [2], but allows ordering of generalized eigenpairs\n\ for (e.g.) solution of discrete time algebraic Riccati equations.\n\ Form 3 is not available for complex matrices, and does not compute\n\ -the generalized eigenvectors @var{V}, @var{W}, nor the orthogonal matrix @var{Q}.\n\ +the generalized eigenvectors @var{V}, @var{W}, nor the orthogonal matrix\n\ +@var{Q}.\n\ \n\ @table @var\n\ @item opt\n\ @@ -342,10 +346,10 @@ = unordered (default) \n\ \n\ @item \"S\"\n\ -= small: leading block has all |lambda| <= 1 \n\ += small: leading block has all |lambda| @leq{} 1 \n\ \n\ @item \"B\"\n\ -= big: leading block has all |lambda| >= 1 \n\ += big: leading block has all |lambda| @geq{} 1 \n\ \n\ @item \"-\"\n\ = negative real part: leading block has all eigenvalues\n\
--- a/src/DLD-FUNCTIONS/rand.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/rand.cc Sat Jul 31 11:18:11 2010 -0700 @@ -354,7 +354,7 @@ \n\ @noindent\n\ You may also initialize the state vector from an arbitrary vector of\n\ -length <= 625 for @var{v}. This new state will be a hash based on the\n\ +length @leq{} 625 for @var{v}. This new state will be a hash based on the\n\ value of @var{v}, not @var{v} itself.\n\ \n\ By default, the generator is initialized from @code{/dev/urandom} if it is\n\ @@ -634,29 +634,40 @@ \n\ @table @asis\n\ @item @code{gamma (a, b)} for @code{a > -1}, @code{b > 0}\n\ +\n\ @example\n\ r = b * randg (a)\n\ @end example\n\ +\n\ @item @code{beta (a, b)} for @code{a > -1}, @code{b > -1}\n\ +\n\ @example\n\ @group\n\ r1 = randg (a, 1)\n\ r = r1 / (r1 + randg (b, 1))\n\ @end group\n\ @end example\n\ +\n\ @item @code{Erlang (a, n)}\n\ +\n\ @example\n\ r = a * randg (n)\n\ @end example\n\ +\n\ @item @code{chisq (df)} for @code{df > 0}\n\ +\n\ @example\n\ r = 2 * randg (df / 2)\n\ @end example\n\ +\n\ @item @code{t(df)} for @code{0 < df < inf} (use randn if df is infinite)\n\ +\n\ @example\n\ r = randn () / sqrt (2 * randg (df / 2) / df)\n\ @end example\n\ +\n\ @item @code{F (n1, n2)} for @code{0 < n1}, @code{0 < n2}\n\ +\n\ @example\n\ @group\n\ ## r1 equals 1 if n1 is infinite\n\ @@ -666,12 +677,16 @@ r = r1 / r2\n\n\ @end group\n\ @end example\n\ +\n\ @item negative @code{binomial (n, p)} for @code{n > 0}, @code{0 < p <= 1}\n\ +\n\ @example\n\ r = randp ((1 - p) / p * randg (n))\n\ @end example\n\ +\n\ @item non-central @code{chisq (df, L)}, for @code{df >= 0} and @code{L > 0}\n\ (use chisq if @code{L = 0})\n\ +\n\ @example\n\ @group\n\ r = randp (L / 2)\n\ @@ -679,13 +694,16 @@ r(df > 0) += 2 * randg (df(df > 0)/2)\n\ @end group\n\ @end example\n\ +\n\ @item @code{Dirichlet (a1, @dots{} ak)}\n\ +\n\ @example\n\ @group\n\ r = (randg (a1), @dots{}, randg (ak))\n\ r = r / sum (r)\n\ @end group\n\ @end example\n\ +\n\ @end table\n\ @seealso{rand, randn, rande, randp}\n\ @end deftypefn") @@ -871,17 +889,23 @@ and whether or not @var{l} is a scalar or a matrix.\n\ \n\ @table @asis\n\ -@item For scalar @var{l} <= 12, use direct method.\n\ -W.H. Press, et al., @cite{Numerical Recipes in C}, Cambridge University Press, 1992.\n\ +@item For scalar @var{l} @leq{} 12, use direct method.\n\ +W.H. Press, et al., @cite{Numerical Recipes in C},\n\ +Cambridge University Press, 1992.\n\ +\n\ @item For scalar @var{l} > 12, use rejection method.[1]\n\ -W.H. Press, et al., @cite{Numerical Recipes in C}, Cambridge University Press, 1992.\n\ -@item For matrix @var{l} <= 10, use inversion method.[2]\n\ +W.H. Press, et al., @cite{Numerical Recipes in C},\n\ +Cambridge University Press, 1992.\n\ +\n\ +@item For matrix @var{l} @leq{} 10, use inversion method.[2]\n\ E. Stadlober, et al., WinRand source code, available via FTP.\n\ +\n\ @item For matrix @var{l} > 10, use patchwork rejection method.\n\ E. Stadlober, et al., WinRand source code, available via FTP, or\n\ H. Zechner, @cite{Efficient sampling from continuous and discrete\n\ unimodal distributions}, Doctoral Dissertation, 156pp., Technical\n\ University Graz, Austria, 1994.\n\ +\n\ @item For @var{l} > 1e8, use normal approximation.\n\ L. Montanet, et al., @cite{Review of Particle Properties}, Physical Review\n\ D 50 p1284, 1994.\n\
--- a/src/DLD-FUNCTIONS/regexp.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/regexp.cc Sat Jul 31 11:18:11 2010 -0700 @@ -880,7 +880,7 @@ DEFUN_DLD (regexp, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{s}, @var{e}, @var{te}, @var{m}, @var{t}, @var{nm}] =} regexp (@var{str}, @var{pat})\n\ +@deftypefn {Loadable Function} {[@var{s}, @var{e}, @var{te}, @var{m}, @var{t}, @var{nm}] =} regexp (@var{str}, @var{pat})\n\ @deftypefnx {Loadable Function} {[@dots{}] =} regexp (@var{str}, @var{pat}, @var{opts}, @dots{})\n\ \n\ Regular expression string matching. Matches @var{pat} in @var{str} and\n\ @@ -893,27 +893,36 @@ @table @code\n\ @item .\n\ Match any character\n\ +\n\ @item * + ? @{@}\n\ Repetition operators, representing\n\ @table @code\n\ @item *\n\ Match zero or more times\n\ +\n\ @item +\n\ Match one or more times\n\ +\n\ @item ?\n\ Match zero or one times\n\ +\n\ @item @{@}\n\ Match range operator, which is of the form @code{@{@var{n}@}} to match exactly\n\ @var{n} times, @code{@{@var{m},@}} to match @var{m} or more times,\n\ @code{@{@var{m},@var{n}@}} to match between @var{m} and @var{n} times.\n\ @end table\n\ +\n\ @item [@dots{}] [^@dots{}]\n\ +\n\ List operators, where for example @code{[ab]c} matches @code{ac} and @code{bc}\n\ +\n\ @item ()\n\ Grouping operator\n\ +\n\ @item |\n\ Alternation operator. Match one of a choice of regular expressions. The\n\ alternatives must be delimited by the grouping operator @code{()} above\n\ +\n\ @item ^ $\n\ Anchoring operator. @code{^} matches the start of the string @var{str} and\n\ @code{$} the end\n\ @@ -927,22 +936,31 @@ @table @code\n\ @item \\b\n\ Match a word boundary\n\ +\n\ @item \\B\n\ Match within a word\n\ +\n\ @item \\w\n\ Matches any word character\n\ +\n\ @item \\W\n\ Matches any non word character\n\ +\n\ @item \\<\n\ Matches the beginning of a word\n\ +\n\ @item \\>\n\ Matches the end of a word\n\ +\n\ @item \\s\n\ Matches any whitespace character\n\ +\n\ @item \\S\n\ Matches any non whitespace character\n\ +\n\ @item \\d\n\ Matches any digit\n\ +\n\ @item \\D\n\ Matches any non-digit\n\ @end table\n\ @@ -992,19 +1010,26 @@ @table @asis\n\ @item matchcase\n\ Make the matching case sensitive.\n\ +\n\ @item ignorecase\n\ Make the matching case insensitive.\n\ +\n\ @item stringanchors\n\ Match the anchor characters at the beginning and end of the string.\n\ +\n\ @item lineanchors\n\ Match the anchor characters at the beginning and end of the line.\n\ +\n\ @item dotall\n\ The character @code{.} matches the newline character.\n\ +\n\ @item dotexceptnewline\n\ The character @code{.} matches all but the newline character.\n\ +\n\ @item freespacing\n\ The pattern can include arbitrary whitespace and comments starting with\n\ @code{#}.\n\ +\n\ @item literalspacing\n\ The pattern is taken literally.\n\ @end table\n\ @@ -1200,7 +1225,7 @@ DEFUN_DLD (regexpi, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{s}, @var{e}, @var{te}, @var{m}, @var{t}, @var{nm}] =} regexpi (@var{str}, @var{pat})\n\ +@deftypefn {Loadable Function} {[@var{s}, @var{e}, @var{te}, @var{m}, @var{t}, @var{nm}] =} regexpi (@var{str}, @var{pat})\n\ @deftypefnx {Loadable Function} {[@dots{}] =} regexpi (@var{str}, @var{pat}, @var{opts}, @dots{})\n\ \n\ Case insensitive regular expression string matching. Matches @var{pat} in\n\ @@ -1549,12 +1574,13 @@ DEFUN_DLD (regexprep, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{string} =} regexprep (@var{string}, @var{pat}, @var{repstr}, @var{options})\n\ +@deftypefn {Loadable Function} {@var{string} =} regexprep (@var{string}, @var{pat}, @var{repstr}, @var{options})\n\ Replace matches of @var{pat} in @var{string} with @var{repstr}.\n\ \n\ \n\ The replacement can contain @code{$i}, which substitutes\n\ for the ith set of parentheses in the match string. E.g.,\n\ +\n\ @example\n\ @group\n\ \n\ @@ -1562,6 +1588,7 @@ \n\ @end group\n\ @end example\n\ +\n\ returns \"Dunn, Bill\"\n\ \n\ @var{options} may be zero or more of\n\ @@ -1586,8 +1613,8 @@ Alternatively, use (?s) or (?-s) in the pattern.\n\ \n\ @item freespacing or literalspacing\n\ -Whether whitespace and # comments can be used to make the regular expression more readable.\n\ -Alternatively, use (?x) or (?-x) in the pattern.\n\ +Whether whitespace and # comments can be used to make the regular expression\n\ +more readable. Alternatively, use (?x) or (?-x) in the pattern.\n\ \n\ @end table\n\ @seealso{regexp,regexpi,strrep}\n\
--- a/src/DLD-FUNCTIONS/schur.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/schur.cc Sat Jul 31 11:18:11 2010 -0700 @@ -60,7 +60,7 @@ DEFUN_DLD (schur, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{s} =} schur (@var{a})\n\ +@deftypefn {Loadable Function} {@var{s} =} schur (@var{a})\n\ @deftypefnx {Loadable Function} {@var{s} =} schur (@var{a}, \"complex\")\n\ @deftypefnx {Loadable Function} {[@var{u}, @var{s}] =} schur (@var{a}, @var{opt})\n\ @cindex Schur decomposition\n\
--- a/src/DLD-FUNCTIONS/sparse.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/sparse.cc Sat Jul 31 11:18:11 2010 -0700 @@ -58,7 +58,7 @@ DEFUN_DLD (sparse, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{s} =} sparse (@var{a})\n\ +@deftypefn {Loadable Function} {@var{s} =} sparse (@var{a})\n\ @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})\n\ @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})\n\ @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\ @@ -71,8 +71,8 @@ of real of complex values @var{sv}, overall dimensions @var{m} and @var{n}\n\ of the sparse matrix. The argument @code{nzmax} is ignored but accepted for\n\ compatibility with @sc{matlab}. If @var{m} or @var{n} are not specified their\n\ -values are derived from the maximum index in the vectors @var{i} and @var{j}\n\ -as given by @code{@var{m} = max (@var{i})}, @code{@var{n} = max (@var{j})}.\n\ +values are derived from the maximum index in the vectors @var{i} and @var{j} as\n\ +given by @code{@var{m} = max (@var{i})}, @code{@var{n} = max (@var{j})}.\n\ \n\ @strong{Note}: if multiple values are specified with the same\n\ @var{i}, @var{j} indices, the corresponding values in @var{s} will\n\ @@ -214,7 +214,9 @@ \n\ @itemize\n\ @item @code{@var{s}(I:J) = @var{x}}\n\ +\n\ @item @code{@var{s}(:,I:J) = @var{x}}\n\ +\n\ @item @code{@var{s}(K:L,I:J) = @var{x}}\n\ @end itemize\n\ \n\ @@ -222,15 +224,19 @@ \n\ @itemize\n\ @item the assignment does not decrease nnz(@var{S}).\n\ +\n\ @item after the assignment, nnz(@var{S}) does not exceed @var{nz}.\n\ +\n\ @item no index is out of bounds.\n\ @end itemize\n\ \n\ -Partial movement of data may still occur, but in general the assignment will be more\n\ -memory and time-efficient under these circumstances. In particular, it is possible\n\ -to efficiently build a pre-allocated sparse matrix from contiguous block of columns.\n\ +Partial movement of data may still occur, but in general the assignment will be\n\ +more memory and time-efficient under these circumstances. In particular, it is\n\ +possible to efficiently build a pre-allocated sparse matrix from contiguous\n\ +block of columns.\n\ \n\ -The amount of pre-allocated memory for a given matrix may be queried using the function\n\ +The amount of pre-allocated memory for a given matrix may be queried using the\n\ +function\n\ @code{nzmax}.\n\ @seealso{nzmax, sparse}\n\ @end deftypefn")
--- a/src/DLD-FUNCTIONS/spparms.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/spparms.cc Sat Jul 31 11:18:11 2010 -0700 @@ -35,7 +35,7 @@ DEFUN_DLD (spparms, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} { } spparms ()\n\ +@deftypefn {Loadable Function} { } spparms ()\n\ @deftypefnx {Loadable Function} {@var{vals} =} spparms ()\n\ @deftypefnx {Loadable Function} {[@var{keys}, @var{vals}] =} spparms ()\n\ @deftypefnx {Loadable Function} {@var{val} =} spparms (@var{key})\n\ @@ -52,31 +52,43 @@ @table @code\n\ @item spumoni\n\ Printing level of debugging information of the solvers (default 0)\n\ +\n\ @item ths_rel\n\ Included for compatibility. Not used. (default 1)\n\ +\n\ @item ths_abs\n\ Included for compatibility. Not used. (default 1)\n\ +\n\ @item exact_d\n\ Included for compatibility. Not used. (default 0)\n\ +\n\ @item supernd\n\ Included for compatibility. Not used. (default 3)\n\ +\n\ @item rreduce\n\ Included for compatibility. Not used. (default 3)\n\ +\n\ @item wh_frac\n\ Included for compatibility. Not used. (default 0.5)\n\ +\n\ @item autommd\n\ Flag whether the LU/QR and the '\\' and '/' operators will automatically\n\ use the sparsity preserving mmd functions (default 1)\n\ +\n\ @item autoamd\n\ Flag whether the LU and the '\\' and '/' operators will automatically\n\ use the sparsity preserving amd functions (default 1)\n\ +\n\ @item piv_tol\n\ The pivot tolerance of the @sc{umfpack} solvers (default 0.1)\n\ +\n\ @item sym_tol\n\ The pivot tolerance of the @sc{umfpack} symmetric solvers (default 0.001)\n\ +\n\ @item bandden\n\ The density of non-zero elements in a banded matrix before it is treated\n\ by the @sc{lapack} banded solvers (default 0.5)\n\ +\n\ @item umfpack\n\ Flag whether the @sc{umfpack} or mmd solvers are used for the LU, '\\' and\n\ '/' operations (default 1)\n\
--- a/src/DLD-FUNCTIONS/str2double.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/str2double.cc Sat Jul 31 11:18:11 2010 -0700 @@ -202,12 +202,17 @@ A complex number should be in one of the formats:\n\ \n\ @itemize\n\ -@item a + bi\n\ -@item a + b*i\n\ -@item a + i*b\n\ -@item bi + a\n\ -@item b*i + a\n\ -@item i*b + a\n\ +@item a + bi\n\ +\n\ +@item a + b*i\n\ +\n\ +@item a + i*b\n\ +\n\ +@item bi + a\n\ +\n\ +@item b*i + a\n\ +\n\ +@item i*b + a\n\ @end itemize\n\ \n\ It is also possible to use @code{j} instead of @code{i}, or write just\n\ @@ -215,8 +220,8 @@ @code{a} and @code{b} should be real numbers\n\ in a standard format.\n\ @var{s} can also be a character matrix, in which case the conversion is repeated\n\ -for each row, or a cell array of strings, in which case each element is converted\n\ -and an array of the same dimensions is returned.\n\ +for each row, or a cell array of strings, in which case each element is\n\ +converted and an array of the same dimensions is returned.\n\ @end deftypefn") { octave_value retval;
--- a/src/DLD-FUNCTIONS/strfind.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/strfind.cc Sat Jul 31 11:18:11 2010 -0700 @@ -147,7 +147,7 @@ DEFUN_DLD (strfind, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{idx} =} strfind (@var{str}, @var{pattern})\n\ +@deftypefn {Loadable Function} {@var{idx} =} strfind (@var{str}, @var{pattern})\n\ @deftypefnx {Loadable Function} {@var{idx} =} strfind (@var{cellstr}, @var{pattern})\n\ Search for @var{pattern} in the string @var{str} and return the\n\ starting index of every such occurrence in the vector @var{idx}.\n\ @@ -323,10 +323,10 @@ DEFUN_DLD (strrep, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} strrep (@var{s}, @var{x}, @var{y})\n\ +@deftypefn {Loadable Function} {} strrep (@var{s}, @var{x}, @var{y})\n\ @deftypefnx {Loadable Function} {} strrep (@var{s}, @var{x}, @var{y}, \"overlaps\", @var{o})\n\ Replace all occurrences of the substring @var{x} of the string @var{s}\n\ -with the string @var{y} and return the result. For example,\n\ +with the string @var{y} and return the result. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/sub2ind.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/sub2ind.cc Sat Jul 31 11:18:11 2010 -0700 @@ -63,7 +63,7 @@ DEFUN_DLD (sub2ind, args, , "-*- texinfo -*-\n\ -@deftypefn {Function File} {@var{ind} =} sub2ind (@var{dims}, @var{i}, @var{j})\n\ +@deftypefn {Function File} {@var{ind} =} sub2ind (@var{dims}, @var{i}, @var{j})\n\ @deftypefnx {Function File} {@var{ind} =} sub2ind (@var{dims}, @var{s1}, @var{s2}, @dots{}, @var{sN})\n\ Convert subscripts into a linear index.\n\ \n\ @@ -178,6 +178,7 @@ The following example shows how to convert the linear index @code{8}\n\ in a 3-by-3 matrix into a subscript. The matrix is linearly indexed\n\ moving from one column to next, filling up all rows in each column.\n\ +\n\ @example\n\ @group\n\ [r, c] = ind2sub ([3, 3], 8)\n\
--- a/src/DLD-FUNCTIONS/svd.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/svd.cc Sat Jul 31 11:18:11 2010 -0700 @@ -57,6 +57,7 @@ @example\n\ A = U*S*V'\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ The function @code{svd} normally returns only the vector of singular values.\n\
--- a/src/DLD-FUNCTIONS/syl.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/syl.cc Sat Jul 31 11:18:11 2010 -0700 @@ -47,8 +47,9 @@ @example\n\ A X + X B + C = 0\n\ @end example\n\ +\n\ @end ifnottex\n\ -using standard @sc{lapack} subroutines. For example,\n\ +using standard @sc{lapack} subroutines. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/symbfact.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/symbfact.cc Sat Jul 31 11:18:11 2010 -0700 @@ -59,8 +59,10 @@ \n\ @item col\n\ Factorize @code{@var{s}' * @var{s}}.\n\ +\n\ @item row\n\ Factorize @code{@var{s} * @var{s}'}.\n\ +\n\ @item lo\n\ Factorize @code{@var{s}'}\n\ @end table\n\
--- a/src/DLD-FUNCTIONS/time.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/time.cc Sat Jul 31 11:18:11 2010 -0700 @@ -106,7 +106,7 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} gmtime (@var{t})\n\ Given a value returned from time (or any non-negative integer),\n\ -return a time structure corresponding to CUT. For example,\n\ +return a time structure corresponding to CUT@. For example:\n\ \n\ @example\n\ @group\n\ @@ -234,7 +234,7 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} mktime (@var{tm_struct})\n\ Convert a time structure corresponding to the local time to the number\n\ -of seconds since the epoch. For example,\n\ +of seconds since the epoch. For example:\n\ \n\ @example\n\ @group\n\ @@ -292,7 +292,7 @@ number, padding can be changed or inhibited by following the @samp{%}\n\ with one of the modifiers described below. Unknown field specifiers are\n\ copied as normal characters. All other characters are copied to the\n\ -output without change. For example,\n\ +output without change. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/tril.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/tril.cc Sat Jul 31 11:18:11 2010 -0700 @@ -362,7 +362,7 @@ The absolute value of @var{k} must not be greater than the number of\n\ sub- or super-diagonals.\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\
--- a/src/DLD-FUNCTIONS/typecast.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/typecast.cc Sat Jul 31 11:18:11 2010 -0700 @@ -112,14 +112,16 @@ @end group\n\ @end example\n\ \n\ -the last two are reserved for @var{class}; they indicate that a complex-valued result\n\ -is requested. Complex arrays are stored in memory as consecutive pairs of real numbers.\n\ -The sizes of integer types are given by their bit counts. Both logical and char are typically\n\ -one byte wide; however, this is not guaranteed by C++. If your system is IEEE conformant,\n\ -single and double should be 4 bytes and 8 bytes wide, respectively.\n\ -\"logical\" is not allowed for @var{class}.\n\ -If the input is a row vector, the return value is a row vector, otherwise it is a column vector.\n\ -If the bit length of @var{x} is not divisible by that of @var{class}, an error occurs.\n\ +the last two are reserved for @var{class}; they indicate that a complex-valued\n\ +result is requested. Complex arrays are stored in memory as consecutive pairs\n\ +of real numbers. The sizes of integer types are given by their bit counts. \n\ +Both logical and char are typically one byte wide; however, this is not\n\ +guaranteed by C++. If your system is IEEE conformant, single and double should\n\ +be 4 bytes and 8 bytes wide, respectively. \"logical\" is not allowed for\n\ +@var{class}. If the input is a row vector, the return value is a row vector,\n\ +otherwise it is a column vector. If the bit length of @var{x} is not divisible\n\ +by that of\n\ +@var{class}, an error occurs.\n\ \n\ An example of the use of typecast on a little-endian machine is\n\ \n\ @@ -272,8 +274,8 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{y} =} bitpack (@var{x}, @var{class})\n\ Returns a new array @var{y} resulting from interpreting a logical array @var{x}\n\ -as raw bit pattern for data of the numeric class @var{class}. @var{class} must be\n\ -one of the built-in numeric classes:\n\ +as raw bit pattern for data of the numeric class @var{class}. @var{class} must\n\ +be one of the built-in numeric classes:\n\ \n\ @example\n\ @group\n\ @@ -291,10 +293,12 @@ @end group\n\ @end example\n\ \n\ -The number of elements of @var{x} should be divisible by the bit length of @var{class}.\n\ -If it is not, excess bits are discarded. Bits come in increasing order of significance, i.e.\n\ +The number of elements of @var{x} should be divisible by the bit length of\n\ +@var{class}. If it is not, excess bits are discarded. Bits come in increasing\n\ +order of significance, i.e.\n\ @code{x(1)} is bit 0, @code{x(2)} is bit 1, etc.\n\ -The result is a row vector if @var{x} is a row vector, otherwise it is a column vector.\n\ +The result is a row vector if @var{x} is a row vector, otherwise it is a column\n\ +vector.\n\ @seealso{bitunpack,typecast,bitget,bitset}\n\ @end deftypefn") { @@ -398,7 +402,8 @@ @end group\n\ @end example\n\ \n\ -The result is a row vector if @var{x} is a row vector, otherwise it is a column vector.\n\ +The result is a row vector if @var{x} is a row vector, otherwise it is a column\n\ +vector.\n\ @seealso{bitpack,typecast,bitget,bitset}\n\ @end deftypefn") {
--- a/src/DLD-FUNCTIONS/urlwrite.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/DLD-FUNCTIONS/urlwrite.cc Sat Jul 31 11:18:11 2010 -0700 @@ -682,12 +682,12 @@ DEFUN_DLD (urlwrite, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} urlwrite (@var{url}, @var{localfile})\n\ +@deftypefn {Loadable Function} {} urlwrite (@var{url}, @var{localfile})\n\ @deftypefnx {Loadable Function} {@var{f} =} urlwrite (@var{url}, @var{localfile})\n\ @deftypefnx {Loadable Function} {[@var{f}, @var{success}] =} urlwrite (@var{url}, @var{localfile})\n\ @deftypefnx {Loadable Function} {[@var{f}, @var{success}, @var{message}] =} urlwrite (@var{url}, @var{localfile})\n\ Download a remote file specified by its @var{url} and save it as\n\ -@var{localfile}. For example,\n\ +@var{localfile}. For example:\n\ \n\ @example\n\ @group\n\ @@ -848,12 +848,12 @@ DEFUN_DLD (urlread, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{s} =} urlread (@var{url})\n\ +@deftypefn {Loadable Function} {@var{s} =} urlread (@var{url})\n\ @deftypefnx {Loadable Function} {[@var{s}, @var{success}] =} urlread (@var{url})\n\ @deftypefnx {Loadable Function} {[@var{s}, @var{success}, @var{message}] =} urlread (@var{url})\n\ @deftypefnx {Loadable Function} {[@dots{}] =} urlread (@var{url}, @var{method}, @var{param})\n\ Download a remote file specified by its @var{url} and return its content\n\ -in string @var{s}. For example,\n\ +in string @var{s}. For example:\n\ \n\ @example\n\ s = urlread (\"ftp://ftp.octave.org/pub/octave/README\");\n\ @@ -866,7 +866,7 @@ \n\ This function uses libcurl. Curl supports, among others, the HTTP,\n\ FTP and FILE protocols. Username and password may be specified in the\n\ -URL. For example,\n\ +URL@. For example:\n\ \n\ @example\n\ s = urlread (\"http://user:password@@example.com/file.txt\");\n\ @@ -875,7 +875,7 @@ GET and POST requests can be specified by @var{method} and @var{param}.\n\ The parameter @var{method} is either @samp{get} or @samp{post}\n\ and @var{param} is a cell array of parameter and value pairs.\n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -967,7 +967,7 @@ DEFUN_DLD (__ftp__, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} __ftp__ (@var{handle}, @var{host})\n\ +@deftypefn {Loadable Function} {} __ftp__ (@var{handle}, @var{host})\n\ @deftypefnx {Loadable Function} {} __ftp__ (@var{handle}, @var{host}, @var{username}, @var{password})\n\ Undocumented internal function\n\ @end deftypefn")
--- a/src/bitfcns.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/bitfcns.cc Sat Jul 31 11:18:11 2010 -0700 @@ -407,7 +407,7 @@ DEFUN (bitshift, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} bitshift (@var{a}, @var{k})\n\ +@deftypefn {Built-in Function} {} bitshift (@var{a}, @var{k})\n\ @deftypefnx {Built-in Function} {} bitshift (@var{a}, @var{k}, @var{n})\n\ Return a @var{k} bit shift of @var{n}-digit unsigned\n\ integers in @var{a}. A positive @var{k} leads to a left shift.\n\ @@ -536,18 +536,25 @@ @table @code\n\ @item int8\n\ signed 8-bit integer.\n\ +\n\ @item int16\n\ signed 16-bit integer.\n\ +\n\ @item int32\n\ signed 32-bit integer.\n\ +\n\ @item int64\n\ signed 64-bit integer.\n\ +\n\ @item uint8\n\ unsigned 8-bit integer.\n\ +\n\ @item uint16\n\ unsigned 16-bit integer.\n\ +\n\ @item uint32\n\ unsigned 32-bit integer.\n\ +\n\ @item uint64\n\ unsigned 64-bit integer.\n\ @end table\n\ @@ -599,18 +606,25 @@ @table @code\n\ @item int8\n\ signed 8-bit integer.\n\ +\n\ @item int16\n\ signed 16-bit integer.\n\ +\n\ @item int32\n\ signed 32-bit integer.\n\ +\n\ @item int64\n\ signed 64-bit integer.\n\ +\n\ @item uint8\n\ unsigned 8-bit integer.\n\ +\n\ @item uint16\n\ unsigned 16-bit integer.\n\ +\n\ @item uint32\n\ unsigned 32-bit integer.\n\ +\n\ @item uint64\n\ unsigned 64-bit integer.\n\ @end table\n\ @@ -658,7 +672,7 @@ @deftypefn {Built-in Function} {} sizemax ()\n\ Return the largest value that is allowed as the size of an array.\n\ If Octave is compiled with 64-bit indexing, the result is of class int64,\n\ -otherwise it is of class int32. It will be a tiny bit lower than the maximum\n\ +otherwise it is of class int32. It will be a tiny bit lower than the maximum\n\ allowable value for that type, as reported by intmax.\n\ @seealso{intmax}\n\ @end deftypefn")
--- a/src/data.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/data.cc Sat Jul 31 11:18:11 2010 -0700 @@ -147,7 +147,7 @@ \n\ For a matrix argument, return a row vector of ones and\n\ zeros with each element indicating whether any of the elements of the\n\ -corresponding column of the matrix are nonzero. For example,\n\ +corresponding column of the matrix are nonzero. For example:\n\ \n\ @example\n\ @group\n\ @@ -157,7 +157,7 @@ @end example\n\ \n\ If the optional argument @var{dim} is supplied, work along dimension\n\ -@var{dim}. For example,\n\ +@var{dim}. For example:\n\ \n\ @example\n\ @group\n\ @@ -337,7 +337,7 @@ DEFUN (hypot, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} hypot (@var{x}, @var{y})\n\ +@deftypefn {Built-in Function} {} hypot (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} hypot (@var{x}, @var{y}, @var{z}, @dots{})\n\ Compute the element-by-element square root of the sum of the squares of\n\ @var{x} and @var{y}. This is equivalent to\n\ @@ -345,6 +345,7 @@ avoids overflows for large values of @var{x} or @var{y}.\n\ @code{hypot} can also be called with more than 2 arguments; in this case,\n\ the arguments are accumulated from left to right:\n\ +\n\ @example\n\ @group\n\ hypot (hypot (@var{x}, @var{y}), @var{z})\n\ @@ -399,7 +400,7 @@ DEFUN (log2, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} log2 (@var{x})\n\ +@deftypefn {Mapping Function} {} log2 (@var{x})\n\ @deftypefnx {Mapping Function} {[@var{f}, @var{e}] =} log2 (@var{x})\n\ Compute the base-2 logarithm of each element of @var{x}.\n\ \n\ @@ -499,7 +500,7 @@ DEFUN (rem, args, , "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} rem (@var{x}, @var{y})\n\ +@deftypefn {Mapping Function} {} rem (@var{x}, @var{y})\n\ @deftypefnx {Mapping Function} {} fmod (@var{x}, @var{y})\n\ Return the remainder of the division @code{@var{x} / @var{y}}, computed \n\ using the expression\n\ @@ -1223,7 +1224,7 @@ second argument is optional. If it is positive, the vector is placed on\n\ the @var{k}-th super-diagonal. If it is negative, it is placed on the\n\ @var{-k}-th sub-diagonal. The default value of @var{k} is 0, and the\n\ -vector is placed on the main diagonal. For example,\n\ +vector is placed on the main diagonal. For example:\n\ \n\ @example\n\ @group\n\ @@ -1715,6 +1716,7 @@ @var{dim} can be larger than the dimensions of the N-d array objects\n\ and the result will thus have @var{dim} dimensions as the\n\ following example shows:\n\ +\n\ @example\n\ @group\n\ cat (4, ones(2, 2), zeros (2, 2))\n\ @@ -1937,6 +1939,7 @@ @example\n\ ipermute (permute (a, perm), perm)\n\ @end example\n\ +\n\ returns the original array @var{a}.\n\ @seealso{permute}\n\ @end deftypefn") @@ -1968,6 +1971,7 @@ Return the number of dimensions of @var{a}.\n\ For any array, the result will always be larger than or equal to 2.\n\ Trailing singleton dimensions are not counted.\n\ +\n\ @example\n\ @group\n\ ndims (ones (4, 1, 2, 1)\n\ @@ -1993,9 +1997,11 @@ Return the number of elements in the object @var{a}.\n\ Optionally, if indices @var{idx1}, @var{idx2}, @dots{} are supplied,\n\ return the number of elements that would result from the indexing\n\ +\n\ @example\n\ @var{a}(@var{idx1}, @var{idx2}, @dots{})\n\ @end example\n\ +\n\ This method is also called when an object appears as lvalue with cs-list\n\ indexing, i.e., @code{object@{@dots{}@}} or @code{object(@dots{}).field}.\n\ @seealso{size}\n\ @@ -2027,7 +2033,7 @@ With one input argument and one output argument, the result is returned\n\ in a row vector. If there are multiple output arguments, the number of\n\ rows is assigned to the first, and the number of columns to the second,\n\ -etc. For example,\n\ +etc. For example:\n\ \n\ @example\n\ @group\n\ @@ -2041,7 +2047,7 @@ @end example\n\ \n\ If given a second argument, @code{size} will return the size of the\n\ -corresponding dimension. For example\n\ +corresponding dimension. For example,\n\ \n\ @example\n\ @group\n\ @@ -2227,7 +2233,7 @@ \n\ If the optional argument 'native' is given, then the sum is performed\n\ in the same type as the original argument, rather than in the default\n\ -double type. For example\n\ +double type. For example:\n\ \n\ @example\n\ @group\n\ @@ -2237,13 +2243,14 @@ @result{} true\n\ @end group\n\ @end example\n\ +\n\ \n\ On the contrary, if 'double' is given, the sum is performed in double precision\n\ even for single precision inputs.\n\ \n\ For double precision inputs, 'extra' indicates that a more accurate algorithm\n\ -than straightforward summation is to be used. For single precision inputs, 'extra' is\n\ -the same as 'double'. Otherwise, 'extra' has no effect.\n\ +than straightforward summation is to be used. For single precision inputs,\n\ +'extra' is the same as 'double'. Otherwise, 'extra' has no effect.\n\ @seealso{cumsum, sumsq, prod}\n\ @end deftypefn") { @@ -2440,9 +2447,11 @@ is omitted, it defaults to the first non-singleton dimension.\n\ \n\ This function is conceptually equivalent to computing\n\ +\n\ @example\n\ sum (x .* conj (x), dim)\n\ @end example\n\ +\n\ but it uses less memory and avoids calling @code{conj} if @var{x} is real.\n\ @seealso{sum}\n\ @end deftypefn") @@ -2884,8 +2893,8 @@ DEFUN (isnumeric, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isnumeric (@var{x})\n\ -Return nonzero if @var{x} is a numeric object, i.e., an integer, real or complex array.\n\ -Logical and character arrays are not considered to be numeric.\n\ +Return nonzero if @var{x} is a numeric object, i.e., an integer, real or complex\n\ +array. Logical and character arrays are not considered to be numeric.\n\ @seealso{ischar, islogical, isinteger}\n\ @end deftypefn") { @@ -3385,7 +3394,7 @@ @end example\n\ \n\ The optional argument @var{class} specifies the class of the return array\n\ -and defaults to double. For example\n\ +and defaults to double. For example:\n\ \n\ @example\n\ val = ones (n,m, \"uint8\")\n\ @@ -3428,7 +3437,7 @@ given dimensions.\n\ \n\ The optional argument @var{class} specifies the class of the return array\n\ -and defaults to double. For example\n\ +and defaults to double. For example:\n\ \n\ @example\n\ val = zeros (n,m, \"uint8\")\n\ @@ -3471,6 +3480,7 @@ Infinity is produced when results are too large to be represented using the\n\ the IEEE floating point format for numbers. Two common examples which\n\ produce infinity are division by zero and overflow.\n\ +\n\ @example\n\ @group\n\ [1/0 e^800]\n\ @@ -4046,7 +4056,7 @@ DEFUN (eye, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} eye (@var{x})\n\ +@deftypefn {Built-in Function} {} eye (@var{x})\n\ @deftypefnx {Built-in Function} {} eye (@var{n}, @var{m})\n\ @deftypefnx {Built-in Function} {} eye (@dots{}, @var{class})\n\ Return an identity matrix. If invoked with a single scalar argument,\n\ @@ -4054,7 +4064,7 @@ supply two scalar arguments, @code{eye} takes them to be the number of\n\ rows and columns. If given a vector with two elements, @code{eye} uses\n\ the values of the elements as the number of rows and columns,\n\ -respectively. For example,\n\ +respectively. For example:\n\ \n\ @example\n\ @group\n\ @@ -4289,7 +4299,7 @@ DEFUN (resize, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} resize (@var{x}, @var{m})\n\ +@deftypefn {Built-in Function} {} resize (@var{x}, @var{m})\n\ @deftypefnx {Built-in Function} {} resize (@var{x}, @var{m}, @var{n})\n\ @deftypefnx {Built-in Function} {} resize (@var{x}, @var{m}, @var{n}, @dots{})\n\ Resize @var{x} cutting off elements as necessary.\n\ @@ -4376,13 +4386,13 @@ DEFUN (reshape, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} reshape (@var{a}, @var{m}, @var{n}, @dots{})\n\ +@deftypefn {Built-in Function} {} reshape (@var{a}, @var{m}, @var{n}, @dots{})\n\ @deftypefnx {Built-in Function} {} reshape (@var{a}, @var{size})\n\ Return a matrix with the given dimensions whose elements are taken\n\ from the matrix @var{a}. The elements of the matrix are accessed in\n\ column-major order (like Fortran arrays are stored).\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -4562,7 +4572,8 @@ DEFUN (full, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{FM} =} full (@var{SM})\n\ - returns a full storage matrix from a sparse, diagonal, permutation matrix or a range.\n\ + returns a full storage matrix from a sparse, diagonal, permutation matrix or a\n\ +range.\n\ @seealso{sparse}\n\ @end deftypefn") { @@ -4898,7 +4909,7 @@ DEFUN (plus, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} plus (@var{x}, @var{y})\n\ +@deftypefn {Built-in Function} {} plus (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} plus (@var{x1}, @var{x2}, @dots{})\n\ This function is equivalent to @code{x + y}.\n\ If more arguments are given, the summation is applied\n\ @@ -4926,7 +4937,7 @@ DEFUN (mtimes, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} mtimes (@var{x}, @var{y})\n\ +@deftypefn {Built-in Function} {} mtimes (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} mtimes (@var{x1}, @var{x2}, @dots{})\n\ This function is equivalent to @code{x * y}.\n\ If more arguments are given, the multiplication is applied\n\ @@ -5026,7 +5037,7 @@ DEFUN (times, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} times (@var{x}, @var{y})\n\ +@deftypefn {Built-in Function} {} times (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} times (@var{x1}, @var{x2}, @dots{})\n\ This function is equivalent to @code{x .* y}.\n\ If more arguments are given, the multiplication is applied\n\ @@ -5072,7 +5083,7 @@ DEFUN (and, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} and (@var{x}, @var{y})\n\ +@deftypefn {Built-in Function} {} and (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} and (@var{x1}, @var{x2}, @dots{})\n\ This function is equivalent to @code{x & y}.\n\ If more arguments are given, the logical and is applied\n\ @@ -5091,7 +5102,7 @@ DEFUN (or, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} or (@var{x}, @var{y})\n\ +@deftypefn {Built-in Function} {} or (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} or (@var{x1}, @var{x2}, @dots{})\n\ This function is equivalent to @code{x | y}.\n\ If more arguments are given, the logical or is applied\n\ @@ -5112,7 +5123,7 @@ DEFUN (tic, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} tic ()\n\ +@deftypefn {Built-in Function} {} tic ()\n\ @deftypefnx {Built-in Function} {} toc ()\n\ Set or check a wall-clock timer. Calling @code{tic} without an\n\ output argument sets the timer. Subsequent calls to @code{toc}\n\ @@ -5148,7 +5159,7 @@ should use the @code{cputime} function instead. The @code{tic} and\n\ @code{toc} functions report the actual wall clock time that elapsed\n\ between the calls. This may include time spent processing other jobs or\n\ -doing nothing at all. For example,\n\ +doing nothing at all. For example:\n\ \n\ @example\n\ @group\n\ @@ -5286,14 +5297,14 @@ DEFUN (sort, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\ +@deftypefn {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\ @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})\n\ @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})\n\ @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})\n\ Return a copy of @var{x} with the elements arranged in increasing\n\ order. For matrices, @code{sort} orders the elements in each column.\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -5306,7 +5317,7 @@ \n\ The @code{sort} function may also be used to produce a matrix\n\ containing the original row indices of the elements in the sorted\n\ -matrix. For example,\n\ +matrix. For example:\n\ \n\ @example\n\ @group\n\ @@ -5679,7 +5690,7 @@ DEFUN (issorted, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} issorted (@var{a}, @var{mode})\n\ +@deftypefn {Built-in Function} {} issorted (@var{a}, @var{mode})\n\ @deftypefnx {Built-in Function} {} issorted (@var{a}, @code{\"rows\"}, @var{mode})\n\ Returns true if the array is sorted according to @var{mode}, which\n\ may be either \"ascending\", \"descending\", or \"either\". By default,\n\ @@ -5787,17 +5798,18 @@ DEFUN (nth_element, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} nth_element (@var{x}, @var{n})\n\ +@deftypefn {Built-in Function} {} nth_element (@var{x}, @var{n})\n\ @deftypefnx {Built-in Function} {} nth_element (@var{x}, @var{n}, @var{dim})\n\ -Select the n-th smallest element of a vector, using the ordering defined by @code{sort}.\n\ -In other words, the result is equivalent to @code{sort(@var{x})(@var{n})}.\n\ +Select the n-th smallest element of a vector, using the ordering defined by\n\ +@code{sort}. In other words, the result is equivalent to\n\ +@code{sort(@var{x})(@var{n})}.\n\ @var{n} can also be a contiguous range, either ascending @code{l:u}\n\ or descending @code{u:-1:l}, in which case a range of elements is returned.\n\ -If @var{x} is an array, @code{nth_element} operates along the dimension defined by @var{dim},\n\ -or the first non-singleton dimension if @var{dim} is not given.\n\ +If @var{x} is an array, @code{nth_element} operates along the dimension defined\n\ +by @var{dim}, or the first non-singleton dimension if @var{dim} is not given.\n\ \n\ -nth_element encapsulates the C++ standard library algorithms nth_element and partial_sort.\n\ -On average, the complexity of the operation is O(M*log(K)), where\n\ +nth_element encapsulates the C++ standard library algorithms nth_element and\n\ +partial_sort. On average, the complexity of the operation is O(M*log(K)), where\n\ @code{M = size(@var{x}, @var{dim})} and @code{K = length (@var{n})}.\n\ This function is intended for cases where the ratio K/M is small; otherwise,\n\ it may be better to use @code{sort}.\n\ @@ -6189,17 +6201,20 @@ DEFUN (merge, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} merge (@var{mask}, @var{tval}, @var{fval})\n\ +@deftypefn {Built-in Function} {} merge (@var{mask}, @var{tval}, @var{fval})\n\ @deftypefnx {Built-in Function} {} ifelse (@var{mask}, @var{tval}, @var{fval})\n\ Merges elements of @var{true_val} and @var{false_val}, depending on the value of\n\ @var{mask}. If @var{mask} is a logical scalar, the other two arguments can be\n\ -arbitrary values. Otherwise, @var{mask} must be a logical array, and @var{tval},\n\ +arbitrary values. Otherwise, @var{mask} must be a logical array, and\n\ +@var{tval},\n\ @var{fval} should be arrays of matching class, or cell arrays.\n\ In the scalar mask case, @var{tval} is returned if @var{mask} is true, otherwise\n\ @var{fval} is returned.\n\ \n\ In the array mask case, both @var{tval} and @var{fval} must be either scalars or\n\ -arrays with dimensions equal to @var{mask}. The result is constructed as follows:\n\ +arrays with dimensions equal to @var{mask}. The result is constructed as\n\ +follows: \n\ +\n\ @example\n\ @group\n\ result(mask) = tval(mask);\n\ @@ -6543,10 +6558,12 @@ Conceptually the result is calculated as follows:\n\ \n\ @example\n\ +@group\n\ y = [];\n\ for i = 1:columns (@var{r})\n\ y = [y, @var{x}(@var{r}(1,i)*ones(1, @var{r}(2,i)))];\n\ endfor\n\ +@end group\n\ @end example\n\ @seealso{repmat}\n\ @end deftypefn")
--- a/src/debug.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/debug.cc Sat Jul 31 11:18:11 2010 -0700 @@ -487,6 +487,7 @@ @item func\n\ String representing the function name. When already in debug\n\ mode this should be left out and only the line should be given.\n\ +\n\ @item line\n\ Line number you would like the breakpoint to be set on. Multiple\n\ lines might be given as separate arguments or as a vector.\n\ @@ -519,6 +520,7 @@ @item func\n\ String representing the function name. When already in debug\n\ mode this should be left out and only the line should be given.\n\ +\n\ @item line\n\ Line number where you would like to remove the breakpoint. Multiple\n\ lines might be given as separate arguments or as a vector.\n\
--- a/src/defaults.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/defaults.cc Sat Jul 31 11:18:11 2010 -0700 @@ -396,12 +396,12 @@ DEFUN (EDITOR, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} EDITOR ()\n\ +@deftypefn {Built-in Function} {@var{val} =} EDITOR ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} EDITOR (@var{new_val})\n\ Query or set the internal variable that specifies the editor to\n\ use with the @code{edit_history} command. The default value is taken from\n\ -the environment variable @w{@code{EDITOR}} when Octave starts. If the\n\ -environment variable is not initialized, @w{@code{EDITOR}} will be set to\n\ +the environment variable @w{@env{EDITOR}} when Octave starts. If the\n\ +environment variable is not initialized, @w{@env{EDITOR}} will be set to\n\ @code{\"emacs\"}.\n\ @seealso{edit_history}\n\ @end deftypefn") @@ -411,17 +411,17 @@ DEFUN (EXEC_PATH, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} EXEC_PATH ()\n\ +@deftypefn {Built-in Function} {@var{val} =} EXEC_PATH ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} EXEC_PATH (@var{new_val})\n\ Query or set the internal variable that specifies a colon separated\n\ list of directories to search when executing external programs.\n\ Its initial value is taken from the environment variable\n\ -@w{@code{OCTAVE_EXEC_PATH}} (if it exists) or @code{PATH}, but that\n\ +@w{@env{OCTAVE_EXEC_PATH}} (if it exists) or @env{PATH}, but that\n\ value can be overridden by the command line argument\n\ -@code{--exec-path PATH}. At startup, an additional set of\n\ +@option{--exec-path PATH}. At startup, an additional set of\n\ directories (including the shell PATH) is appended to the path\n\ specified in the environment or on the command line. If you use\n\ -the @w{@code{EXEC_PATH}} function to modify the path, you should take\n\ +the @w{@env{EXEC_PATH}} function to modify the path, you should take\n\ care to preserve these additional directories.\n\ @end deftypefn") { @@ -437,7 +437,7 @@ DEFUN (IMAGE_PATH, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} IMAGE_PATH ()\n\ +@deftypefn {Built-in Function} {@var{val} =} IMAGE_PATH ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} IMAGE_PATH (@var{new_val})\n\ Query or set the internal variable that specifies a colon separated\n\ list of directories in which to search for image files.\n\
--- a/src/dirfns.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/dirfns.cc Sat Jul 31 11:18:11 2010 -0700 @@ -101,7 +101,7 @@ @end example\n\ \n\ @noindent\n\ -Changes the current working directory to @file{~/octave}. If the\n\ +changes the current working directory to @file{~/octave}. If the\n\ directory does not exist, an error message is printed and the working\n\ directory is not changed.\n\ @seealso{mkdir, rmdir, dir}\n\ @@ -200,7 +200,7 @@ DEFUNX ("mkdir", Fmkdir, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{dir})\n\ +@deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{dir})\n\ @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{parent}, @var{dir})\n\ Create a directory named @var{dir} in the directory @var{parent}.\n\ \n\ @@ -283,7 +283,7 @@ DEFUNX ("rmdir", Frmdir, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir})\n\ +@deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir})\n\ @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir}, @code{\"s\"})\n\ Remove the directory named @var{dir}.\n\ \n\ @@ -554,6 +554,7 @@ matches any string, including the null string,\n\ @itemx ?\n\ matches any single character, and\n\ +\n\ @item [@dots{}]\n\ matches any of the enclosed characters.\n\ @end table\n\ @@ -646,7 +647,7 @@ @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\ Return 1 or zero for each element of @var{string} that matches any of\n\ the elements of the string array @var{pattern}, using the rules of\n\ -filename pattern matching. For example,\n\ +filename pattern matching. For example:\n\ \n\ @example\n\ @group\n\ @@ -680,7 +681,7 @@ DEFUN (filesep, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} filesep ()\n\ +@deftypefn {Built-in Function} {} filesep ()\n\ @deftypefnx {Built-in Function} {} filesep ('all')\n\ Return the system-dependent character used to separate directory names.\n\ \n\ @@ -717,7 +718,7 @@ DEFUN (pathsep, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\ +@deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\ Query or set the character used to separate directories in\n\ a path.\n\ @@ -763,7 +764,7 @@ DEFUN (confirm_recursive_rmdir, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} confirm_recursive_rmdir ()\n\ +@deftypefn {Built-in Function} {@var{val} =} confirm_recursive_rmdir ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} confirm_recursive_rmdir (@var{new_val})\n\ Query or set the internal variable that controls whether Octave\n\ will ask for confirmation before recursively removing a directory tree.\n\
--- a/src/error.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/error.cc Sat Jul 31 11:18:11 2010 -0700 @@ -973,7 +973,7 @@ DEFUN (error, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} error (@var{template}, @dots{})\n\ +@deftypefn {Built-in Function} {} error (@var{template}, @dots{})\n\ @deftypefnx {Built-in Function} {} error (@var{id}, @var{template}, @dots{})\n\ Format the optional arguments under the control of the template string\n\ @var{template} using the same rules as the @code{printf} family of\n\ @@ -1097,7 +1097,7 @@ DEFUN (warning, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} warning (@var{template}, @dots{})\n\ +@deftypefn {Built-in Function} {} warning (@var{template}, @dots{})\n\ @deftypefnx {Built-in Function} {} warning (@var{id}, @var{template}, @dots{})\n\ Format the optional arguments under the control of the template string\n\ @var{template} using the same rules as the @code{printf} family of\n\ @@ -1479,7 +1479,7 @@ DEFUN (lasterror, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{err} =} lasterror (@var{err})\n\ +@deftypefn {Built-in Function} {@var{err} =} lasterror (@var{err})\n\ @deftypefnx {Built-in Function} {} lasterror ('reset')\n\ Returns or sets the last error message. Called without any arguments\n\ returns a structure containing the last error message, as well as other\n\ @@ -1488,8 +1488,10 @@ @table @asis\n\ @item 'message'\n\ The text of the last error message\n\ +\n\ @item 'identifier'\n\ The message identifier of this error message\n\ +\n\ @item 'stack'\n\ A structure containing information on where the message occurred. This might\n\ be an empty structure if this in the case where this information cannot\n\ @@ -1498,10 +1500,13 @@ @table @asis\n\ @item 'file'\n\ The name of the file where the error occurred\n\ +\n\ @item 'name'\n\ The name of function in which the error occurred\n\ +\n\ @item 'line'\n\ The line number at which the error occurred\n\ +\n\ @item 'column'\n\ An optional field with the column number at which the error occurred\n\ @end table\n\ @@ -1760,7 +1765,7 @@ DEFUN (beep_on_error, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} beep_on_error ()\n\ +@deftypefn {Built-in Function} {@var{val} =} beep_on_error ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} beep_on_error (@var{new_val})\n\ Query or set the internal variable that controls whether Octave will try\n\ to ring the terminal bell before printing an error message.\n\ @@ -1771,7 +1776,7 @@ DEFUN (debug_on_error, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} debug_on_error ()\n\ +@deftypefn {Built-in Function} {@var{val} =} debug_on_error ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} debug_on_error (@var{new_val})\n\ Query or set the internal variable that controls whether Octave will try\n\ to enter the debugger when an error is encountered. This will also\n\ @@ -1784,7 +1789,7 @@ DEFUN (debug_on_warning, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} debug_on_warning ()\n\ +@deftypefn {Built-in Function} {@var{val} =} debug_on_warning ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} debug_on_warning (@var{new_val})\n\ Query or set the internal variable that controls whether Octave will try\n\ to enter the debugger when a warning is encountered.\n\
--- a/src/file-io.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/file-io.cc Sat Jul 31 11:18:11 2010 -0700 @@ -551,7 +551,7 @@ DEFUN (fopen, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{fid}, @var{msg}] =} fopen (@var{name}, @var{mode}, @var{arch})\n\ +@deftypefn {Built-in Function} {[@var{fid}, @var{msg}] =} fopen (@var{name}, @var{mode}, @var{arch})\n\ @deftypefnx {Built-in Function} {@var{fid_list} =} fopen (\"all\")\n\ @deftypefnx {Built-in Function} {[@var{file}, @var{mode}, @var{arch}] =} fopen (@var{fid})\n\ The first form of the @code{fopen} function opens the named file with\n\ @@ -719,7 +719,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} freport ()\n\ Print a list of which files have been opened, and whether they are open\n\ -for reading, writing, or both. For example,\n\ +for reading, writing, or both. For example:\n\ \n\ @example\n\ @group\n\ @@ -1061,7 +1061,7 @@ DEFUN (fscanf, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} fscanf (@var{fid}, @var{template}, @var{size})\n\ +@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} fscanf (@var{fid}, @var{template}, @var{size})\n\ @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} fscanf (@var{fid}, @var{template}, \"C\")\n\ In the first form, read from @var{fid} according to @var{template},\n\ returning the result in the matrix @var{val}.\n\ @@ -1169,7 +1169,7 @@ DEFUN (sscanf, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ +@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} sscanf (@var{string}, @var{template}, \"C\")\n\ This is like @code{fscanf}, except that the characters are taken from the\n\ string @var{string} instead of from a stream. Reaching the end of the\n\ @@ -1264,7 +1264,7 @@ DEFUN (scanf, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} scanf (@var{template}, @var{size})\n\ +@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} scanf (@var{template}, @var{size})\n\ @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}]] =} scanf (@var{template}, \"C\")\n\ This is equivalent to calling @code{fscanf} with @var{fid} = @code{stdin}.\n\ \n\ @@ -1771,7 +1771,7 @@ open for writing.\n\ @end table\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -2175,7 +2175,7 @@ DEFUNX ("SEEK_SET", FSEEK_SET, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} SEEK_SET ()\n\ +@deftypefn {Built-in Function} {} SEEK_SET ()\n\ @deftypefnx {Built-in Function} {} SEEK_CUR ()\n\ @deftypefnx {Built-in Function} {} SEEK_END ()\n\ Return the value required to request that @code{fseek} perform\n\
--- a/src/graphics.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/graphics.cc Sat Jul 31 11:18:11 2010 -0700 @@ -5078,7 +5078,7 @@ DEFUN (reset, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} reset (@var{h}, @var{property})\n\ -Removes any defaults set for the handle @var{h}. The default figure\n\ +Removes any defaults set for the handle @var{h}. The default figure\n\ properties \"position\", \"units\", \"windowstyle\" and\n\ \"paperunits\" and the default axes properties \"position\" and \"units\"\n\ are not reset.\n\ @@ -5106,7 +5106,7 @@ DEFUN (set, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} set (@var{h}, @var{property}, @var{value}, @dots{})\n\ +@deftypefn {Built-in Function} {} set (@var{h}, @var{property}, @var{value}, @dots{})\n\ @deftypefnx {Built-in Function} {} set (@var{h}, @var{properties}, @var{values})\n\ @deftypefnx {Built-in Function} {} set (@var{h}, @var{pv})\n\ Set named property values for the graphics handle (or vector of graphics\n\ @@ -5118,16 +5118,19 @@ \n\ Here, each @var{property} is a string containing the property name, each\n\ @var{value} is a value of the appropriate type for the property.\n\ +\n\ @item as a cell array of strings @var{properties} containing property names\n\ and a cell array @var{values} containing property values.\n\ \n\ In this case, the number of columns of @var{values} must match the number of\n\ elements in @var{properties}. The first column of @var{values} contains values\n\ -for the first entry in @var{properties}, etc. The number of rows of @var{values}\n\ -must be 1 or match the number of elements of @var{h}. In the first case, each\n\ -handle in @var{h} will be assigned the same values. In the latter case, the\n\ -first handle in @var{h} will be assigned the values from the first row of\n\ +for the first entry in @var{properties}, etc. The number of rows of\n\ +@var{values} must be 1 or match the number of elements of @var{h}. In the first\n\ +case, each handle in @var{h} will be assigned the same values. In the latter\n\ +case, the first handle in @var{h} will be assigned the values from the first row\n\ +of\n\ @var{values} and so on.\n\ +\n\ @item as a structure array @var{pv}\n\ \n\ Here, the field names of @var{pv} represent the property names, and the field\n\ @@ -5715,7 +5718,7 @@ DEFUN (__go_execute_callback__, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} __go_execute_callback__ (@var{h}, @var{name})\n\ +@deftypefn {Built-in Function} {} __go_execute_callback__ (@var{h}, @var{name})\n\ @deftypefnx {Built-in Function} {} __go_execute_callback__ (@var{h}, @var{name}, @var{param})\n\ Undocumented internal function.\n\ @end deftypefn") @@ -6085,30 +6088,37 @@ @table @code\n\ @item string\n\ A string property. @var{arg} contains the default string value.\n\ +\n\ @item any\n\ An un-typed property. This kind of property can hold any octave\n\ value. @var{args} contains the default value.\n\ +\n\ @item radio\n\ A string property with a limited set of accepted values. The first\n\ argument must be a string with all accepted values separated by\n\ a vertical bar ('|'). The default value can be marked by enclosing\n\ it with a '@{' '@}' pair. The default value may also be given as\n\ an optional second string argument.\n\ +\n\ @item boolean\n\ A boolean property. This property type is equivalent to a radio\n\ property with \"on|off\" as accepted values. @var{arg} contains\n\ the default property value.\n\ +\n\ @item double\n\ A scalar double property. @var{arg} contains the default value.\n\ +\n\ @item handle\n\ A handle property. This kind of property holds the handle of a\n\ graphics object. @var{arg} contains the default handle value.\n\ When no default value is given, the property is initialized to\n\ the empty matrix.\n\ +\n\ @item data\n\ A data (matrix) property. @var{arg} contains the default data\n\ value. When no default value is given, the data is initialized to\n\ the empty matrix.\n\ +\n\ @item color\n\ A color property. @var{arg} contains the default color value.\n\ When no default color is given, the property is set to black.\n\
--- a/src/help.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/help.cc Sat Jul 31 11:18:11 2010 -0700 @@ -286,7 +286,8 @@ pair_type ("end", "-*- texinfo -*-\n\ @deffn Keyword end\n\ -Mark the end of any @code{for}, @code{if}, @code{do}, @code{while}, or @code{function} block.\n\ +Mark the end of any @code{for}, @code{if}, @code{do}, @code{while}, or\n\ +@code{function} block.\n\ @seealso{for, if, do, while, function}\n\ @end deffn"), @@ -343,6 +344,7 @@ "-*- texinfo -*-\n\ @deffn Keyword for @var{i} = @var{range}\n\ Begin a for loop.\n\ +\n\ @example\n\ @group\n\ for i = 1:10\n\ @@ -367,6 +369,7 @@ "-*- texinfo -*-\n\ @deffn Keyword global\n\ Declare variables to have global scope.\n\ +\n\ @example\n\ @group\n\ global @var{x};\n\ @@ -385,6 +388,7 @@ @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\ @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif\n\ Begin an if block.\n\ +\n\ @example\n\ @group\n\ x = 1;\n\ @@ -443,6 +447,7 @@ "-*- texinfo -*-\n\ @deffn Keyword switch @var{statement}\n\ Begin a switch block.\n\ +\n\ @example\n\ @group\n\ yesno = \"yes\"\n\ @@ -1004,8 +1009,8 @@ DEFUN (__list_functions__, args, , "-*- texinfo -*-\n\ -@deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\ -@deftypefnx{Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\ +@deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\ +@deftypefnx {Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\ Undocumented internal function.\n\ @end deftypefn") { @@ -1044,7 +1049,7 @@ DEFUN (doc_cache_file, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} doc_cache_file ()\n\ +@deftypefn {Built-in Function} {@var{val} =} doc_cache_file ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} doc_cache_file (@var{new_val})\n\ Query or set the internal variable that specifies the name of the\n\ Octave documentation cache file. A cache file significantly improves\n\ @@ -1053,7 +1058,7 @@ in which @var{octave-home} is the root directory of the Octave installation,\n\ and @var{version} is the Octave version number.\n\ The default value may be overridden by the environment variable\n\ -@w{@code{OCTAVE_DOC_CACHE_FILE}}, or the command line argument\n\ +@w{@env{OCTAVE_DOC_CACHE_FILE}}, or the command line argument\n\ @samp{--doc-cache-file NAME}.\n\ @seealso{lookfor, info_program, doc, help, makeinfo_program}\n\ @end deftypefn") @@ -1063,14 +1068,14 @@ DEFUN (info_file, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} info_file ()\n\ +@deftypefn {Built-in Function} {@var{val} =} info_file ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} info_file (@var{new_val})\n\ Query or set the internal variable that specifies the name of the\n\ Octave info file. The default value is\n\ @file{@var{octave-home}/info/octave.info}, in\n\ which @var{octave-home} is the root directory of the Octave installation.\n\ The default value may be overridden by the environment variable\n\ -@w{@code{OCTAVE_INFO_FILE}}, or the command line argument\n\ +@w{@env{OCTAVE_INFO_FILE}}, or the command line argument\n\ @samp{--info-file NAME}.\n\ @seealso{info_program, doc, help, makeinfo_program}\n\ @end deftypefn") @@ -1080,7 +1085,7 @@ DEFUN (info_program, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} info_program ()\n\ +@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 value is\n\ @@ -1089,7 +1094,7 @@ @var{version} is the Octave version number, and @var{arch}\n\ is the system type (for example, @code{i686-pc-linux-gnu}). The\n\ default value may be overridden by the environment variable\n\ -@w{@code{OCTAVE_INFO_PROGRAM}}, or the command line argument\n\ +@w{@env{OCTAVE_INFO_PROGRAM}}, or the command line argument\n\ @samp{--info-program NAME}.\n\ @seealso{info_file, doc, help, makeinfo_program}\n\ @end deftypefn") @@ -1099,7 +1104,7 @@ DEFUN (makeinfo_program, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\ +@deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} makeinfo_program (@var{new_val})\n\ Query or set the internal variable that specifies the name of the\n\ program that Octave runs to format help text containing\n\ @@ -1112,7 +1117,7 @@ DEFUN (suppress_verbose_help_message, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\ +@deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\ Query or set the internal variable that controls whether Octave\n\ will add additional help information to the end of the output from\n\
--- a/src/input.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/input.cc Sat Jul 31 11:18:11 2010 -0700 @@ -843,7 +843,7 @@ DEFUN (input, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} input (@var{prompt})\n\ +@deftypefn {Built-in Function} {} input (@var{prompt})\n\ @deftypefnx {Built-in Function} {} input (@var{prompt}, \"s\")\n\ Print a prompt and wait for user input. For example,\n\ \n\ @@ -1277,6 +1277,7 @@ Add the named function @var{fcn} to the list of functions to call\n\ periodically when Octave is waiting for input. The function should\n\ have the form\n\ +\n\ @example\n\ @var{fcn} (@var{data})\n\ @end example\n\ @@ -1355,7 +1356,7 @@ DEFUN (PS1, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} PS1 ()\n\ +@deftypefn {Built-in Function} {@var{val} =} PS1 ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} PS1 (@var{new_val})\n\ Query or set the primary prompt string. When executing interactively,\n\ Octave displays the primary prompt when it is ready to read a command.\n\ @@ -1381,7 +1382,7 @@ DEFUN (PS2, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} PS2 ()\n\ +@deftypefn {Built-in Function} {@var{val} =} PS2 ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} PS2 (@var{new_val})\n\ Query or set the secondary prompt string. The secondary prompt is\n\ printed when Octave is expecting additional input to complete a\n\ @@ -1397,7 +1398,7 @@ DEFUN (PS4, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} PS4 ()\n\ +@deftypefn {Built-in Function} {@var{val} =} PS4 ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} PS4 (@var{new_val})\n\ Query or set the character string used to prefix output produced\n\ when echoing commands is enabled.\n\ @@ -1411,7 +1412,7 @@ DEFUN (completion_append_char, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} completion_append_char ()\n\ +@deftypefn {Built-in Function} {@var{val} =} completion_append_char ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} completion_append_char (@var{new_val})\n\ Query or set the internal character variable that is appended to\n\ successful command-line completion attempts. The default\n\ @@ -1423,7 +1424,7 @@ DEFUN (echo_executing_commands, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} echo_executing_commands ()\n\ +@deftypefn {Built-in Function} {@var{val} =} echo_executing_commands ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} echo_executing_commands (@var{new_val})\n\ Query or set the internal variable that controls the echo state.\n\ It may be the sum of the following values:\n\ @@ -1443,7 +1444,7 @@ equivalent to the command @kbd{echo on all}.\n\ \n\ The value of @code{echo_executing_commands} may be set by the @kbd{echo}\n\ -command or the command line option @code{--echo-commands}.\n\ +command or the command line option @option{--echo-commands}.\n\ @end deftypefn") { return SET_INTERNAL_VARIABLE (echo_executing_commands); @@ -1451,7 +1452,7 @@ DEFUN (__request_drawnow__, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} __request_drawnow__ ()\n\ +@deftypefn {Built-in Function} {} __request_drawnow__ ()\n\ @deftypefnx {Built-in Function} {} __request_drawnow__ (@var{flag})\n\ Undocumented internal function.\n\ @end deftypefn") @@ -1495,7 +1496,7 @@ @deftypefn {Built-in Function} {} filemarker ()\n\ Returns or sets the character used to separate filename from the\n\ the subfunction names contained within the file. This can be used in\n\ -a generic manner to interact with subfunctions. For example\n\ +a generic manner to interact with subfunctions. For example,\n\ \n\ @example\n\ help ([\"myfunc\", filemarker, \"mysubfunc\"])\n\ @@ -1505,7 +1506,7 @@ returns the help string associated with the sub-function @code{mysubfunc}\n\ of the function @code{myfunc}. Another use of @code{filemarker} is when\n\ debugging it allows easier placement of breakpoints within sub-functions.\n\ -For example\n\ +For example,\n\ \n\ @example\n\ dbstop ([\"myfunc\", filemarker, \"mysubfunc\"])\n\
--- a/src/load-path.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/load-path.cc Sat Jul 31 11:18:11 2010 -0700 @@ -2035,7 +2035,7 @@ DEFUN (addpath, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} addpath (@var{dir1}, @dots{})\n\ +@deftypefn {Built-in Function} {} addpath (@var{dir1}, @dots{})\n\ @deftypefnx {Built-in Function} {} addpath (@var{dir1}, @dots{}, @var{option})\n\ Add @var{dir1}, @dots{} to the current function search path. If\n\ @var{option} is @samp{\"-begin\"} or 0 (the default), prepend the\n\
--- a/src/load-save.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/load-save.cc Sat Jul 31 11:18:11 2010 -0700 @@ -613,10 +613,10 @@ Force Octave to assume the file is in Octave's binary format.\n\ \n\ @item -hdf5\n\ -Force Octave to assume the file is in HDF5 format.\n\ +Force Octave to assume the file is in @sc{hdf5} format.\n\ (HDF5 is a free, portable binary format developed by the National\n\ Center for Supercomputing Applications at the University of Illinois.)\n\ -Note that Octave can read HDF5 files not created by itself, but may\n\ +Note that Octave can read @sc{hdf5} files not created by itself, but may\n\ skip some datasets in formats that it cannot support.\n" HAVE_HDF5_HELP_STRING @@ -1460,7 +1460,7 @@ output to the terminal. If no variable names are listed, Octave saves\n\ all the variables in the current scope. Otherwise, full variable names or\n\ pattern syntax can be used to specify the variables to save.\n\ -If the @code{-struct} modifier is used, fields @var{f1} @var{f2} @dots{}\n\ +If the @option{-struct} modifier is used, fields @var{f1} @var{f2} @dots{}\n\ of the scalar structure @var{STRUCT} are saved as if they were variables\n\ with corresponding names.\n\ Valid options for the @code{save} command are listed in the following table.\n\ @@ -1490,7 +1490,7 @@ values to be saved can be represented in single precision.\n\ \n\ @item -hdf5\n\ -Save the data in HDF5 format.\n\ +Save the data in @sc{hdf5} format.\n\ (HDF5 is a free, portable binary format developed by the National\n\ Center for Supercomputing Applications at the University of Illinois.)\n" @@ -1498,7 +1498,7 @@ "\n\ @item -float-hdf5\n\ -Save the data in HDF5 format but only using single precision.\n\ +Save the data in @sc{hdf5} format but only using single precision.\n\ Only use this format if you know that all the\n\ values to be saved can be represented in single precision.\n\ \n\ @@ -1553,7 +1553,7 @@ match all lower and upper case alphabetic characters. \n\ \n\ Wildcards may also be used in the field name specifications when using\n\ -the @code{-struct} modifier (but not in the struct name itself).\n\ +the @option{-struct} modifier (but not in the struct name itself).\n\ \n\ @end table\n\ \n\ @@ -1753,7 +1753,7 @@ DEFUN (crash_dumps_octave_core, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} crash_dumps_octave_core ()\n\ +@deftypefn {Built-in Function} {@var{val} =} crash_dumps_octave_core ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} crash_dumps_octave_core (@var{new_val})\n\ Query or set the internal variable that controls whether Octave tries\n\ to save all current variables to the file \"octave-core\" if it\n\ @@ -1771,7 +1771,7 @@ Query or set the internal variable that specifies the default options\n\ for the @code{save} command, and defines the default format.\n\ Typical values include @code{\"-ascii\"}, @code{\"-text -zip\"}.\n\ -The default value is @code{-text}.\n\ +The default value is @option{-text}.\n\ @seealso{save}\n\ @end deftypefn") { @@ -1780,7 +1780,7 @@ DEFUN (octave_core_file_limit, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} octave_core_file_limit ()\n\ +@deftypefn {Built-in Function} {@var{val} =} octave_core_file_limit ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} octave_core_file_limit (@var{new_val})\n\ Query or set the internal variable that specifies the maximum amount\n\ of memory (in kilobytes) of the top-level workspace that Octave will\n\ @@ -1798,7 +1798,7 @@ DEFUN (octave_core_file_name, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} octave_core_file_name ()\n\ +@deftypefn {Built-in Function} {@var{val} =} octave_core_file_name ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} octave_core_file_name (@var{new_val})\n\ Query or set the internal variable that specifies the name of the file\n\ used for saving data from the top-level workspace if Octave aborts.\n\ @@ -1811,7 +1811,7 @@ DEFUN (octave_core_file_options, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} octave_core_file_options ()\n\ +@deftypefn {Built-in Function} {@var{val} =} octave_core_file_options ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} octave_core_file_options (@var{new_val})\n\ Query or set the internal variable that specifies the options used for\n\ saving the workspace data if Octave aborts. The value of\n\
--- a/src/ls-oct-ascii.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ls-oct-ascii.cc Sat Jul 31 11:18:11 2010 -0700 @@ -417,7 +417,7 @@ DEFUN (save_precision, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} save_precision ()\n\ +@deftypefn {Built-in Function} {@var{val} =} save_precision ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} save_precision (@var{new_val})\n\ Query or set the internal variable that specifies the number of\n\ digits to keep when saving data in text format.\n\
--- a/src/mappers.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/mappers.cc Sat Jul 31 11:18:11 2010 -0700 @@ -48,7 +48,7 @@ |@var{z}| = @code{sqrt (x^2 + y^2)}.\n\ @end ifnottex\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -173,7 +173,7 @@ DEFUN (arg, args, , "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} arg (@var{z})\n\ +@deftypefn {Mapping Function} {} arg (@var{z})\n\ @deftypefnx {Mapping Function} {} angle (@var{z})\n\ Compute the argument of @var{z}, defined as,\n\ @tex\n\ @@ -184,7 +184,7 @@ @end ifnottex\n\ in radians.\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -387,6 +387,7 @@ Return the smallest integer not less than @var{x}. This is equivalent to\n\ rounding towards positive infinity. If @var{x} is\n\ complex, return @code{ceil (real (@var{x})) + ceil (imag (@var{x})) * I}.\n\ +\n\ @example\n\ @group\n\ ceil ([-2.7, 2.7])\n\ @@ -555,6 +556,7 @@ t=0\n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ @seealso{erfc, erfinv}\n\ @end deftypefn") @@ -602,6 +604,7 @@ "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} erfinv (@var{x})\n\ Computes the inverse error function, i.e., @var{y} such that\n\ +\n\ @example\n\ erf(@var{y}) == @var{x}\n\ @end example\n\ @@ -754,7 +757,7 @@ "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} finite (@var{x})\n\ Return 1 for elements of @var{x} that are finite values and zero\n\ -otherwise. For example,\n\ +otherwise. For example:\n\ \n\ @example\n\ @group\n\ @@ -791,6 +794,7 @@ Truncate fractional portion of @var{x} and return the integer portion. This\n\ is equivalent to rounding towards zero. If @var{x} is complex, return\n\ @code{fix (real (@var{x})) + fix (imag (@var{x})) * I}.\n\ +\n\ @example\n\ @group\n\ fix ([-2.7, 2.7])\n\ @@ -827,6 +831,7 @@ Return the largest integer not greater than @var{x}. This is equivalent to\n\ rounding towards negative infinity. If @var{x} is\n\ complex, return @code{floor (real (@var{x})) + floor (imag (@var{x})) * I}.\n\ +\n\ @example\n\ @group\n\ floor ([-2.7, 2.7])\n\ @@ -877,6 +882,7 @@ t=0\n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ @seealso{gammainc, lgamma}\n\ @end deftypefn") @@ -966,7 +972,7 @@ DEFUNX ("isalpha", Fisalpha, args, , "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} isalpha (@var{s})\n\ +@deftypefn {Mapping Function} {} isalpha (@var{s})\n\ @deftypefnx {Mapping Function} {} isletter (@var{s})\n\ Return true for characters that are letters (@code{isupper (@var{s})}\n\ or @code{islower (@var{s})} is true).\n\ @@ -1030,7 +1036,7 @@ "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} isinf (@var{x})\n\ Return 1 for elements of @var{x} that are infinite and zero\n\ -otherwise. For example,\n\ +otherwise. For example:\n\ \n\ @example\n\ @group\n\ @@ -1099,7 +1105,7 @@ "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} isna (@var{x})\n\ Return 1 for elements of @var{x} that are NA (missing) values and zero\n\ -otherwise. For example,\n\ +otherwise. For example:\n\ \n\ @example\n\ @group\n\ @@ -1139,7 +1145,7 @@ "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} isnan (@var{x})\n\ Return 1 for elements of @var{x} that are NaN values and zero\n\ -otherwise. NA values are also considered NaN values. For example,\n\ +otherwise. NA values are also considered NaN values. For example:\n\ \n\ @example\n\ @group\n\ @@ -1253,7 +1259,7 @@ DEFUN (lgamma, args, , "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} lgamma (@var{x})\n\ +@deftypefn {Mapping Function} {} lgamma (@var{x})\n\ @deftypefnx {Mapping Function} {} gammaln (@var{x})\n\ Return the natural logarithm of the gamma function of @var{x}.\n\ @seealso{gamma, gammainc}\n\ @@ -1417,6 +1423,7 @@ @deftypefn {Mapping Function} {} round (@var{x})\n\ Return the integer nearest to @var{x}. If @var{x} is complex, return\n\ @code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\ +\n\ @example\n\ @group\n\ round ([-2.7, 2.7])\n\ @@ -1494,6 +1501,7 @@ 1, x > 0.\n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ For complex arguments, @code{sign} returns @code{x ./ abs (@var{x})}.\n\ @@ -1703,7 +1711,7 @@ DEFUNX ("toascii", Ftoascii, args, , "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} toascii (@var{s})\n\ -Return ASCII representation of @var{s} in a matrix. For example,\n\ +Return ASCII representation of @var{s} in a matrix. For example:\n\ \n\ @example\n\ @group\n\ @@ -1726,11 +1734,11 @@ DEFUNX ("tolower", Ftolower, args, , "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} tolower (@var{s})\n\ +@deftypefn {Mapping Function} {} tolower (@var{s})\n\ @deftypefnx {Mapping Function} {} lower (@var{s})\n\ Return a copy of the string or cell string @var{s}, with each upper-case\n\ character replaced by the corresponding lower-case one; non-alphabetic\n\ -characters are left unchanged. For example,\n\ +characters are left unchanged. For example:\n\ \n\ @example\n\ @group\n\ @@ -1772,11 +1780,11 @@ DEFUNX ("toupper", Ftoupper, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} toupper (@var{s})\n\ +@deftypefn {Built-in Function} {} toupper (@var{s})\n\ @deftypefnx {Built-in Function} {} upper (@var{s})\n\ Return a copy of the string or cell string @var{s}, with each lower-case\n\ character replaced by the corresponding upper-case one; non-alphabetic\n\ -characters are left unchanged. For example,\n\ +characters are left unchanged. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/oct-hist.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/oct-hist.cc Sat Jul 31 11:18:11 2010 -0700 @@ -542,7 +542,7 @@ "-*- texinfo -*-\n\ @deffn {Command} edit_history [@var{first}] [@var{last}]\n\ If invoked with no arguments, @code{edit_history} allows you to edit the\n\ -history list using the editor named by the variable @w{@code{EDITOR}}. The\n\ +history list using the editor named by the variable @w{@env{EDITOR}}. The\n\ commands to be edited are first copied to a temporary file. When you\n\ exit the editor, Octave executes the commands that remain in the file.\n\ It is often more convenient to use @code{edit_history} to define functions \n\ @@ -656,11 +656,11 @@ DEFUN (history_size, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} history_size ()\n\ +@deftypefn {Built-in Function} {@var{val} =} history_size ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} history_size (@var{new_val})\n\ Query or set the internal variable that specifies how many entries\n\ to store in the history file. The default value is @code{1024},\n\ -but may be overridden by the environment variable @w{@code{OCTAVE_HISTSIZE}}.\n\ +but may be overridden by the environment variable @w{@env{OCTAVE_HISTSIZE}}.\n\ @seealso{history_file, history_timestamp_format_string, saving_history}\n\ @end deftypefn") { @@ -677,12 +677,12 @@ DEFUN (history_file, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} history_file ()\n\ +@deftypefn {Built-in Function} {@var{val} =} history_file ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} history_file (@var{new_val})\n\ Query or set the internal variable that specifies the name of the\n\ file used to store command history. The default value is\n\ @file{~/.octave_hist}, but may be overridden by the environment\n\ -variable @w{@code{OCTAVE_HISTFILE}}.\n\ +variable @w{@env{OCTAVE_HISTFILE}}.\n\ @seealso{history_size, saving_history, history_timestamp_format_string}\n\ @end deftypefn") { @@ -698,7 +698,7 @@ DEFUN (history_timestamp_format_string, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} history_timestamp_format_string ()\n\ +@deftypefn {Built-in Function} {@var{val} =} history_timestamp_format_string ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} history_timestamp_format_string (@var{new_val})\n\ Query or set the internal variable that specifies the format string\n\ for the comment line that is written to the history file when Octave\n\ @@ -716,7 +716,7 @@ DEFUN (saving_history, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} saving_history ()\n\ +@deftypefn {Built-in Function} {@var{val} =} saving_history ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} saving_history (@var{new_val})\n\ Query or set the internal variable that controls whether commands entered\n\ on the command line are saved in the history file.\n\
--- a/src/octave.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/octave.cc Sat Jul 31 11:18:11 2010 -0700 @@ -901,7 +901,7 @@ \n\ @noindent\n\ @code{argv} would return a cell array of strings with the elements\n\ -@code{--no-line-editing} and @code{--silent}.\n\ +@option{--no-line-editing} and @option{--silent}.\n\ \n\ If you write an executable Octave script, @code{argv} will return the\n\ list of arguments passed to the script. @xref{Executable Octave Programs},\n\
--- a/src/ov-base.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-base.cc Sat Jul 31 11:18:11 2010 -0700 @@ -1517,11 +1517,11 @@ DEFUN (sparse_auto_mutate, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} sparse_auto_mutate ()\n\ +@deftypefn {Built-in Function} {@var{val} =} sparse_auto_mutate ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} sparse_auto_mutate (@var{new_val})\n\ Query or set the internal variable that controls whether Octave will\n\ automatically mutate sparse matrices to real matrices to save memory.\n\ -For example,\n\ +For example:\n\ \n\ @example\n\ @group\n\
--- a/src/ov-cell.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-cell.cc Sat Jul 31 11:18:11 2010 -0700 @@ -1250,7 +1250,7 @@ DEFUN (cell, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} cell (@var{x})\n\ +@deftypefn {Built-in Function} {} cell (@var{x})\n\ @deftypefnx {Built-in Function} {} cell (@var{n}, @var{m})\n\ Create a new cell array object. If invoked with a single scalar\n\ argument, @code{cell} returns a square cell array with the dimension\n\
--- a/src/ov-class.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-class.cc Sat Jul 31 11:18:11 2010 -0700 @@ -1702,7 +1702,7 @@ DEFUN (class, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} class (@var{expr})\n\ +@deftypefn {Built-in Function} {} class (@var{expr})\n\ @deftypefnx {Built-in Function} {} class (@var{s}, @var{id})\n\ @deftypefnx {Built-in Function} {} class (@var{s}, @var{id}, @var{p}, @dots{})\n\ Return the class of the expression @var{expr} or create a class with\n\ @@ -1874,7 +1874,7 @@ DEFUN (methods, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} methods (@var{x})\n\ +@deftypefn {Built-in Function} {} methods (@var{x})\n\ @deftypefnx {Built-in Function} {} methods (\"classname\")\n\ Return a cell array containing the names of the methods for the\n\ object @var{x} or the named class.\n\
--- a/src/ov-fcn-handle.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-fcn-handle.cc Sat Jul 31 11:18:11 2010 -0700 @@ -1700,7 +1700,7 @@ DEFUN (str2func, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} str2func (@var{fcn_name})\n\ +@deftypefn {Built-in Function} {} str2func (@var{fcn_name})\n\ @deftypefnx {Built-in Function} {} str2func (@var{fcn_name}, \"global\")\n\ Return a function handle constructed from the string @var{fcn_name}.\n\ If the optional \"global\" argument is passed, locally visible functions\n\
--- a/src/ov-fcn-inline.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-fcn-inline.cc Sat Jul 31 11:18:11 2010 -0700 @@ -629,7 +629,7 @@ DEFUNX ("inline", Finline, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} inline (@var{str})\n\ +@deftypefn {Built-in Function} {} inline (@var{str})\n\ @deftypefnx {Built-in Function} {} inline (@var{str}, @var{arg1}, @dots{})\n\ @deftypefnx {Built-in Function} {} inline (@var{str}, @var{n})\n\ Create an inline function from the character string @var{str}.\n\
--- a/src/ov-null-mat.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-null-mat.cc Sat Jul 31 11:18:11 2010 -0700 @@ -92,12 +92,13 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isnull (@var{x})\n\ Return 1 if @var{x} is a special null matrix, string or single quoted string.\n\ -Indexed assignment with such a value as right-hand side should delete array elements.\n\ -This function should be used when overloading indexed assignment for user-defined \n\ -classes instead of @code{isempty}, to distinguish the cases:\n\ +Indexed assignment with such a value as right-hand side should delete array\n\ +elements. This function should be used when overloading indexed assignment for\n\ +user-defined classes instead of @code{isempty}, to distinguish the cases:\n\ @table @asis\n\ @item @code{A(I) = []}\n\ This should delete elements if @code{I} is nonempty.\n\ +\n\ @item @code{X = []; A(I) = X}\n\ This should give an error if @code{I} is nonempty.\n\ @end table\n\
--- a/src/ov-range.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-range.cc Sat Jul 31 11:18:11 2010 -0700 @@ -632,7 +632,7 @@ DEFUN (allow_noninteger_range_as_index, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} allow_noninteger_range_as_index ()\n\ +@deftypefn {Built-in Function} {@var{val} =} allow_noninteger_range_as_index ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} allow_noninteger_range_as_index (@var{new_val})\n\ Query or set the internal variable that controls whether non-integer\n\ ranges are allowed as indices. This might be useful for @sc{matlab}\n\
--- a/src/ov-struct.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-struct.cc Sat Jul 31 11:18:11 2010 -0700 @@ -2141,8 +2141,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} rmfield (@var{s}, @var{f})\n\ Return a copy of the structure (array) @var{s} with the field @var{f} removed.\n\ -If @var{f} is a cell array of strings or a character array, remove the\n\ -named fields.\n\ +If @var{f} is a cell array of strings or a character array, remove the named\n\ +fields.\n\ @seealso{cellstr, iscellstr, setfield}\n\ @end deftypefn") {
--- a/src/ov-usr-fcn.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/ov-usr-fcn.cc Sat Jul 31 11:18:11 2010 -0700 @@ -583,7 +583,7 @@ DEFUN (nargin, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} nargin ()\n\ +@deftypefn {Built-in Function} {} nargin ()\n\ @deftypefnx {Built-in Function} {} nargin (@var{fcn_name})\n\ Within a function, return the number of arguments passed to the function.\n\ At the top level, return the number of command line arguments passed to\n\ @@ -639,7 +639,7 @@ DEFUN (nargout, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} nargout ()\n\ +@deftypefn {Built-in Function} {} nargout ()\n\ @deftypefnx {Built-in Function} {} nargout (@var{fcn_name})\n\ Within a function, return the number of values the caller expects to\n\ receive. If called with the optional argument @var{fcn_name}, return the\n\ @@ -718,8 +718,8 @@ DEFUN (optimize_subsasgn_calls, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} optimize_subsasgn_calls ()\n\ -@deftypefnx {Built-in Function} {@var{old_val} =} optimize_subsasgn_calls (@var{new_val})\n\ +@deftypefn {Built-in Function} {@var{val} =} optimize_subsasgn_calls ()\n\ +@deftypefnx {Built-in Function} {@var{old_val} =} optimize_subsasgn_calls (@var{new_val})\n\ Query or set the internal flag for subsasgn method call optimizations.\n\ If true, Octave will attempt to eliminate the redundant copying when calling\n\ subsasgn method of a user-defined class.\n\ @@ -742,9 +742,9 @@ @deftypefn {Built-in Function} {} is_ignored_output (@var{k})\n\ Within a function, given an index @var{k} within the range @code{1:nargout},\n\ return a logical value indicating whether the argument will be ignored on output\n\ -using the tilde (~) special output argument. If @var{k} is outside the range,\n\ -the function yields false. @var{k} can also be an array, in which case the function\n\ -works element-wise and a logical array is returned.\n\ +using the tilde (~) special output argument. If @var{k} is outside the range,\n\ +the function yields false. @var{k} can also be an array, in which case the\n\ +function works element-wise and a logical array is returned.\n\ \n\ At the top level, @code{is_ignored_output} returns an error.\n\ @seealso{nargout, nargin, varargin, varargout}\n\
--- a/src/pager.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/pager.cc Sat Jul 31 11:18:11 2010 -0700 @@ -544,7 +544,7 @@ DEFUN (page_output_immediately, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} page_output_immediately ()\n\ +@deftypefn {Built-in Function} {@var{val} =} page_output_immediately ()\n\ @deftypefnx {Built-in Function} {@var{val} =} page_output_immediately (@var{new_val})\n\ Query or set the internal variable that controls whether Octave sends\n\ output to the pager as soon as it is available. Otherwise, Octave\n\ @@ -557,7 +557,7 @@ DEFUN (page_screen_output, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} page_screen_output ()\n\ +@deftypefn {Built-in Function} {@var{val} =} page_screen_output ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} page_screen_output (@var{new_val})\n\ Query or set the internal variable that controls whether output intended\n\ for the terminal window that is longer than one page is sent through a\n\ @@ -571,7 +571,7 @@ DEFUN (PAGER, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} PAGER ()\n\ +@deftypefn {Built-in Function} {@var{val} =} PAGER ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} PAGER (@var{new_val})\n\ Query or set the internal variable that specifies the program to use\n\ to display terminal output on your system. The default value is\n\ @@ -586,7 +586,7 @@ DEFUN (PAGER_FLAGS, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} PAGER_FLAGS ()\n\ +@deftypefn {Built-in Function} {@var{val} =} PAGER_FLAGS ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} PAGER_FLAGS (@var{new_val})\n\ Query or set the internal variable that specifies the options to pass\n\ to the pager.\n\
--- a/src/pr-output.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/pr-output.cc Sat Jul 31 11:18:11 2010 -0700 @@ -3435,7 +3435,7 @@ DEFUN (disp, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} disp (@var{x})\n\ -Display the value of @var{x}. For example,\n\ +Display the value of @var{x}. For example:\n\ \n\ @example\n\ @group\n\ @@ -3479,7 +3479,7 @@ DEFUN (fdisp, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} fdisp (@var{fid}, @var{x})\n\ -Display the value of @var{x} on the stream @var{fid}. For example,\n\ +Display the value of @var{x} on the stream @var{fid}. For example:\n\ \n\ @example\n\ @group\n\ @@ -3861,6 +3861,7 @@ @item hex\n\ The same as @code{native-hex}, but always print the most significant\n\ byte first.\n\ +\n\ @item native-bit\n\ Print the bit representation of numbers as stored in memory.\n\ For example, the value of @code{pi} is\n\ @@ -3875,6 +3876,7 @@ (shown here in two 32 bit sections for typesetting purposes) when\n\ printed in native-bit format on a workstation which stores 8 byte real values\n\ in IEEE format with the least significant byte first.\n\ +\n\ @item bit\n\ The same as @code{native-bit}, but always print the most significant\n\ bits first.\n\ @@ -3892,6 +3894,7 @@ @item compact\n\ Remove extra blank space around column number labels producing more compact\n\ output with more data per page.\n\ +\n\ @item loose\n\ Insert blank lines above and below column number labels to produce a more\n\ readable output with less data per page. (default).\n\ @@ -3914,12 +3917,12 @@ DEFUN (fixed_point_format, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} fixed_point_format ()\n\ +@deftypefn {Built-in Function} {@var{val} =} fixed_point_format ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} fixed_point_format (@var{new_val})\n\ Query or set the internal variable that controls whether Octave will\n\ use a scaled format to print matrix values such that the largest\n\ element may be written with a single leading digit with the scaling\n\ -factor is printed on the first line of output. For example,\n\ +factor is printed on the first line of output. For example:\n\ \n\ @example\n\ @group\n\ @@ -3947,7 +3950,7 @@ DEFUN (print_empty_dimensions, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} print_empty_dimensions ()\n\ +@deftypefn {Built-in Function} {@var{val} =} print_empty_dimensions ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} print_empty_dimensions (@var{new_val})\n\ Query or set the internal variable that controls whether the\n\ dimensions of empty matrices are printed along with the empty matrix\n\ @@ -3970,7 +3973,7 @@ DEFUN (split_long_rows, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} split_long_rows ()\n\ +@deftypefn {Built-in Function} {@var{val} =} split_long_rows ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} split_long_rows (@var{new_val})\n\ Query or set the internal variable that controls whether rows of a matrix\n\ may be split when displayed to a terminal window. If the rows are split,\n\ @@ -4002,7 +4005,7 @@ DEFUN (output_max_field_width, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} output_max_field_width ()\n\ +@deftypefn {Built-in Function} {@var{val} =} output_max_field_width ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} output_max_field_width (@var{new_val})\n\ Query or set the internal variable that specifies the maximum width\n\ of a numeric output field.\n\ @@ -4014,7 +4017,7 @@ DEFUN (output_precision, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} output_precision ()\n\ +@deftypefn {Built-in Function} {@var{val} =} output_precision ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} output_precision (@var{new_val})\n\ Query or set the internal variable that specifies the minimum number of\n\ significant figures to display for numeric output.\n\ @@ -4026,7 +4029,7 @@ DEFUN (struct_levels_to_print, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} struct_levels_to_print ()\n\ +@deftypefn {Built-in Function} {@var{val} =} struct_levels_to_print ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} struct_levels_to_print (@var{new_val})\n\ Query or set the internal variable that specifies the number of\n\ structure levels to display.\n\
--- a/src/pt-eval.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/pt-eval.cc Sat Jul 31 11:18:11 2010 -0700 @@ -1184,7 +1184,7 @@ DEFUN (max_recursion_depth, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} max_recursion_depth ()\n\ +@deftypefn {Built-in Function} {@var{val} =} max_recursion_depth ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} max_recursion_depth (@var{new_val})\n\ Query or set the internal limit on the number of times a function may\n\ be called recursively. If the limit is exceeded, an error message is\n\ @@ -1196,7 +1196,7 @@ DEFUN (silent_functions, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} silent_functions ()\n\ +@deftypefn {Built-in Function} {@var{val} =} silent_functions ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} silent_functions (@var{new_val})\n\ Query or set the internal variable that controls whether internal\n\ output from a function is suppressed. If this option is disabled,\n\
--- a/src/pt-mat.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/pt-mat.cc Sat Jul 31 11:18:11 2010 -0700 @@ -1125,11 +1125,11 @@ DEFUN (string_fill_char, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} string_fill_char ()\n\ +@deftypefn {Built-in Function} {@var{val} =} string_fill_char ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} string_fill_char (@var{new_val})\n\ Query or set the internal variable used to pad all rows of a character\n\ matrix to the same length. It must be a single character. The default\n\ -value is @code{\" \"} (a single space). For example,\n\ +value is @code{\" \"} (a single space). For example:\n\ \n\ @example\n\ @group\n\
--- a/src/sighandlers.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/sighandlers.cc Sat Jul 31 11:18:11 2010 -0700 @@ -961,7 +961,7 @@ DEFUN (debug_on_interrupt, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} debug_on_interrupt ()\n\ +@deftypefn {Built-in Function} {@var{val} =} debug_on_interrupt ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} debug_on_interrupt (@var{new_val})\n\ Query or set the internal variable that controls whether Octave will try\n\ to enter debugging mode when it receives an interrupt signal (typically\n\ @@ -974,7 +974,7 @@ DEFUN (sighup_dumps_octave_core, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} sighup_dumps_octave_core ()\n\ +@deftypefn {Built-in Function} {@var{val} =} sighup_dumps_octave_core ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} sighup_dumps_octave_core (@var{new_val})\n\ Query or set the internal variable that controls whether Octave tries\n\ to save all current variables to the file \"octave-core\" if it receives\n\ @@ -986,7 +986,7 @@ DEFUN (sigterm_dumps_octave_core, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} sigterm_dumps_octave_core ()\n\ +@deftypefn {Built-in Function} {@var{val} =} sigterm_dumps_octave_core ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} sigterm_dumps_octave_core (@var{new_val})\n\ Query or set the internal variable that controls whether Octave tries\n\ to save all current variables to the file \"octave-core\" if it receives\n\
--- a/src/strfns.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/strfns.cc Sat Jul 31 11:18:11 2010 -0700 @@ -57,7 +57,8 @@ to the corresponding ASCII character. A range error results if an input\n\ is outside the ASCII range (0-255).\n\ \n\ -For cell arrays, each element is concatenated separately. Cell arrays converted through\n\ +For cell arrays, each element is concatenated separately. Cell arrays converted\n\ +through\n\ @code{char} can mostly be converted back with @code{cellstr}.\n\ For example,\n\ \n\ @@ -180,7 +181,8 @@ to the corresponding ASCII character. A range error results if an input\n\ is outside the ASCII range (0-255).\n\ \n\ -For cell arrays, each element is concatenated separately. Cell arrays converted through\n\ +For cell arrays, each element is concatenated separately. Cell arrays converted\n\ +through\n\ @code{strvcat} can mostly be converted back with @code{cellstr}.\n\ For example,\n\ \n\ @@ -639,8 +641,8 @@ DEFUN (strncmp, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} strncmp (@var{s1}, @var{s2}, @var{n})\n\ -Return 1 if the first @var{n} characters of strings @var{s1} and @var{s2} are the same,\n\ -and 0 otherwise.\n\ +Return 1 if the first @var{n} characters of strings @var{s1} and @var{s2} are\n\ +the same, and 0 otherwise.\n\ \n\ @example\n\ @group\n\
--- a/src/symtab.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/symtab.cc Sat Jul 31 11:18:11 2010 -0700 @@ -1411,7 +1411,7 @@ DEFUN (ignore_function_time_stamp, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} ignore_function_time_stamp ()\n\ +@deftypefn {Built-in Function} {@var{val} =} ignore_function_time_stamp ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} ignore_function_time_stamp (@var{new_val})\n\ Query or set the internal variable that controls whether Octave checks\n\ the time stamp on files each time it looks up functions defined in\n\ @@ -1488,7 +1488,7 @@ DEFUN (__dump_symtab_info__, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} __dump_symtab_info__ ()\n\ +@deftypefn {Built-in Function} {} __dump_symtab_info__ ()\n\ @deftypefnx {Built-in Function} {} __dump_symtab_info__ (@var{scope})\n\ @deftypefnx {Built-in Function} {} __dump_symtab_info__ (\"scopes\")\n\ @deftypefnx {Built-in Function} {} __dump_symtab_info__ (\"functions\")\n\
--- a/src/syscalls.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/syscalls.cc Sat Jul 31 11:18:11 2010 -0700 @@ -113,7 +113,7 @@ Duplicate a file descriptor.\n\ \n\ If successful, @var{fid} is greater than zero and contains the new file\n\ -ID. Otherwise, @var{fid} is negative and @var{msg} contains a\n\ +ID@. Otherwise, @var{fid} is negative and @var{msg} contains a\n\ system-dependent error message.\n\ @end deftypefn") { @@ -248,7 +248,7 @@ contains the process ID of the subprocess. Otherwise, @var{pid} is\n\ @minus{}1.\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ [in, out, pid] = popen2 (\"sort\", \"-r\");\n\ @@ -876,7 +876,7 @@ DEFUNX ("stat", Fstat, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} stat (@var{file})\n\ +@deftypefn {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} stat (@var{file})\n\ @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{file})\n\ Return a structure @var{s} containing the following information about\n\ @var{file}.\n\ @@ -941,7 +941,7 @@ about the actual file that is referenced by the link. Use @code{lstat}\n\ if you want information about the symbolic link itself.\n\ \n\ -For example,\n\ +For example:\n\ \n\ @example\n\ [s, err, msg] = stat (\"/vmlinuz\")\n\ @@ -1176,7 +1176,7 @@ DEFUN (uname, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{uts}, @var{err}, @var{msg}] =} uname ()\n\ -Return system information in the structure. For example,\n\ +Return system information in the structure. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/sysdep.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/sysdep.cc Sat Jul 31 11:18:11 2010 -0700 @@ -535,7 +535,7 @@ DEFUN (clc, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} clc ()\n\ +@deftypefn {Built-in Function} {} clc ()\n\ @deftypefnx {Built-in Function} {} home ()\n\ Clear the terminal screen and move the cursor to the upper left corner.\n\ @end deftypefn") @@ -579,7 +579,7 @@ DEFUN (putenv, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} putenv (@var{var}, @var{value})\n\ +@deftypefn {Built-in Function} {} putenv (@var{var}, @var{value})\n\ @deftypefnx {Built-in Function} {} setenv (@var{var}, @var{value})\n\ Set the value of the environment variable @var{var} to @var{value}.\n\ @end deftypefn") @@ -820,7 +820,7 @@ possible user name, and the tilde and the following characters up to the\n\ slash are replaced by the home directory of the named user. If the\n\ tilde is followed immediately by a slash, the tilde is replaced by the\n\ -home directory of the user running Octave. For example,\n\ +home directory of the user running Octave. For example:\n\ \n\ @example\n\ @group\n\
--- a/src/toplev.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/toplev.cc Sat Jul 31 11:18:11 2010 -0700 @@ -679,7 +679,7 @@ DEFUN (quit, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} exit (@var{status})\n\ +@deftypefn {Built-in Function} {} exit (@var{status})\n\ @deftypefnx {Built-in Function} {} quit (@var{status})\n\ Exit the current Octave session. If the optional integer value\n\ @var{status} is supplied, pass that value to the operating system as the\n\ @@ -1065,7 +1065,7 @@ DEFUN (atexit, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} atexit (@var{fcn})\n\ +@deftypefn {Built-in Function} {} atexit (@var{fcn})\n\ @deftypefnx {Built-in Function} {} atexit (@var{fcn}, @var{flag})\n\ Register a function to be called when Octave exits. For example,\n\ \n\
--- a/src/utils.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/utils.cc Sat Jul 31 11:18:11 2010 -0700 @@ -274,7 +274,7 @@ DEFUN (file_in_loadpath, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} file_in_loadpath (@var{file})\n\ +@deftypefn {Built-in Function} {} file_in_loadpath (@var{file})\n\ @deftypefnx {Built-in Function} {} file_in_loadpath (@var{file}, \"all\")\n\ \n\ Return the absolute name of @var{file} if it can be found in\n\ @@ -325,12 +325,12 @@ DEFUN (file_in_path, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} file_in_path (@var{path}, @var{file})\n\ +@deftypefn {Built-in Function} {} file_in_path (@var{path}, @var{file})\n\ @deftypefnx {Built-in Function} {} file_in_path (@var{path}, @var{file}, \"all\")\n\ Return the absolute name of @var{file} if it can be found in\n\ @var{path}. The value of @var{path} should be a colon-separated list of\n\ directories in the format described for @code{path}. If no file\n\ -is found, return an empty character string. For example,\n\ +is found, return an empty character string. For example:\n\ \n\ @example\n\ @group\n\ @@ -825,7 +825,7 @@ DEFUNX ("errno", Ferrno, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{err} =} errno ()\n\ +@deftypefn {Built-in Function} {@var{err} =} errno ()\n\ @deftypefnx {Built-in Function} {@var{err} =} errno (@var{val})\n\ @deftypefnx {Built-in Function} {@var{err} =} errno (@var{name})\n\ Return the current value of the system-dependent variable errno,\n\
--- a/src/variables.cc Fri Jul 30 18:59:31 2010 -0400 +++ b/src/variables.cc Sat Jul 31 11:18:11 2010 -0700 @@ -558,10 +558,13 @@ @table @samp\n\ @item \"var\"\n\ Check only for variables.\n\ +\n\ @item \"builtin\"\n\ Check only for built-in functions.\n\ +\n\ @item \"file\"\n\ Check only for files.\n\ +\n\ @item \"dir\"\n\ Check only for directories.\n\ @end table\n\ @@ -1745,10 +1748,12 @@ @table @code\n\ @item global\n\ List variables in the global scope rather than the current scope.\n\ +\n\ @item -regexp\n\ The patterns are considered to be regular expressions when matching the\n\ variables to display. The same pattern syntax accepted by\n\ the @code{regexp} function is used.\n\ +\n\ @item -file\n\ The next argument is treated as a filename. All variables found within the\n\ specified file are listed. No patterns are accepted when reading variables\n\ @@ -1794,18 +1799,24 @@ @table @asis\n\ @item blank\n\ Variable in local scope\n\ +\n\ @item @code{g}\n\ Variable with global scope\n\ +\n\ @item @code{p}\n\ Persistent variable\n\ @end table\n\ +\n\ @item Name\n\ The name of the variable.\n\ +\n\ @item Size\n\ The logical size of the variable. A scalar is 1x1, a vector is 1xN or Nx1,\n\ a 2-D matrix is MxN.\n\ +\n\ @item Bytes\n\ The amount of memory currently used to store the variable.\n\ +\n\ @item Class\n\ The class of the variable. Examples include double, single, char, uint16,\n\ cell, and struct.\n\ @@ -2285,12 +2296,16 @@ \n\ @item -functions, -f\n\ Clears the function names and the built-in symbols names.\n\ +\n\ @item -global, -g\n\ Clears the global symbol names.\n\ +\n\ @item -variables, -v\n\ Clears the local variable names.\n\ +\n\ @item -classes, -c\n\ Clears the class structure table and clears all objects.\n\ +\n\ @item -regexp, -r\n\ The arguments are treated as regular expressions as any variables that\n\ match will be cleared.\n\ @@ -2448,16 +2463,22 @@ @item %a\n\ Prints attributes of variables (g=global, p=persistent,\n\ f=formal parameter, a=automatic variable).\n\ +\n\ @item %b\n\ Prints number of bytes occupied by variables.\n\ +\n\ @item %c\n\ Prints class names of variables.\n\ +\n\ @item %e\n\ Prints elements held by variables.\n\ +\n\ @item %n\n\ Prints variable names.\n\ +\n\ @item %s\n\ Prints dimensions of variables.\n\ +\n\ @item %t\n\ Prints type names of variables.\n\ @end table\n\ @@ -2467,8 +2488,10 @@ @table @code\n\ @item l\n\ Left alignment.\n\ +\n\ @item r\n\ Right alignment (default).\n\ +\n\ @item c\n\ Column-aligned (only applicable to command %s).\n\ @end table\n\ @@ -2496,7 +2519,7 @@ DEFUN (missing_function_hook, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{val} =} missing_function_hook ()\n\ +@deftypefn {Built-in Function} {@var{val} =} missing_function_hook ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} missing_function_hook (@var{new_val})\n\ Query or set the internal variable that allows setting a custom hook function\n\ called when an uknown identifier is requested.\n\