Mercurial > octave-nkf
changeset 10821:693e22af08ae
Grammarcheck documentation of m-files
Add newlines between @item fields for readability.
line wrap: on
line diff
--- a/scripts/ChangeLog Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/ChangeLog Mon Jul 26 21:25:36 2010 -0700 @@ -1,3 +1,52 @@ +2010-07-26 Rik <octave@nomad.inbox5.com> + * deprecated/complement.m, deprecated/intwarning.m, general/arrayfun.m, + general/circshift.m, general/colon.m, general/common_size.m, + general/del2.m, general/flipdim.m, general/fliplr.m, general/flipud.m, + general/idivide.m, general/interp1.m, general/interp2.m, + general/interp3.m, general/interpn.m, general/loadobj.m, + general/quadgk.m, general/rat.m, general/saveobj.m, general/shiftdim.m, + geometry/delaunayn.m, image/image_viewer.m, image/imfinfo.m, + io/csvread.m, io/csvwrite.m, io/strread.m, linear-algebra/condest.m, + linear-algebra/housh.m, linear-algebra/onenormest.m, + linear-algebra/qzhess.m, miscellaneous/bincoeff.m, + miscellaneous/compare_versions.m, miscellaneous/computer.m, + miscellaneous/edit.m, miscellaneous/fileattrib.m, + miscellaneous/getfield.m, miscellaneous/license.m, miscellaneous/ls.m, + miscellaneous/parseparams.m, miscellaneous/swapbytes.m, + miscellaneous/ver.m, miscellaneous/warning_ids.m, + optimization/fminbnd.m, optimization/fminunc.m, optimization/fsolve.m, + optimization/fzero.m, optimization/glpk.m, optimization/lsqnonneg.m, + optimization/pqpnonneg.m, optimization/qp.m, optimization/sqp.m, + path/pathdef.m, pkg/pkg.m, plot/__marching_cube__.m, plot/axis.m, + plot/colorbar.m, plot/contourc.m, plot/contourf.m, plot/cylinder.m, + plot/ezplot.m, plot/isocolors.m, plot/isonormals.m, plot/legend.m, + plot/print.m, plot/refreshdata.m, plot/slice.m, plot/subplot.m, + plot/surfl.m, polynomial/compan.m, polynomial/mpoles.m, + polynomial/poly.m, polynomial/polyaffine.m, polynomial/polyfit.m, + polynomial/polygcd.m, polynomial/polyout.m, polynomial/residue.m, + polynomial/roots.m, polynomial/unmkpp.m, set/union.m, signal/filter2.m, + signal/stft.m, sparse/spdiags.m, specfun/bessel.m, specfun/beta.m, + specfun/betaln.m, specfun/nchoosek.m, specfun/nthroot.m, + specfun/perms.m, special-matrix/hadamard.m, special-matrix/hankel.m, + special-matrix/hilb.m, special-matrix/invhilb.m, + special-matrix/toeplitz.m, special-matrix/vander.m, + statistics/base/cloglog.m, statistics/base/cor.m, + statistics/base/corrcoef.m, statistics/base/kendall.m, + statistics/base/kurtosis.m, statistics/base/logit.m, + statistics/base/mean.m, statistics/base/median.m, + statistics/base/quantile.m, statistics/base/skewness.m, + statistics/base/std.m, statistics/base/var.m, + statistics/distributions/kolmogorov_smirnov_cdf.m, + statistics/distributions/wblcdf.m, statistics/tests/cor_test.m, + statistics/tests/hotelling_test_2.m, strings/bin2dec.m, + strings/cstrcat.m, strings/dec2bin.m, strings/dec2hex.m, + strings/findstr.m, strings/hex2dec.m, strings/index.m, + strings/isstrprop.m, strings/regexptranslate.m, strings/rindex.m, + strings/strcat.m, strings/substr.m, testfun/demo.m, time/asctime.m, + time/clock.m, time/ctime.m, time/date.m, time/datenum.m, + time/is_leap_year.m: Grammarcheck documentation of m-files. + Add newlines between @items for readability. + 2010-07-26 Ben Abbott <bpabbott@mac.com> * general/interp1.m: When absent set X equal to the inices of Y.
--- a/scripts/deprecated/complement.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/deprecated/complement.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} complement (@var{x}, @var{y}) ## Return the elements of set @var{y} that are not in set @var{x}. For -## example, +## example: ## ## @example ## @group
--- a/scripts/deprecated/intwarning.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/deprecated/intwarning.m Mon Jul 26 21:25:36 2010 -0700 @@ -50,7 +50,7 @@ ## ## The original state of the integer warnings can be restored by passing ## the structure array returned by @code{intwarning} to a later call to -## @code{intwarning}. For example +## @code{intwarning}. For example: ## ## @example ## @group
--- a/scripts/general/arrayfun.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/arrayfun.m Mon Jul 26 21:25:36 2010 -0700 @@ -40,7 +40,7 @@ ## the input arguments given as third input argument @var{b}, fourth ## input argument @var{c}, @dots{} If given more than one array input ## argument then all input arguments must have the same sizes, for -## example +## example: ## ## @example ## @group @@ -54,7 +54,7 @@ ## function @var{func} must return a single element which then will be ## concatenated into the return value and is of type matrix. Otherwise, ## if that parameter is set to @code{false}, then the outputs are -## concatenated in a cell array. For example +## concatenated in a cell array. For example: ## ## @example ## @group @@ -70,7 +70,7 @@ ## ## If more than one output arguments are given then the named function ## must return the number of return values that also are expected, for -## example +## example: ## ## @example ## @group @@ -111,7 +111,7 @@ ## the array elements that caused the error. The size of the output ## argument of @var{errfunc} must have the same size as the output ## argument of @var{func}, otherwise a real error is thrown. For -## example +## example: ## ## @example ## @group
--- a/scripts/general/circshift.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/circshift.m Mon Jul 26 21:25:36 2010 -0700 @@ -23,7 +23,7 @@ ## @var{x}. The values of @var{n} can be either positive or negative, ## which determines the direction in which the values or @var{x} are ## shifted. If an element of @var{n} is zero, then the corresponding -## dimension of @var{x} will not be shifted. For example +## dimension of @var{x} will not be shifted. For example: ## ## @example ## @group
--- a/scripts/general/colon.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/colon.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {@var{r} =} colon (@var{a}, @var{b}) ## @deftypefnx {Function File} {@var{r} =} colon (@var{a}, @var{b}, @var{c}) ## Method of a class to construct a range with the @code{:} operator. For -## example. +## example: ## ## @example ## @group
--- a/scripts/general/common_size.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/common_size.m Mon Jul 26 21:25:36 2010 -0700 @@ -25,7 +25,7 @@ ## size. If so, @var{err} is zero, and @var{yi} is a matrix of the ## common size with all entries equal to @var{xi} if this is a scalar or ## @var{xi} otherwise. If the inputs cannot be brought to a common size, -## @var{err} is 1, and @var{yi} is @var{xi}. For example, +## @var{err} is 1, and @var{yi} is @var{xi}. For example: ## ## @example ## @group
--- a/scripts/general/del2.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/del2.m Mon Jul 26 21:25:36 2010 -0700 @@ -30,11 +30,11 @@ ## operator. ## @end ifnottex ## For a 2-dimensional matrix @var{m} this is defined as -## ## @tex ## $$d = {1 \over 4} \left( {d^2 \over dx^2} M(x,y) + {d^2 \over dy^2} M(x,y) \right)$$ ## @end tex ## @ifnottex +## ## @example ## @group ## 1 / d^2 d^2 \ @@ -42,11 +42,10 @@ ## 4 \ dx^2 dy^2 / ## @end group ## @end example +## ## @end ifnottex -## ## For N-dimensional arrays the sum in parentheses is expanded to include second -## derivatives -## over the additional higher dimensions. +## derivatives over the additional higher dimensions. ## ## The spacing between evaluation points may be defined by @var{h}, which is a ## scalar defining the equidistant spacing in all dimensions. Alternatively,
--- a/scripts/general/flipdim.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/flipdim.m Mon Jul 26 21:25:36 2010 -0700 @@ -22,7 +22,7 @@ ## @deftypefnx {Function File} {} flipdim (@var{x}, @var{dim}) ## Return a copy of @var{x} flipped about the dimension @var{dim}. ## @var{dim} defaults to the first non-singleton dimension. -## For example, +## For example: ## ## @example ## @group
--- a/scripts/general/fliplr.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/fliplr.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} fliplr (@var{x}) ## Return a copy of @var{x} with the order of the columns reversed. For -## example, +## example: ## ## @example ## @group
--- a/scripts/general/flipud.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/flipud.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} flipud (@var{x}) ## Return a copy of @var{x} with the order of the rows reversed. For -## example, +## example: ## ## @example ## @group
--- a/scripts/general/idivide.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/idivide.m Mon Jul 26 21:25:36 2010 -0700 @@ -31,12 +31,15 @@ ## @item "fix" ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards zero. +## ## @item "round" ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards the nearest integer. +## ## @item "floor" ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards negative infinity. +## ## @item "ceil" ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards positive infinity.
--- a/scripts/general/interp1.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/interp1.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,12 +35,16 @@ ## @table @asis ## @item 'nearest' ## Return the nearest neighbor. +## ## @item 'linear' ## Linear interpolation from nearest neighbors +## ## @item 'pchip' ## Piece-wise cubic hermite interpolating polynomial +## ## @item 'cubic' ## Cubic interpolation from four nearest neighbors +## ## @item 'spline' ## Cubic spline interpolation--smooth first and second derivatives ## throughout the curve
--- a/scripts/general/interp2.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/interp2.m Mon Jul 26 21:25:36 2010 -0700 @@ -54,12 +54,16 @@ ## @table @asis ## @item 'nearest' ## Return the nearest neighbor. +## ## @item 'linear' ## Linear interpolation from nearest neighbors. +## ## @item 'pchip' ## Piece-wise cubic Hermite interpolating polynomial. +## ## @item 'cubic' ## Cubic interpolation from four nearest neighbors. +## ## @item 'spline' ## Cubic spline interpolation--smooth first and second derivatives ## throughout the curve.
--- a/scripts/general/interp3.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/interp3.m Mon Jul 26 21:25:36 2010 -0700 @@ -44,10 +44,13 @@ ## @table @asis ## @item 'nearest' ## Return the nearest neighbor. +## ## @item 'linear' ## Linear interpolation from nearest neighbors. +## ## @item 'cubic' ## Cubic interpolation from four nearest neighbors (not implemented yet). +## ## @item 'spline' ## Cubic spline interpolation--smooth first and second derivatives ## throughout the curve.
--- a/scripts/general/interpn.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/interpn.m Mon Jul 26 21:25:36 2010 -0700 @@ -44,10 +44,13 @@ ## @table @asis ## @item 'nearest' ## Return the nearest neighbor. +## ## @item 'linear' ## Linear interpolation from nearest neighbors. +## ## @item 'cubic' ## Cubic interpolation from four nearest neighbors (not implemented yet). +## ## @item 'spline' ## Cubic spline interpolation--smooth first and second derivatives ## throughout the curve.
--- a/scripts/general/loadobj.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/loadobj.m Mon Jul 26 21:25:36 2010 -0700 @@ -22,7 +22,7 @@ ## The function @code{loadobj} is called when the object @var{a} is loaded ## using the @code{load} function. An example of the use of @code{saveobj} ## might be to add fields to an object that don't make sense to be saved. -## For example +## For example: ## ## @example ## @group
--- a/scripts/general/quadgk.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/quadgk.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,7 +35,7 @@ ## The bounds of the quadrature @code{[@var{a}, @var{b}]} can be finite ## or infinite and contain weak end singularities. Variable ## transformation will be used to treat infinite intervals and weaken -## the singularities. For example +## the singularities. For example: ## ## @example ## quadgk(@@(x) 1 ./ (sqrt (x) .* (x + 1)), 0, Inf) @@ -78,7 +78,7 @@ ## @code{"WayPoints"} property. This forces the ends of a sub-interval ## to fall on the breakpoints of the function and can result in ## significantly improved estimation of the error in the integral, faster -## computation or both. For example, +## computation or both. For example: ## ## @example ## quadgk (@@(x) abs (1 - x .^ 2), 0, 2, 'Waypoints', 1)
--- a/scripts/general/rat.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/rat.m Mon Jul 26 21:25:36 2010 -0700 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {[@var{n}, @var{d}] =} rat (@var{x}, @var{tol}) ## ## Find a rational approximation to @var{x} within the tolerance defined -## by @var{tol} using a continued fraction expansion. For example, +## by @var{tol} using a continued fraction expansion. For example: ## ## @example ## @group
--- a/scripts/general/saveobj.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/saveobj.m Mon Jul 26 21:25:36 2010 -0700 @@ -23,7 +23,7 @@ ## using the @code{save} function. An example of the use of @code{saveobj} ## might be to remove fields of the object that don't make sense to be saved ## or it might be used to ensure that certain fields of the object are -## initialized before the object is saved. For example +## initialized before the object is saved. For example: ## ## @example ## @group
--- a/scripts/general/shiftdim.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/general/shiftdim.m Mon Jul 26 21:25:36 2010 -0700 @@ -30,7 +30,7 @@ ## singleton dimensions, returning the number of dimensions removed ## in the second output argument @var{ns}. ## -## For example +## For example: ## ## @example ## @group
--- a/scripts/geometry/delaunayn.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/geometry/delaunayn.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,6 +35,7 @@ ## ## @itemize ## @item 2D and 3D: @var{opt} = @code{@{"Qt", "Qbb", "Qc"@}} +## ## @item 4D and higher: @var{opt} = @code{@{"Qt", "Qbb", "Qc", "Qz"@}} ## @end itemize ##
--- a/scripts/image/image_viewer.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/image/image_viewer.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,21 +35,27 @@ ## the filename of the image, and the @code{%f} will (if present) be ## replaced by the zoom factor given to the @code{image} function. ## For example, +## ## @example ## image_viewer ("eog %s"); ## @end example +## ## changes the image viewer to the @code{eog} program. ## ## With two input arguments, images will be displayed by calling ## the function @var{function_handle}. For example, +## ## @example ## image_viewer (data, @@my_image_viewer); ## @end example +## ## sets the image viewer function to @code{my_image_viewer}. The image ## viewer function is called with +## ## @example ## my_image_viewer (@var{x}, @var{y}, @var{im}, @var{zoom}, @var{data}) ## @end example +## ## where @var{x} and @var{y} are the axis of the image, @var{im} is the image ## variable, and @var{data} is extra user-supplied data to be passed to ## the viewer function.
--- a/scripts/image/imfinfo.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/image/imfinfo.m Mon Jul 26 21:25:36 2010 -0700 @@ -28,57 +28,79 @@ ## @table @samp ## @item Filename ## The full name of the image file. +## ## @item FileSize ## Number of bytes of the image on disk +## ## @item FileModDate ## Date of last modification to the file. +## ## @item Height ## Image height in pixels. +## ## @item Width ## Image Width in pixels. +## ## @item BitDepth ## Number of bits per channel per pixel. +## ## @item Format ## Image format (e.g., @code{"jpeg"}). +## ## @item LongFormat ## Long form image format description. +## ## @item XResolution ## X resolution of the image. +## ## @item YResolution ## Y resolution of the image. +## ## @item TotalColors ## Number of unique colors in the image. +## ## @item TileName ## Tile name. +## ## @item AnimationDelay ## Time in 1/100ths of a second (0 to 65535) which must expire before displaying ## the next image in an animated sequence. +## ## @item AnimationIterations ## Number of iterations to loop an animation (e.g., Netscape loop extension) ## for. +## ## @item ByteOrder ## Endian option for formats that support it. Is either @code{"little-endian"}, ## @code{"big-endian"}, or @code{"undefined"}. +## ## @item Gamma ## Gamma level of the image. The same color image displayed on two different ## workstations may look different due to differences in the display monitor. +## ## @item Matte ## @code{true} if the image has transparency. +## ## @item ModulusDepth ## Image modulus depth (minimum number of bits required to support ## red/green/blue ## components without loss of accuracy). +## ## @item Quality ## JPEG/MIFF/PNG compression level. +## ## @item QuantizeColors ## Preferred number of colors in the image. +## ## @item ResolutionUnits ## Units of image resolution. Is either @code{"pixels per inch"}, ## @code{"pixels per centimeter"}, or @code{"undefined"}. +## ## @item ColorType ## Image type. Is either @code{"grayscale"}, @code{"indexed"}, ## @code{"truecolor"}, ## or @code{"undefined"}. +## ## @item View ## FlashPix viewing parameters. ## @end table
--- a/scripts/io/csvread.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/io/csvread.m Mon Jul 26 21:25:36 2010 -0700 @@ -17,15 +17,17 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} csvread (@var{filename}) +## @deftypefn {Function File} {@var{x} =} csvread (@var{filename}) +## @deftypefnx {Function File} {@var{x} =} csvread (@var{filename}, @var{dlm_opts}) ## Read the comma-separated-value file @var{filename} into the matrix @var{x}. ## ## This function is equivalent to +## ## @example ## @var{x} = dlmread (@var{filename}, "," , @dots{}) ## @end example ## -## @seealso{dlmread, dlmwrite, csvwrite} +## @seealso{csvwrite, dlmread, dlmwrite} ## @end deftypefn function x = csvread (f, varargin)
--- a/scripts/io/csvwrite.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/io/csvwrite.m Mon Jul 26 21:25:36 2010 -0700 @@ -17,16 +17,18 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} csvwrite (@var{filename}, @var{x}) +## @deftypefn {Function File} {} csvwrite (@var{filename}, @var{x}) +## @deftypefnx {Function File} {} csvwrite (@var{filename}, @var{x}, @var{dlm_opts}) ## Write the matrix @var{x} to the file @var{filename} in ## @w{comma-separated-value} format. ## ## This function is equivalent to +## ## @example ## dlmwrite (@var{filename}, @var{x}, ",", @dots{}) ## @end example ## -## @seealso{dlmread, dlmwrite, csvread} +## @seealso{csvread, dlmwrite, dlmread} ## @end deftypefn function csvwrite (f, m, varargin)
--- a/scripts/io/strread.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/io/strread.m Mon Jul 26 21:25:36 2010 -0700 @@ -34,9 +34,11 @@ ## @table @code ## @item %s ## The word is parsed as a string. +## ## @item %d ## @itemx %f ## The word is parsed as a number. +## ## @item %* ## The word is skipped. ## @end table @@ -72,15 +74,20 @@ ## @itemize ## @item "shell" ## Everything from @code{#} characters to the nearest end-line is skipped. +## ## @item "c" ## Everything between @code{/*} and @code{*/} is skipped. +## ## @item "c++" ## Everything from @code{//} characters to the nearest end-line is skipped. +## ## @item "matlab" ## Everything from @code{%} characters to the nearest end-line is skipped. ## @end itemize +## ## @item "delimiter" ## Any character in @var{value} will be used to split @var{str} into words. +## ## @item "emptyvalue" ## Parts of the output where no word is available is filled with @var{value}. ## @end itemize
--- a/scripts/linear-algebra/condest.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/linear-algebra/condest.m Mon Jul 26 21:25:36 2010 -0700 @@ -34,10 +34,13 @@ ## @table @var ## @item apply ## @code{A*x} for a matrix @code{x} of size @var{n} by @var{t}. +## ## @item apply_t ## @code{A'*x} for a matrix @code{x} of size @var{n} by @var{t}. +## ## @item solve ## @code{A \ b} for a matrix @code{b} of size @var{n} by @var{t}. +## ## @item solve_t ## @code{A' \ b} for a matrix @code{b} of size @var{n} by @var{t}. ## @end table @@ -59,6 +62,7 @@ ## for Matrix 1-Norm Estimation, with an Application to 1-Norm ## Pseudospectra}. SIMAX vol 21, no 4, pp 1185-1201. ## @url{http://dx.doi.org/10.1137/S0895479899356080} +## ## @item ## N.J. Higham and F. Tisseur, @cite{A Block Algorithm ## for Matrix 1-Norm Estimation, with an Application to 1-Norm
--- a/scripts/linear-algebra/housh.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/linear-algebra/housh.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,8 +35,10 @@ ## @table @var ## @item x ## vector +## ## @item j ## index into vector +## ## @item z ## threshold for zero (usually should be the number 0) ## @end table @@ -47,6 +49,7 @@ ## @table @var ## @item beta ## If beta = 0, then no reflection need be applied (zer set to 0) +## ## @item housv ## householder vector ## @end table
--- a/scripts/linear-algebra/onenormest.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/linear-algebra/onenormest.m Mon Jul 26 21:25:36 2010 -0700 @@ -44,6 +44,7 @@ ## for Matrix 1-Norm Estimation, with an Application to 1-Norm ## Pseudospectra}. SIMAX vol 21, no 4, pp 1185-1201. ## @url{http://dx.doi.org/10.1137/S0895479899356080} +## ## @item ## N.J. Higham and F. Tisseur, @cite{A Block Algorithm ## for Matrix 1-Norm Estimation, with an Application to 1-Norm
--- a/scripts/linear-algebra/qzhess.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/linear-algebra/qzhess.m Mon Jul 26 21:25:36 2010 -0700 @@ -23,7 +23,7 @@ ## @code{(@var{a}, @var{b})}, returning ## @code{@var{aa} = @var{q} * @var{a} * @var{z}}, ## @code{@var{bb} = @var{q} * @var{b} * @var{z}}, with @var{q} and @var{z} -## orthogonal. For example, +## orthogonal. For example: ## ## @example ## @group
--- a/scripts/miscellaneous/bincoeff.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/bincoeff.m Mon Jul 26 21:25:36 2010 -0700 @@ -36,9 +36,9 @@ ## \ / ## @end group ## @end example +## ## @end ifnottex -## -## For example, +## For example: ## ## @example ## @group
--- a/scripts/miscellaneous/compare_versions.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/compare_versions.m Mon Jul 26 21:25:36 2010 -0700 @@ -37,21 +37,27 @@ ## @item ## "==" ## equal +## ## @item ## "<" ## less than +## ## @item ## "<=" ## less than or equal to +## ## @item ## ">" ## greater than +## ## @item ## ">=" ## greater than or equal to +## ## @item ## "!=" ## not equal +## ## @item ## "~=" ## not equal
--- a/scripts/miscellaneous/computer.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/computer.m Mon Jul 26 21:25:36 2010 -0700 @@ -21,7 +21,7 @@ ## Print or return a string of the form @var{cpu}-@var{vendor}-@var{os} ## that identifies the kind of computer Octave is running on. If invoked ## with an output argument, the value is returned instead of printed. For -## example, +## example: ## ## @example ## @group
--- a/scripts/miscellaneous/edit.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/edit.m Mon Jul 26 21:25:36 2010 -0700 @@ -77,8 +77,10 @@ ## @table @samp ## @item [EDITOR, " %s"] ## Use the editor which Octave uses for @code{bug_report}. +## ## @item "xedit %s &" ## pop up simple X11 editor in a separate window +## ## @item "gnudoit -q \"(find-file \\\"%s\\\")\"" ## Send it to current Emacs; must have @code{(gnuserv-start)} in @file{.emacs}. ## @end table @@ -86,10 +88,11 @@ ## See also field 'mode', which controls how the editor is run by Octave. ## ## On Cygwin, you will need to convert the Cygwin path to a Windows -## path if you are using a native Windows editor. For example -## @c Set example in small font to prevent overfull line +## path if you are using a native Windows editor. For example: +## @c Set example in small font to prevent overfull line in TeX +## ## @smallexample -## '"C:/Program Files/Good Editor/Editor.exe" "$(cygpath -wa %s)"' +## @exdent '"C:/Program Files/Good Editor/Editor.exe" "$(cygpath -wa %s)"' ## @end smallexample ## ## @item home @@ -110,10 +113,13 @@ ## @table @samp ## @item gpl ## GNU General Public License (default). +## ## @item bsd ## BSD-style license without advertising clause. +## ## @item pd ## Public domain. +## ## @item "text" ## Your own default copyright and license. ## @end table
--- a/scripts/miscellaneous/fileattrib.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/fileattrib.m Mon Jul 26 21:25:36 2010 -0700 @@ -26,24 +26,31 @@ ## @table @code ## @item Name ## Full name of @var{file}. +## ## @item archive ## True if @var{file} is an archive (Windows). +## ## @item system ## True if @var{file} is a system file (Windows). +## ## @item hidden ## True if @var{file} is a hidden file (Windows). +## ## @item directory ## True if @var{file} is a directory. +## ## @item UserRead ## @itemx GroupRead ## @itemx OtherRead ## True if the user (group; other users) has read permission for ## @var{file}. +## ## @item UserWrite ## @itemx GroupWrite ## @itemx OtherWrite ## True if the user (group; other users) has write permission for ## @var{file}. +## ## @item UserExecute ## @itemx GroupExecute ## @itemx OtherExecute
--- a/scripts/miscellaneous/getfield.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/getfield.m Mon Jul 26 21:25:36 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{v1}, @dots{}] =} getfield (@var{s}, @var{key}, @dots{}) -## Extract a field from a structure (or a nested structure). For example +## Extract a field from a structure (or a nested structure). For example: ## ## @example ## @group
--- a/scripts/miscellaneous/license.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/license.m Mon Jul 26 21:25:36 2010 -0700 @@ -39,6 +39,7 @@ ## @item "enable" ## Future tests for the specified license of @var{feature} are conducted ## as usual. +## ## @item "disable" ## Future tests for the specified license of @var{feature} return 0. ## @end table
--- a/scripts/miscellaneous/ls.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/ls.m Mon Jul 26 21:25:36 2010 -0700 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deffn {Command} ls options -## List directory contents. For example, +## List directory contents. For example: ## ## @example ## @group
--- a/scripts/miscellaneous/parseparams.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/parseparams.m Mon Jul 26 21:25:36 2010 -0700 @@ -22,7 +22,7 @@ ## @deftypefnx {Function File} {[@var{reg}, @var{var1}, @dots{}] =} parseparams (@var{params}, @var{name1}, @var{default1}, @dots{}) ## Return in @var{reg} the cell elements of @var{param} up to the first ## string element and in @var{prop} all remaining elements beginning -## with the first string element. For example +## with the first string element. For example: ## ## @example ## @group
--- a/scripts/miscellaneous/swapbytes.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/swapbytes.m Mon Jul 26 21:25:36 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} swapbytes (@var{x}) ## Swaps the byte order on values, converting from little endian to big -## endian and vice versa. For example +## endian and vice versa. For example: ## ## @example ## @group
--- a/scripts/miscellaneous/ver.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/ver.m Mon Jul 26 21:25:36 2010 -0700 @@ -29,10 +29,13 @@ ## @table @code ## @item Name ## Package name. +## ## @item Version ## Version of the package. +## ## @item Revision ## Revision of the package. +## ## @item Date ## Date respecting the version/revision. ## @end table
--- a/scripts/miscellaneous/warning_ids.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/miscellaneous/warning_ids.m Mon Jul 26 21:25:36 2010 -0700 @@ -117,7 +117,7 @@ ## @item Octave:empty-list-elements ## If the @code{Octave:empty-list-elements} warning is enabled, a ## warning is issued when an empty matrix is found in a matrix list. -## For example, +## For example: ## ## @example ## a = [1, [], 3, [], 5] @@ -183,6 +183,7 @@ ## @result{} "foo" ## @end group ## @end example +## ## elicits a warning if the @code{Octave:num-to-str} warning is ## enabled. By default, the @code{Octave:num-to-str} warning is enabled. ## @@ -219,12 +220,14 @@ ## If the @code{Octave:str-to-num} warning is enabled, a warning is printed ## for implicit conversions of strings to their numeric ASCII equivalents. ## For example, +## ## @example ## @group ## "abc" + 0 ## @result{} 97 98 99 ## @end group ## @end example +## ## elicits a warning if the @code{Octave:str-to-num} warning is enabled. ## By default, the @code{Octave:str-to-num} warning is disabled. ##
--- a/scripts/optimization/fminbnd.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/fminbnd.m Mon Jul 26 21:25:36 2010 -0700 @@ -36,8 +36,10 @@ ## @itemize ## @item 1 ## The algorithm converged to a solution. +## ## @item 0 ## Maximum number of iterations or function evaluations has been exhausted. +## ## @item -1 ## The algorithm has been terminated from user output function. ## @end itemize
--- a/scripts/optimization/fminunc.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/fminunc.m Mon Jul 26 21:25:36 2010 -0700 @@ -54,12 +54,16 @@ ## Converged to a solution point. Relative gradient error is less than ## specified ## by TolFun. +## ## @item 2 ## Last relative step size was less that TolX. +## ## @item 3 ## Last relative decrease in func value was less than TolF. +## ## @item 0 ## Iteration limit exceeded. +## ## @item -3 ## The trust region radius became excessively small. ## @end table
--- a/scripts/optimization/fsolve.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/fsolve.m Mon Jul 26 21:25:36 2010 -0700 @@ -22,7 +22,7 @@ ## @deftypefn {Function File} {} fsolve (@var{fcn}, @var{x0}, @var{options}) ## @deftypefnx {Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{fjac}] =} fsolve (@var{fcn}, @dots{}) ## Solve a system of nonlinear equations defined by the function @var{fcn}. -## @var{fcn} should accepts a vector (array) defining the unknown variables, +## @var{fcn} should accept a vector (array) defining the unknown variables, ## and return a vector of left-hand sides of the equations. Right-hand sides ## are defined to be zeros. ## In other words, this function attempts to determine a vector @var{x} such @@ -69,14 +69,17 @@ ## @table @asis ## @item 1 ## Converged to a solution point. Relative residual error is less than -## specified -## by TolFun. +## specified by TolFun. +## ## @item 2 ## Last relative step size was less that TolX. +## ## @item 3 ## Last relative decrease in residual was less than TolF. +## ## @item 0 ## Iteration limit exceeded. +## ## @item -3 ## The trust region radius became excessively small. ## @end table @@ -122,7 +125,6 @@ ## ## fsolve (@@user_func, x0, optimset ("OutputFcn", @@user_func, @dots{})) ## @end example -### ## @end deftypefn ## PKG_ADD: __all_opts__ ("fsolve"); @@ -161,7 +163,7 @@ complexeqn = strcmpi (optimget (options, "ComplexEqn", "off"), "on"); ## Get scaling matrix using the TypicalX option. If set to "auto", the - ## scaling matrix is estimated using the jacobian. + ## scaling matrix is estimated using the Jacobian. typicalx = optimget (options, "TypicalX"); if (isempty (typicalx)) typicalx = ones (n, 1); @@ -224,7 +226,7 @@ ## Calculate function value and Jacobian (possibly via FD). if (has_jac) [fvec, fjac] = fcn (reshape (x, xsiz)); - ## If the jacobian is sparse, disable Broyden updating. + ## If the Jacobian is sparse, disable Broyden updating. if (issparse (fjac)) updating = false; endif @@ -236,7 +238,7 @@ endif ## For square and overdetermined systems, we update a QR - ## factorization of the jacobian to avoid solving a full system in each + ## factorization of the Jacobian to avoid solving a full system in each ## step. In this case, we pass a triangular matrix to __dogleg__. useqr = updating && m >= n && n > 10; @@ -259,7 +261,7 @@ ## Rescale adaptively. ## FIXME: the original minpack used the following rescaling strategy: ## dg = max (dg, jcn); - ## but it seems not good if we start with a bad guess yielding jacobian + ## but it seems not good if we start with a bad guess yielding Jacobian ## columns with large norms that later decrease, because the corresponding ## variable will still be overscaled. So instead, we only give the old ## scaling a small momentum, but do not honor it. @@ -275,7 +277,7 @@ endif ## It also seems that in the case of fast (and inhomogeneously) changing - ## jacobian, the Broyden updates are of little use, so maybe we could + ## Jacobian, the Broyden updates are of little use, so maybe we could ## skip them if a big disproportional change is expected. The question is, ## of course, how to define the above terms :) @@ -399,7 +401,7 @@ endif endif - ## Criterion for recalculating jacobian. + ## Criterion for recalculating Jacobian. if (! updating || nfail == 2 || nsuciter < 2) break; endif @@ -415,7 +417,7 @@ u = (fvec1 - w); v = dg .* ((dg .* s) / sn); - ## update the jacobian + ## update the Jacobian fjac += u * v'; endif endwhile
--- a/scripts/optimization/fzero.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/fzero.m Mon Jul 26 21:25:36 2010 -0700 @@ -28,9 +28,11 @@ ## two-element vector specifying two points which bracket a zero. In ## other words, there must be a change in sign of the function between ## @var{x0}(1) and @var{x0}(2). More mathematically, the following must hold +## ## @example ## sign (@var{fun}(@var{x0}(1))) * sign (@var{fun}(@var{x0}(2))) <= 0 ## @end example +## ## If @var{x0} is a single scalar then several nearby and distant ## values are probed in an attempt to obtain a valid bracketing. If this ## is not successful, the function fails. @@ -47,10 +49,13 @@ ## @itemize ## @item 1 ## The algorithm converged to a solution. +## ## @item 0 ## Maximum number of iterations or function evaluations has been reached. +## ## @item -1 ## The algorithm has been terminated from user output function. +## ## @item -5 ## The algorithm may have converged to a singular point. ## @end itemize @@ -61,10 +66,13 @@ ## @itemize ## @item iterations ## Number of iterations through loop. +## ## @item nfev ## Number of function evaluations. +## ## @item bracketx ## A two-element vector with the final bracketing of the zero along the x-axis. +## ## @item brackety ## A two-element vector with the final bracketing of the zero along the y-axis. ## @end itemize
--- a/scripts/optimization/glpk.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/glpk.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,55 +20,55 @@ ## @deftypefn {Function File} {[@var{xopt}, @var{fmin}, @var{status}, @var{extra}] =} glpk (@var{c}, @var{a}, @var{b}, @var{lb}, @var{ub}, @var{ctype}, @var{vartype}, @var{sense}, @var{param}) ## Solve a linear program using the GNU @sc{glpk} library. Given three ## arguments, @code{glpk} solves the following standard LP: -## ## @tex ## $$ ## \min_x C^T x ## $$ ## @end tex ## @ifnottex +## ## @example ## min C'*x ## @end example +## ## @end ifnottex -## ## subject to -## ## @tex ## $$ ## Ax = b \qquad x \geq 0 ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## A*x = b ## x >= 0 ## @end group ## @end example +## ## @end ifnottex -## ## but may also solve problems of the form -## ## @tex ## $$ ## [ \min_x | \max_x ] C^T x ## $$ ## @end tex ## @ifnottex +## ## @example ## [ min | max ] C'*x ## @end example +## ## @end ifnottex -## ## subject to -## ## @tex ## $$ ## Ax [ = | \leq | \geq ] b \qquad LB \leq x \leq UB ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## A*x [ "=" | "<=" | ">=" ] b @@ -76,6 +76,7 @@ ## x <= UB ## @end group ## @end example +## ## @end ifnottex ## ## Input arguments: @@ -108,12 +109,16 @@ ## @table @code ## @item "F" ## A free (unbounded) constraint (the constraint is ignored). +## ## @item "U" ## An inequality constraint with an upper bound (@code{A(i,:)*x <= b(i)}). +## ## @item "S" ## An equality constraint (@code{A(i,:)*x = b(i)}). +## ## @item "L" ## An inequality with a lower bound (@code{A(i,:)*x >= b(i)}). +## ## @item "D" ## An inequality constraint with both upper and lower bounds ## (@code{A(i,:)*x >= -b(i)} @emph{and} (@code{A(i,:)*x <= b(i)}). @@ -124,6 +129,7 @@ ## @table @code ## @item "C" ## A continuous variable. +## ## @item "I" ## An integer variable. ## @end table @@ -146,10 +152,13 @@ ## @table @asis ## @item 0 ## No output. +## ## @item 1 ## Error messages only. +## ## @item 2 -## Normal output . +## Normal output. +## ## @item 3 ## Full output (includes informational messages). ## @end table @@ -159,8 +168,10 @@ ## @table @asis ## @item 0 ## No scaling. +## ## @item 1 ## Equilibration scaling. +## ## @item 2 ## Geometric mean scaling, then equilibration scaling. ## @end table @@ -170,6 +181,7 @@ ## @table @asis ## @item 0 ## Do not use the dual simplex. +## ## @item 1 ## If initial basic solution is dual feasible, use the dual simplex. ## @end table @@ -179,6 +191,7 @@ ## @table @asis ## @item 0 ## Textbook pricing. +## ## @item 1 ## Steepest edge pricing. ## @end table @@ -188,6 +201,7 @@ ## @table @asis ## @item 0 ## Report all primal and dual values "as is". +## ## @item 1 ## Replace tiny primal and dual values by exact zero. ## @end table @@ -208,8 +222,10 @@ ## @table @asis ## @item 0 ## Branch on the first variable. +## ## @item 1 ## Branch on the last variable. +## ## @item 2 ## Branch using a heuristic by Driebeck and Tomlin. ## @end table @@ -219,8 +235,10 @@ ## @table @asis ## @item 0 ## Depth first search. +## ## @item 1 ## Breadth first search. +## ## @item 2 ## Backtrack using the best projection heuristic. ## @end table @@ -235,9 +253,11 @@ ## @table @asis ## @item 1 ## Revised simplex method. +## ## @item 2 ## Interior point method. ## @end table +## ## @item save (default: 0) ## If this parameter is nonzero, save a copy of the problem in ## CPLEX LP format to the file @file{"outpb.lp"}. There is currently no @@ -311,8 +331,10 @@ ## @table @var ## @item xopt ## The optimizer (the value of the decision variables at the optimum). +## ## @item fopt ## The optimum value of the objective function. +## ## @item status ## Status of the optimization. ## @@ -377,15 +399,19 @@ ## @item 214 (@w{@code{LPX_E_NODFS}}) ## No dual feasible solution (LP presolver). ## @end table +## ## @item extra ## A data structure containing the following fields: ## @table @code ## @item lambda ## Dual variables. +## ## @item redcosts ## Reduced Costs. +## ## @item time ## Time (in seconds) used for solving LP/MIP problem. +## ## @item mem ## Memory (in bytes) used for solving LP/MIP problem (this is not ## available if the version of @sc{glpk} is 4.15 or later).
--- a/scripts/optimization/lsqnonneg.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/lsqnonneg.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,22 +35,27 @@ ## @item resnorm ## ## The squared 2-norm of the residual: norm(@var{c}*@var{x}-@var{d})^2 +## ## @item residual ## ## The residual: @var{d}-@var{c}*@var{x} +## ## @item exitflag ## ## An indicator of convergence. 0 indicates that the iteration count ## was exceeded, and therefore convergence was not reached; >0 indicates ## that the algorithm converged. (The algorithm is stable and will ## converge given enough iterations.) +## ## @item output ## ## A structure with two fields: ## @itemize @bullet ## @item "algorithm": The algorithm used ("nnls") +## ## @item "iterations": The number of iterations taken. ## @end itemize +## ## @item lambda ## ## Not implemented.
--- a/scripts/optimization/pqpnonneg.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/pqpnonneg.m Mon Jul 26 21:25:36 2010 -0700 @@ -34,19 +34,23 @@ ## @item minval ## ## The minimum attained model value, 1/2*xmin'*c*xmin + d'*xmin +## ## @item exitflag ## ## An indicator of convergence. 0 indicates that the iteration count ## was exceeded, and therefore convergence was not reached; >0 indicates ## that the algorithm converged. (The algorithm is stable and will ## converge given enough iterations.) +## ## @item output ## ## A structure with two fields: ## @itemize @bullet ## @item "algorithm": The algorithm used ("nnls") +## ## @item "iterations": The number of iterations taken. ## @end itemize +## ## @item lambda ## ## Not implemented.
--- a/scripts/optimization/qp.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/qp.m Mon Jul 26 21:25:36 2010 -0700 @@ -55,8 +55,8 @@ ## A_lb <= A_in*x <= A_ub ## @end group ## @end example +## ## @end ifnottex -## ## @noindent ## using a null-space active-set method. ## @@ -77,25 +77,36 @@ ## @end table ## @end table ## -## The value @var{info} is a structure with the following fields: +## @table @var +## @item info +## Structure containing run-time information about the algorithm. The +## following fields are defined: +## ## @table @code ## @item solveiter ## The number of iterations required to find the solution. +## ## @item info -## An integer indicating the status of the solution, as follows: +## An integer indicating the status of the solution. +## ## @table @asis ## @item 0 ## The problem is feasible and convex. Global solution found. +## ## @item 1 ## The problem is not convex. Local solution found. +## ## @item 2 ## The problem is not convex and unbounded. +## ## @item 3 ## Maximum number of iterations reached. +## ## @item 6 ## The problem is infeasible. ## @end table ## @end table +## @end table ## @end deftypefn ## PKG_ADD: __all_opts__ ("qp");
--- a/scripts/optimization/sqp.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/optimization/sqp.m Mon Jul 26 21:25:36 2010 -0700 @@ -54,8 +54,8 @@ ## lb <= x <= ub ## @end group ## @end example +## ## @end ifnottex -## ## @noindent ## using a successive quadratic programming method. ## @@ -119,7 +119,6 @@ ## function handles. The first element should point to the constraint ## function and the second should point to a function that computes the ## gradient of the constraint function: -## ## @tex ## $$ ## \Bigg( {\partial f(x) \over \partial x_1}, @@ -128,6 +127,7 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## [ d f(x) d f(x) d f(x) ] @@ -135,8 +135,8 @@ ## [ dx_1 dx_2 dx_N ] ## @end group ## @end example +## ## @end ifnottex -## ## The fifth and sixth arguments contain lower and upper bounds ## on @var{x}. These must be consistent with the equality and inequality ## constraints @var{g} and @var{h}. If the arguments are vectors then @@ -152,6 +152,7 @@ ## The default value is @code{eps}. ## ## The value returned in @var{info} may be one of the following: +## ## @table @asis ## @item 101 ## The algorithm terminated normally. @@ -163,8 +164,10 @@ ## delta @var{x}, ## @end ifnottex ## is less than @code{tol * norm (x)}. +## ## @item 102 ## The BFGS update failed. +## ## @item 103 ## The maximum number of iterations was reached. ## @end table
--- a/scripts/path/pathdef.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/path/pathdef.m Mon Jul 26 21:25:36 2010 -0700 @@ -25,7 +25,9 @@ ## ## @enumerate ## @item @file{~/.octaverc} +## ## @item @file{<octave-home>/@dots{}/<version>/m/startup/octaverc} +## ## @item Octave's path prior to changes by any octaverc. ## @end enumerate ## @seealso{path, addpath, rmpath, genpath, savepath, pathsep}
--- a/scripts/pkg/pkg.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/pkg/pkg.m Mon Jul 26 21:25:36 2010 -0700 @@ -24,11 +24,14 @@ ## be taken depending on the value of @var{command}. ## ## @table @samp +## ## @item install ## Install named packages. For example, +## ## @example ## pkg install image-1.0.0.tar.gz ## @end example +## ## @noindent ## installs the package found in the file @file{image-1.0.0.tar.gz}. ## @@ -63,122 +66,155 @@ ## ## @item uninstall ## Uninstall named packages. For example, +## ## @example ## pkg uninstall image ## @end example +## ## @noindent ## removes the @code{image} package from the system. If another installed ## package depends on the @code{image} package an error will be issued. ## The package can be uninstalled anyway by using the @option{-nodeps} option. +## ## @item load ## Add named packages to the path. After loading a package it is ## possible to use the functions provided by the package. For example, +## ## @example ## pkg load image ## @end example +## ## @noindent ## adds the @code{image} package to the path. It is possible to load all ## installed packages at once with the command +## ## @example ## pkg load all ## @end example +## ## @item unload ## Removes named packages from the path. After unloading a package it is ## no longer possible to use the functions provided by the package. ## This command behaves like the @code{load} command. +## ## @item list ## Show a list of the currently installed packages. By requesting one or two ## output argument it is possible to get a list of the currently installed ## packages. For example, +## ## @example ## installed_packages = pkg list; ## @end example +## ## @noindent ## returns a cell array containing a structure for each installed package. ## The command +## ## @example ## [@var{user_packages}, @var{system_packages}] = pkg list ## @end example +## ## @noindent ## splits the list of installed packages into those who are installed by ## the current user, and those installed by the system administrator. +## ## @item describe ## Show a short description of the named installed packages, with the option ## '-verbose' also list functions provided by the package, e.g.: +## ## @example ## pkg describe -verbose all ## @end example +## ## @noindent ## will describe all installed packages and the functions they provide. ## If one output is requested a cell of structure containing the ## description and list of functions of each package is returned as ## output rather than printed on screen: +## ## @example ## desc = pkg ("describe", "secs1d", "image") ## @end example +## ## @noindent ## If any of the requested packages is not installed, pkg returns an ## error, unless a second output is requested: +## ## @example ## [ desc, flag] = pkg ("describe", "secs1d", "image") ## @end example +## ## @noindent ## @var{flag} will take one of the values "Not installed", "Loaded" or ## "Not loaded" for each of the named packages. +## ## @item prefix ## Set the installation prefix directory. For example, +## ## @example ## pkg prefix ~/my_octave_packages ## @end example +## ## @noindent ## sets the installation prefix to @file{~/my_octave_packages}. ## Packages will be installed in this directory. ## ## It is possible to get the current installation prefix by requesting an -## output argument. For example, +## output argument. For example: +## ## @example ## p = pkg prefix ## @end example ## ## The location in which to install the architecture dependent files can be -## independent specified with an addition argument. For example +## independent specified with an addition argument. For example: ## ## @example ## pkg prefix ~/my_octave_packages ~/my_arch_dep_pkgs ## @end example +## ## @item local_list ## Set the file in which to look for information on the locally ## installed packages. Locally installed packages are those that are -## typically available only to the current user. For example +## typically available only to the current user. For example: +## ## @example ## pkg local_list ~/.octave_packages ## @end example +## ## It is possible to get the current value of local_list with the following +## ## @example ## pkg local_list ## @end example +## ## @item global_list ## Set the file in which to look for, for information on the globally ## installed packages. Globally installed packages are those that are -## typically available to all users. For example +## typically available to all users. For example: +## ## @example ## pkg global_list /usr/share/octave/octave_packages ## @end example +## ## It is possible to get the current value of global_list with the following +## ## @example ## pkg global_list ## @end example +## ## @item rebuild ## Rebuilds the package database from the installed directories. This can ## be used in cases where for some reason the package database is corrupted. ## It can also take the @option{-auto} and @option{-noauto} options to allow the -## autoloading state of a package to be changed. For example +## autoloading state of a package to be changed. For example, ## ## @example ## pkg rebuild -noauto image ## @end example ## ## will remove the autoloading status of the image package. +## ## @item build ## Builds a binary form of a package or packages. The binary file produced ## will itself be an Octave package that can be installed normally with
--- a/scripts/plot/__marching_cube__.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/__marching_cube__.m Mon Jul 26 21:25:36 2010 -0700 @@ -41,7 +41,7 @@ ## beyond other surface and geometry stuff at Paul Bourke's website ## @uref{http://local.wasp.uwa.edu.au/~pbourke/geometry/polygonise}. ## -## For example, +## For example: ## @example ## @group ## N = 20; @@ -57,7 +57,7 @@ ## @end example ## ## Instead of the @command{trimesh} function the @command{patch} -## function can be used to visualize the geometry. For example, +## function can be used to visualize the geometry. For example: ## ## @example ## @group
--- a/scripts/plot/axis.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/axis.m Mon Jul 26 21:25:36 2010 -0700 @@ -62,8 +62,10 @@ ## @table @code ## @item "square" ## Force a square aspect ratio. +## ## @item "equal" ## Force x distance to equal y-distance. +## ## @item "normal" ## Restore the balance. ## @end table @@ -75,8 +77,10 @@ ## @item "auto" ## Set the specified axes to have nice limits around the data ## or all if no axes are specified. +## ## @item "manual" ## Fix the current axes limits. +## ## @item "tight" ## Fix axes to the limits of the data. ## @end table @@ -91,14 +95,18 @@ ## @table @code ## @item "on" ## Turn tic marks and labels on for all axes. +## ## @item "off" ## Turn tic marks off for all axes. +## ## @item "tic[xyz]" ## Turn tic marks on for all axes, or turn them on for the ## specified axes and off for the remainder. +## ## @item "label[xyz]" ## Turn tic labels on for all axes, or turn them on for the ## specified axes and off for the remainder. +## ## @item "nolabel" ## Turn tic labels off for all axes. ## @end table @@ -111,6 +119,7 @@ ## @table @code ## @item "ij" ## Reverse y-axis, so lower values are nearer the top. +## ## @item "xy" ## Restore y-axis, so higher values are nearer the top. ## @end table
--- a/scripts/plot/colorbar.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/colorbar.m Mon Jul 26 21:25:36 2010 -0700 @@ -24,20 +24,28 @@ ## @table @asis ## @item "EastOutside" ## Place the colorbar outside the plot to the right. This is the default. +## ## @item "East" ## Place the colorbar inside the plot to the right. +## ## @item "WestOutside" ## Place the colorbar outside the plot to the left. +## ## @item "West" ## Place the colorbar inside the plot to the left. +## ## @item "NorthOutside" ## Place the colorbar above the plot. +## ## @item "North" ## Place the colorbar at the top of the plot. +## ## @item "SouthOutside" ## Place the colorbar under the plot. +## ## @item "South" ## Place the colorbar at the bottom of the plot. +## ## @item "Off", "None" ## Remove any existing colorbar from the plot. ## @end table
--- a/scripts/plot/contourc.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/contourc.m Mon Jul 26 21:25:36 2010 -0700 @@ -42,7 +42,7 @@ ## value is wanted, set @code{@var{vn} = [val, val]}; ## If @var{vn} is omitted it defaults to 10. ## -## For example, +## For example: ## @example ## @group ## x = 0:2;
--- a/scripts/plot/contourf.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/contourf.m Mon Jul 26 21:25:36 2010 -0700 @@ -47,6 +47,7 @@ ## ## The following example plots filled contours of the @code{peaks} ## function. +## ## @example ## @group ## [x, y, z] = peaks (50);
--- a/scripts/plot/cylinder.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/cylinder.m Mon Jul 26 21:25:36 2010 -0700 @@ -35,6 +35,7 @@ ## of axes. ## ## Examples: +## ## @example ## @group ## disp ("plotting a cone")
--- a/scripts/plot/ezplot.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/ezplot.m Mon Jul 26 21:25:36 2010 -0700 @@ -32,7 +32,7 @@ ## ## If @var{f} has two variables then @code{@var{f}(@var{x},@var{y}) = 0} ## is calculated over the meshed domain @code{-2*pi < @var{x} | @var{y} -## < 2*pi} with 60 by 60 in the mesh. For example +## < 2*pi} with 60 by 60 in the mesh. For example: ## ## @example ## ezplot (@@(@var{x}, @var{y}) @var{x} .^ 2 - @var{y} .^ 2 - 1)
--- a/scripts/plot/isocolors.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/isocolors.m Mon Jul 26 21:25:36 2010 -0700 @@ -43,7 +43,7 @@ ## change the colors of a patch that is given by the patch handle ## @var{p}. ## -## For example, +## For example: ## @example ## function [] = isofinish (p) ## set (gca, "PlotBoxAspectRatioMode", "manual", \
--- a/scripts/plot/isonormals.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/isonormals.m Mon Jul 26 21:25:36 2010 -0700 @@ -41,7 +41,7 @@ ## If no output argument is given then directly redraw the patch that is ## given by the patch handle @var{p}. ## -## For example, +## For example: ## @example ## function [] = isofinish (p) ## set (gca, "PlotBoxAspectRatioMode","manual","PlotBoxAspectRatio",[1 1 1]);
--- a/scripts/plot/legend.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/legend.m Mon Jul 26 21:25:36 2010 -0700 @@ -39,23 +39,33 @@ ## as follows: ## ## @multitable @columnfractions 0.06 0.14 0.80 +## ## @item @tab north @tab ## center top +## ## @item @tab south @tab ## center bottom +## ## @item @tab east @tab ## right center +## ## @item @tab west @tab ## left center +## ## @item @tab northeast @tab ## right top (default) +## ## @item @tab northwest @tab ## left top +## ## @item @tab southeast @tab ## right bottom +## ## @item @tab southwest @tab ## left bottom +## ## @item +## ## @item @tab outside @tab ## can be appended to any location string ## @end multitable @@ -65,15 +75,20 @@ ## @table @asis ## @item "show" ## Show legend on the plot +## ## @item "hide" ## @itemx "off" ## Hide legend on the plot +## ## @item "boxon" ## Show a box around legend +## ## @item "boxoff" ## Hide the box around legend +## ## @item "left" ## Place text to the left of the keys +## ## @item "right" ## Place text to the right of the keys ## @end table
--- a/scripts/plot/print.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/print.m Mon Jul 26 21:25:36 2010 -0700 @@ -36,18 +36,23 @@ ## @item -P@var{printer} ## Set the @var{printer} name to which the graph is sent if no ## @var{filename} is specified. +## ## @item -G@var{ghostscript_command} ## Specify the command for calling Ghostscript. For Unix and Windows, ## the defaults are 'gs' and 'gswin32c', respectively. +## ## @item -color ## @itemx -mono ## Monochrome or color lines. +## ## @item -solid ## @itemx -dashed ## Solid or dashed lines. +## ## @item -portrait ## @itemx -landscape ## Specify the orientation of the plot for printed output. +## ## @item -d@var{device} ## Output device, where @var{device} is one of: ## @table @code @@ -56,6 +61,7 @@ ## @itemx psc ## @itemx psc2 ## Postscript (level 1 and 2, mono and color) +## ## @item eps ## @itemx eps2 ## @itemx epsc @@ -71,39 +77,53 @@ ## processed directly by @LaTeX{}. The other formats are intended to ## be included in a @LaTeX{} (or @TeX{}) document. The @code{tex} device ## is the same as the @code{epslatex} device. +## ## @item tikz ## Generate a @LaTeX{} file using gnuplot's Lua/TikZ terminal. +## ## @item ill ## @itemx aifm ## Adobe Illustrator +## ## @item cdr ## @itemx @nospell{corel} ## CorelDraw +## ## @item dxf ## AutoCAD +## ## @item emf ## @itemx meta ## Microsoft Enhanced Metafile +## ## @item fig ## XFig. If this format is selected the additional options ## @option{-textspecial} or @option{-textnormal} can be used to control ## whether the special flag should be set for the text in ## the figure (default is @option{-textnormal}). +## ## @item hpgl ## HP plotter language +## ## @item mf ## Metafont +## ## @item png ## Portable network graphics +## ## @item jpg ## @itemx jpeg ## JPEG image +## ## @item gif ## GIF image +## ## @item pbm ## PBMplus +## ## @item svg ## Scalable vector graphics +## ## @item pdf ## Portable document format ## @end table @@ -118,16 +138,22 @@ ## @table @code ## @item ljet2p ## HP LaserJet IIP +## ## @item ljet3 ## HP LaserJet III +## ## @item deskjet ## HP DeskJet and DeskJet Plus +## ## @item cdj550 ## HP DeskJet 550C +## ## @item paintjet ## HP PointJet +## ## @item pcx24b ## 24-bit color PCX file format +## ## @item ppm ## Portable Pixel Map file format ## @end table
--- a/scripts/plot/refreshdata.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/refreshdata.m Mon Jul 26 21:25:36 2010 -0700 @@ -28,6 +28,7 @@ ## @table @code ## @item "base" ## Evaluate the datasource properties in the base workspace. (default). +## ## @item "caller" ## Evaluate the datasource properties in the workspace of the function ## that called @code{refreshdata}.
--- a/scripts/plot/slice.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/slice.m Mon Jul 26 21:25:36 2010 -0700 @@ -42,10 +42,13 @@ ## @table @code ## @item "nearest" ## Return the nearest neighbor. +## ## @item "linear" ## Linear interpolation from nearest neighbors. +## ## @item "cubic" ## Cubic interpolation from four nearest neighbors (not implemented yet). +## ## @item "spline" ## Cubic spline interpolation---smooth first and second derivatives ## throughout the curve. @@ -56,6 +59,7 @@ ## surface graphic objects. ## ## Examples: +## ## @example ## @group ## [x, y, z] = meshgrid (linspace (-8, 8, 32));
--- a/scripts/plot/subplot.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/subplot.m Mon Jul 26 21:25:36 2010 -0700 @@ -42,10 +42,9 @@ ## \vskip 10pt ## @end tex ## @ifnottex -## @display +## ## @example ## @group -## ## +-----+-----+-----+ ## | 1 | 2 | 3 | ## +-----+-----+-----+ @@ -53,7 +52,7 @@ ## +-----+-----+-----+ ## @end group ## @end example -## @end display +## ## @end ifnottex ## @seealso{plot} ## @end deftypefn
--- a/scripts/plot/surfl.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/plot/surfl.m Mon Jul 26 21:25:36 2010 -0700 @@ -40,8 +40,11 @@ ## @var{p} = [0.55 0.6 0.4 10]. ## @table @code ## @item "AM" strength of ambient light +## ## @item "D" strength of diffuse reflection +## ## @item "SP" strength of specular reflection +## ## @item "EXP" specular exponent ## @end table ##
--- a/scripts/polynomial/compan.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/compan.m Mon Jul 26 21:25:36 2010 -0700 @@ -47,8 +47,8 @@ ## |_ 0 0 @dots{} 1 0 _| ## @end group ## @end smallexample +## ## @end ifnottex -## ## The eigenvalues of the companion matrix are equal to the roots of the ## polynomial. ## @seealso{poly, roots, residue, conv, deconv, polyval, polyderiv,
--- a/scripts/polynomial/mpoles.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/mpoles.m Mon Jul 26 21:25:36 2010 -0700 @@ -32,7 +32,7 @@ ## The value @var{multp} is a vector specifying the multiplicity of the ## poles. @var{multp}(:) refers to multiplicity of @var{p}(@var{indx}(:)). ## -## For example, +## For example: ## ## @example ## @group
--- a/scripts/polynomial/poly.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/poly.m Mon Jul 26 21:25:36 2010 -0700 @@ -25,18 +25,21 @@ ## the characteristic polynomial of @var{a}. For example, ## the following code finds the eigenvalues of @var{a} which are the roots of ## @code{poly (@var{a})}. +## ## @example ## @group ## roots(poly(eye(3))) -## @result{} 1.00000 + 0.00000i -## @result{} 1.00000 - 0.00000i -## @result{} 1.00000 + 0.00000i +## @result{} 1.00001 + 0.00001i +## @result{} 1.00001 - 0.00001i +## @result{} 0.99999 + 0.00000i ## @end group ## @end example -## For numerical performance, however, the @code{eig} function -## should be used for computing eigenvalues. ## -## If @var{x} is a vector, @code{poly (@var{x})} is a vector of coefficients +## In fact, all three eigenvalues are exactly 1 which emphasizes that for +## numerical performance the @code{eig} function should be used to compute +## eigenvalues. +## +## If @var{x} is a vector, @code{poly (@var{x})} is a vector of the coefficients ## of the polynomial whose roots are the elements of @var{x}. That is, ## if @var{c} is a polynomial, then the elements of ## @code{@var{d} = roots (poly (@var{c}))} are contained in @var{c}.
--- a/scripts/polynomial/polyaffine.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/polyaffine.m Mon Jul 26 21:25:36 2010 -0700 @@ -17,8 +17,9 @@ ## @deftypefn {Function File} {} polyaffine (@var{f}, @var{mu}) ## Return the coefficients of the polynomial whose coefficients are given by ## vector @var{f} after an affine tranformation. If @var{f} is the vector -## representing the polynomial f(x), then @var{g} = polytrans (@var{f}, -## @var{mu}) is the vector representing +## representing the polynomial f(x), then @code{@var{g} = polyaffine (@var{f}, +## @var{mu})} is the vector representing +## ## @example ## g(x) = f((x-@var{mu}(1))/@var{mu}(2)). ## @end example @@ -34,11 +35,11 @@ endif if (! isvector (f)) - error ("polyaffine: first argument must be a vector."); + error ("polyaffine: F must be a vector."); endif if (! isvector (mu) || length (mu) != 2) - error ("polyaffine: second argument must be a two-element vector."); + error ("polyaffine: MU must be a two-element vector."); endif lf = length (f);
--- a/scripts/polynomial/polyfit.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/polyfit.m Mon Jul 26 21:25:36 2010 -0700 @@ -31,12 +31,16 @@ ## @table @samp ## @item R ## Triangular factor R from the QR decomposition. +## ## @item X ## The Vandermonde matrix used to compute the polynomial coefficients. +## ## @item df ## The degrees of freedom. +## ## @item normr ## The norm of the residuals. +## ## @item yf ## The values of the polynomial for each value of @var{x}. ## @end table
--- a/scripts/polynomial/polygcd.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/polygcd.m Mon Jul 26 21:25:36 2010 -0700 @@ -17,19 +17,19 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{q} =} polygcd (@var{b}, @var{a}, @var{tol}) +## @deftypefn {Function File} {@var{q} =} polygcd (@var{b}, @var{a}) +## @deftypefnx {Function File} {@var{q} =} polygcd (@var{b}, @var{a}, @var{tol}) ## -## Find greatest common divisor of two polynomials. This is equivalent +## Find the greatest common divisor of two polynomials. This is equivalent ## to the polynomial found by multiplying together all the common roots. ## Together with deconv, you can reduce a ratio of two polynomials. -## Tolerance defaults to -## @example -## sqrt(eps). -## @end example -## Note that this is an unstable -## algorithm, so don't try it on large polynomials. +## Tolerance defaults to @code{sqrt(eps)}. ## -## Example +## Note that this is a numerically unstable algorithm, and should not be used +## on large polynomials. +## +## Example: +## ## @example ## @group ## polygcd (poly(1:8), poly(3:12)) - poly(3:8)
--- a/scripts/polynomial/polyout.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/polyout.m Mon Jul 26 21:25:36 2010 -0700 @@ -26,9 +26,11 @@ ## $$ c(x) = c_1 x^n + \ldots + c_n x + c_{n+1} $$ ## @end tex ## @ifnottex +## ## @example ## c(x) = c(1) * x^n + @dots{} + c(n) x + c(n+1) ## @end example +## ## @end ifnottex ## and return it as a string or write it to the screen (if ## @var{nargout} is zero).
--- a/scripts/polynomial/residue.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/residue.m Mon Jul 26 21:25:36 2010 -0700 @@ -22,7 +22,6 @@ ## @deftypefn {Function File} {[@var{r}, @var{p}, @var{k}, @var{e}] =} residue (@var{b}, @var{a}) ## Compute the partial fraction expansion for the quotient of the ## polynomials, @var{b} and @var{a}. -## ## @tex ## $$ ## {B(s)\over A(s)} = \sum_{m=1}^M {r_m\over (s-p_m)^e_m} @@ -38,8 +37,8 @@ ## A(s) m=1 (s-p(m))^e(m) i=1 ## @end group ## @end example +## ## @end ifnottex -## ## @noindent ## where @math{M} is the number of poles (the length of the @var{r}, ## @var{p}, and @var{e}), the @var{k} vector is a polynomial of order @math{N-1} @@ -87,9 +86,9 @@ ## by @var{r}, @var{p} and @var{k}, and the pole multiplicity @var{e}. ## ## If the multiplicity, @var{e}, is not explicitly specified the multiplicity is -## determined by the script mpoles.m. +## determined by the function @code{mpoles}. ## -## For example, +## For example: ## ## @example ## @group @@ -100,7 +99,7 @@ ## @result{} b = [1, -5, 9, -3, 1] ## @result{} a = [1, -5, 8, -4] ## -## where mpoles.m is used to determine e = [1; 2; 1] +## where mpoles is used to determine e = [1; 2; 1] ## ## @end group ## @end example @@ -135,6 +134,7 @@ ## (s-2) (s-2)^2 (s-1) s^3 - 5s^2 + 8s - 4 ## @end group ## @end example +## ## @end ifnottex ## @seealso{poly, roots, conv, deconv, mpoles, polyval, polyderiv, polyint} ## @end deftypefn
--- a/scripts/polynomial/roots.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/roots.m Mon Jul 26 21:25:36 2010 -0700 @@ -32,6 +32,7 @@ ## @example ## v(1) * z^(N-1) + @dots{} + v(N-1) * z + v(N) ## @end example +## ## @end ifnottex ## ## As an example, the following code finds the roots of the quadratic @@ -40,10 +41,13 @@ ## $$ p(x) = x^2 - 5. $$ ## @end tex ## @ifnottex +## ## @example ## p(x) = x^2 - 5. ## @end example +## ## @end ifnottex +## ## @example ## @group ## c = [1, 0, -5]; @@ -52,6 +56,7 @@ ## @result{} -2.2361 ## @end group ## @end example +## ## Note that the true result is ## @tex ## $\pm \sqrt{5}$ @@ -127,7 +132,7 @@ %!assert(isempty (roots (1))); - %!error roots ([1, 2; 3, 4]); +%!error roots ([1, 2; 3, 4]); %!error roots ([1 Inf 1]);
--- a/scripts/polynomial/unmkpp.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/polynomial/unmkpp.m Mon Jul 26 21:25:36 2010 -0700 @@ -25,16 +25,20 @@ ## @table @asis ## @item @var{x} ## Sample points. +## ## @item @var{p} ## Polynomial coefficients for points in sample interval. @code{@var{p} ## (@var{i}, :)} contains the coefficients for the polynomial over ## interval @var{i} ordered from highest to lowest. If @code{@var{d} > ## 1}, @code{@var{p} (@var{r}, @var{i}, :)} contains the coefficients for ## the r-th polynomial defined on interval @var{i}. +## ## @item @var{n} ## Number of polynomial pieces. +## ## @item @var{k} ## Order of the polynomial plus 1. +## ## @item @var{d} ## Number of polynomials defined for each interval. ## @end table
--- a/scripts/set/union.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/set/union.m Mon Jul 26 21:25:36 2010 -0700 @@ -23,7 +23,7 @@ ## @deftypefnx {Function File} {} union (@var{a}, @var{b}, "rows") ## Return the set of elements that are in either of the sets @var{a} and ## @var{b}. @var{a}, @var{b} may be cell arrays of string(s). -## For example, +## For example: ## ## @example ## @group @@ -34,7 +34,8 @@ ## ## If the optional third input argument is the string "rows" each row of ## the matrices @var{a} and @var{b} will be considered an element of sets. -## For example, +## For example: +## ## @example ## @group ## union([1, 2; 2, 3], [1, 2; 3, 4], "rows")
--- a/scripts/signal/filter2.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/signal/filter2.m Mon Jul 26 21:25:36 2010 -0700 @@ -26,8 +26,10 @@ ## @table @asis ## @item 'full' ## pad @var{x} with zeros on all sides before filtering. +## ## @item 'same' ## unpadded @var{x} (default) +## ## @item 'valid' ## trim @var{x} after filtering so edge effects are no included. ## @end table
--- a/scripts/signal/stft.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/signal/stft.m Mon Jul 26 21:25:36 2010 -0700 @@ -29,8 +29,10 @@ ## @table @asis ## @item @nospell{hanning} ## w_type = 1 +## ## @item @nospell{hamming} ## w_type = 2 +## ## @item rectangle ## w_type = 3 ## @end table
--- a/scripts/sparse/spdiags.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/sparse/spdiags.m Mon Jul 26 21:25:36 2010 -0700 @@ -37,7 +37,7 @@ ## diagonal, and positive values of @var{c} diagonals above the main ## diagonal. ## -## For example +## For example: ## ## @example ## @group
--- a/scripts/specfun/bessel.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/specfun/bessel.m Mon Jul 26 21:25:36 2010 -0700 @@ -29,17 +29,21 @@ ## @item besselj ## Bessel functions of the first kind. If the argument @var{opt} is supplied, ## the result is multiplied by @code{exp(-abs(imag(x)))}. +## ## @item bessely ## Bessel functions of the second kind. If the argument @var{opt} is supplied, ## the result is multiplied by @code{exp(-abs(imag(x)))}. +## ## @item besseli ## Modified Bessel functions of the first kind. If the argument @var{opt} is ## supplied, ## the result is multiplied by @code{exp(-abs(real(x)))}. +## ## @item besselk ## Modified Bessel functions of the second kind. If the argument @var{opt} is ## supplied, ## the result is multiplied by @code{exp(x)}. +## ## @item besselh ## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} ## = 2) kind. If the argument @var{opt} is supplied, the result is multiplied @@ -64,15 +68,20 @@ ## @enumerate 0 ## @item ## Normal return. +## ## @item ## Input error, return @code{NaN}. +## ## @item ## Overflow, return @code{Inf}. +## ## @item ## Loss of significance by argument reduction results in less than ## half of machine accuracy. +## ## @item ## Complete loss of significance by argument reduction, return @code{NaN}. +## ## @item ## Error---no computation, algorithm termination condition not met, ## return @code{NaN}.
--- a/scripts/specfun/beta.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/specfun/beta.m Mon Jul 26 21:25:36 2010 -0700 @@ -30,6 +30,7 @@ ## @example ## beta (a, b) = gamma (a) * gamma (b) / gamma (a + b). ## @end example +## ## @end ifnottex ## @end deftypefn @@ -44,11 +45,11 @@ endif if (any (size (a) != size (b)) && numel (a) != 1 && numel (b) != 1) - error ("beta: inputs have inconsistent sizes"); + error ("beta: inputs A and B have inconsistent sizes"); endif if (! isreal (a) || ! isreal (b)) - error ("beta: inputs must be real"); + error ("beta: inputs A and B must be real"); endif retval = real (exp (gammaln (a) + gammaln (b) - gammaln (a+b)));
--- a/scripts/specfun/betaln.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/specfun/betaln.m Mon Jul 26 21:25:36 2010 -0700 @@ -29,6 +29,7 @@ ## @example ## betaln (a, b) = gammaln (a) + gammaln (b) - gammaln (a + b) ## @end example +## ## @end ifnottex ## @seealso{beta, betainc, gammaln} ## @end deftypefn
--- a/scripts/specfun/nchoosek.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/specfun/nchoosek.m Mon Jul 26 21:25:36 2010 -0700 @@ -23,7 +23,6 @@ ## Compute the binomial coefficient or all combinations of @var{n}. ## If @var{n} is a scalar then, calculate the binomial coefficient ## of @var{n} and @var{k}, defined as -## ## @tex ## $$ ## {n \choose k} = {n (n-1) (n-2) \cdots (n-k+1) \over k!} @@ -41,6 +40,7 @@ ## \ / ## @end group ## @end example +## ## @end ifnottex ## ## If @var{n} is a vector generate all combinations of the elements
--- a/scripts/specfun/nthroot.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/specfun/nthroot.m Mon Jul 26 21:25:36 2010 -0700 @@ -24,7 +24,7 @@ ## @deftypefn {Function File} {} nthroot (@var{x}, @var{n}) ## ## Compute the n-th root of @var{x}, returning real results for real -## components of @var{x}. For example +## components of @var{x}. For example: ## ## @example ## @group
--- a/scripts/specfun/perms.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/specfun/perms.m Mon Jul 26 21:25:36 2010 -0700 @@ -25,6 +25,7 @@ ## is the length of @var{v}. ## ## As an example, @code{perms([1, 2, 3])} returns the matrix +## ## @example ## @group ## 1 2 3
--- a/scripts/special-matrix/hadamard.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/special-matrix/hadamard.m Mon Jul 26 21:25:36 2010 -0700 @@ -33,13 +33,17 @@ ## @item ## @code{kron (@var{Hm}, @var{Hn})} is a Hadamard matrix of size ## @var{m}-by-@var{n}. +## ## @item ## @code{Hn * Hn' == @var{n} * eye (@var{n})}. +## ## @item ## The rows of @var{Hn} are orthogonal. +## ## @item ## @code{det (@var{A}) <= abs(det (@var{Hn}))} for all @var{A} with ## @code{abs (@var{A} (@var{i}, @var{j})) <= 1}. +## ## @item ## Multiply any row or column by -1 and still have a Hadamard matrix. ## @end itemize
--- a/scripts/special-matrix/hankel.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/special-matrix/hankel.m Mon Jul 26 21:25:36 2010 -0700 @@ -41,6 +41,7 @@ ## H(i,j) = r(i+j-m), otherwise ## @end group ## @end example +## ## @end ifnottex ## @seealso{vander, sylvester_matrix, hilb, invhilb, toeplitz} ## @end deftypefn
--- a/scripts/special-matrix/hilb.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/special-matrix/hilb.m Mon Jul 26 21:25:36 2010 -0700 @@ -37,6 +37,7 @@ ## @example ## H (i, j) = 1 / (i + j - 1) ## @end example +## ## @end ifnottex ## @seealso{hankel, vander, sylvester_matrix, invhilb, toeplitz} ## @end deftypefn
--- a/scripts/special-matrix/invhilb.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/special-matrix/invhilb.m Mon Jul 26 21:25:36 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} invhilb (@var{n}) -## Return the inverse of a Hilbert matrix of order @var{n}. This can be +## Return the inverse of the Hilbert matrix of order @var{n}. This can be ## computed exactly using ## @tex ## $$\eqalign{ @@ -33,9 +33,10 @@ ## $$ ## p(k) = -1^k \left( \matrix{ k+n-1 \cr k-1 } \right) ## \left( \matrix{ n \cr k } \right) -##$$ +## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## @@ -47,7 +48,9 @@ ## ## @end group ## @end example +## ## where +## ## @example ## @group ## k /k+n-1\ /n\ @@ -55,17 +58,17 @@ ## \ k-1 / \k/ ## @end group ## @end example +## ## @end ifnottex -## ## The validity of this formula can easily be checked by expanding ## the binomial coefficients in both formulas as factorials. It can -## be derived more directly via the theory of Cauchy matrices: -## see J. W. Demmel, @cite{Applied Numerical Linear Algebra}, p. 92. +## be derived more directly via the theory of Cauchy matrices. +## See J. W. Demmel, @cite{Applied Numerical Linear Algebra}, p. 92. ## ## Compare this with the numerical calculation of @code{inverse (hilb (n))}, ## which suffers from the ill-conditioning of the Hilbert matrix, and the ## finite precision of your computer's floating point arithmetic. -## @seealso{hankel, vander, sylvester_matrix, hilb, toeplitz} +## @seealso{hilb, hankel, vander, sylvester_matrix, toeplitz} ## @end deftypefn ## Author: Dirk Laurie <dlaurie@na-net.ornl.gov>
--- a/scripts/special-matrix/toeplitz.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/special-matrix/toeplitz.m Mon Jul 26 21:25:36 2010 -0700 @@ -44,12 +44,13 @@ ## c(0) r(1) r(2) @dots{} r(n) ## c(1) c(0) r(1) @dots{} r(n-1) ## c(2) c(1) c(0) @dots{} r(n-2) -## . , , . . -## . , , . . -## . , , . . +## . . . . . +## . . . . . +## . . . . . ## c(n) c(n-1) c(n-2) @dots{} c(0) ## @end group ## @end example +## ## @end ifnottex ## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb} ## @end deftypefn
--- a/scripts/special-matrix/vander.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/special-matrix/vander.m Mon Jul 26 21:25:36 2010 -0700 @@ -46,6 +46,7 @@ ## c(n)^(n-1) @dots{} c(n)^2 c(n) 1 ## @end group ## @end example +## ## @end ifnottex ## @seealso{hankel, sylvester_matrix, hilb, invhilb, toeplitz} ## @end deftypefn
--- a/scripts/statistics/base/cloglog.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/cloglog.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,16 +20,17 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} cloglog (@var{x}) ## Return the complementary log-log function of @var{x}, defined as -## ## @tex ## $$ ## {\rm cloglog}(x) = - \log (- \log (x)) ## $$ ## @end tex ## @ifnottex +## ## @example ## cloglog(x) = - log (- log (@var{x})) ## @end example +## ## @end ifnottex ## @end deftypefn
--- a/scripts/statistics/base/cor.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/cor.m Mon Jul 26 21:25:36 2010 -0700 @@ -31,11 +31,12 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## corrcoef(x,y) = cov(x,y)/(std(x)*std(y)) ## @end example +## ## @end ifnottex -## ## For matrices, each row is an observation and each column a variable; ## vectors are always observations and may be row or column vectors. ##
--- a/scripts/statistics/base/corrcoef.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/corrcoef.m Mon Jul 26 21:25:36 2010 -0700 @@ -32,11 +32,12 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## corrcoef(x,y) = cov(x,y)/(std(x)*std(y)) ## @end example +## ## @end ifnottex -## ## If called with one argument, compute @code{corrcoef (@var{x}, @var{x})}. ## @end deftypefn
--- a/scripts/statistics/base/kendall.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/kendall.m Mon Jul 26 21:25:36 2010 -0700 @@ -37,6 +37,7 @@ ## $$ \tau = {1 \over n(n-1)} \sum_{i,j} {\rm sign}(q_i-q_j) {\rm sign}(r_i-r_j) $$ ## @end tex ## @ifnottex +## ## @example ## @group ## 1 @@ -44,8 +45,8 @@ ## n (n-1) i,j ## @end group ## @end example +## ## @end ifnottex -## ## @noindent ## in which the ## @tex @@ -54,8 +55,7 @@ ## @ifnottex ## @var{q}(@var{i}) and @var{r}(@var{i}) ## @end ifnottex -## are the ranks of -## @var{x} and @var{y}, respectively. +## are the ranks of @var{x} and @var{y}, respectively. ## ## If @var{x} and @var{y} are drawn from independent distributions, ## Kendall's @var{tau} is asymptotically normal with mean 0 and variance
--- a/scripts/statistics/base/kurtosis.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/kurtosis.m Mon Jul 26 21:25:36 2010 -0700 @@ -31,13 +31,12 @@ ## @example ## kurtosis (x) = N^(-1) std(x)^(-4) sum ((x - mean(x)).^4) - 3 ## @end example +## ## @end ifnottex -## ## @noindent ## of @var{x}. If @var{x} is a matrix, return the kurtosis over the ## first non-singleton dimension. The optional argument @var{dim} -## can be given to force the kurtosis to be given over that -## dimension. +## can be given to force the kurtosis to be given over that dimension. ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/base/logit.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/logit.m Mon Jul 26 21:25:36 2010 -0700 @@ -26,9 +26,11 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## logit(@var{p}) = log (@var{p} / (1-@var{p})) ## @end example +## ## @end ifnottex ## @end deftypefn
--- a/scripts/statistics/base/mean.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/mean.m Mon Jul 26 21:25:36 2010 -0700 @@ -31,6 +31,7 @@ ## @example ## mean (x) = SUM_i x(i) / N ## @end example +## ## @end ifnottex ## If @var{x} is a matrix, compute the mean for each column and return them ## in a row vector.
--- a/scripts/statistics/base/median.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/median.m Mon Jul 26 21:25:36 2010 -0700 @@ -40,6 +40,7 @@ ## (x(N/2) + x((N/2)+1))/2, N even ## @end group ## @end example +## ## @end ifnottex ## If @var{x} is a matrix, compute the median value for each ## column and return them in a row vector. If the optional @var{dim}
--- a/scripts/statistics/base/quantile.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/quantile.m Mon Jul 26 21:25:36 2010 -0700 @@ -42,7 +42,9 @@ ## ## @enumerate 1 ## @item Method 1: Inverse of empirical distribution function. +## ## @item Method 2: Similar to method 1 but with averaging at discontinuities. +## ## @item Method 3: SAS definition: nearest even order statistic. ## @end enumerate ## @@ -51,12 +53,17 @@ ## ## @enumerate 4 ## @item Method 4: p(k) = k / n. That is, linear interpolation of the empirical cdf. +## ## @item Method 5: p(k) = (k - 0.5) / n. That is a piecewise linear function where ## the knots are the values midway through the steps of the empirical cdf. +## ## @item Method 6: p(k) = k / (n + 1). +## ## @item Method 7: p(k) = (k - 1) / (n - 1). +## ## @item Method 8: p(k) = (k - 1/3) / (n + 1/3). The resulting quantile estimates ## are approximately median-unbiased regardless of the distribution of @var{x}. +## ## @item Method 9: p(k) = (k - 3/8) / (n + 1/4). The resulting quantile estimates ## are approximately unbiased for the expected order statistics if @var{x} is ## normally distributed.
--- a/scripts/statistics/base/skewness.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/skewness.m Mon Jul 26 21:25:36 2010 -0700 @@ -31,6 +31,7 @@ ## @example ## skewness (x) = N^(-1) std(x)^(-3) sum ((x - mean(x)).^3) ## @end example +## ## @end ifnottex ## ## @noindent
--- a/scripts/statistics/base/std.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/std.m Mon Jul 26 21:25:36 2010 -0700 @@ -36,6 +36,7 @@ ## std (x) = sqrt (sumsq (x - mean (x)) / (n - 1)) ## @end group ## @end example +## ## @end ifnottex ## If @var{x} is a matrix, compute the standard deviation for ## each column and return them in a row vector. @@ -47,6 +48,7 @@ ## @item 0: ## normalizes with @math{N-1}, provides the square root of best unbiased ## estimator of the variance [default] +## ## @item 1: ## normalizes with @math{N}, this provides the square root of the second ## moment around the mean
--- a/scripts/statistics/base/var.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/base/var.m Mon Jul 26 21:25:36 2010 -0700 @@ -30,6 +30,7 @@ ## @item 0: ## Normalizes with @math{N-1}, provides the best unbiased estimator of the ## variance [default]. +## ## @item 1: ## Normalizes with @math{N}, this provides the second moment around the mean. ## @end table
--- a/scripts/statistics/distributions/kolmogorov_smirnov_cdf.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/distributions/kolmogorov_smirnov_cdf.m Mon Jul 26 21:25:36 2010 -0700 @@ -24,6 +24,7 @@ ## $$ Q(x) = \sum_{k=-\infty}^\infty (-1)^k \exp(-2 k^2 x^2) $$ ## @end tex ## @ifnottex +## ## @example ## @group ## Inf @@ -31,8 +32,8 @@ ## k = -Inf ## @end group ## @end example +## ## @end ifnottex -## ## @noindent ## for @var{x} > 0. ##
--- a/scripts/statistics/distributions/wblcdf.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/distributions/wblcdf.m Mon Jul 26 21:25:36 2010 -0700 @@ -21,15 +21,16 @@ ## Compute the cumulative distribution function (CDF) at @var{x} of the ## Weibull distribution with shape parameter @var{scale} and scale ## parameter @var{shape}, which is -## ## @tex ## $$ 1 - \exp(-(x/shape)^{scale}) $$ ## for $x\geq 0$. ## @end tex ## @ifnottex +## ## @example ## 1 - exp(-(x/shape)^scale) ## @end example +## ## for @var{x} @geq{} 0. ## @end ifnottex ## @end deftypefn
--- a/scripts/statistics/tests/cor_test.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/tests/cor_test.m Mon Jul 26 21:25:36 2010 -0700 @@ -42,14 +42,19 @@ ## @table @var ## @item pval ## The p-value of the test. +## ## @item stat ## The value of the test statistic. +## ## @item dist ## The distribution of the test statistic. +## ## @item params ## The parameters of the null distribution of the test statistic. +## ## @item alternative ## The alternative hypothesis. +## ## @item method ## The method used for testing. ## @end table
--- a/scripts/statistics/tests/hotelling_test_2.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/statistics/tests/hotelling_test_2.m Mon Jul 26 21:25:36 2010 -0700 @@ -25,18 +25,18 @@ ## (@var{x}) == mean (@var{y})}. ## ## Hotelling's two-sample @math{T^2} is returned in @var{tsq}. Under the null, -## ## @tex ## $$ ## {n_x+n_y-p-1) T^2 \over p(n_x+n_y-2)} ## $$ ## @end tex ## @ifnottex +## ## @example ## (n_x+n_y-p-1) T^2 / (p(n_x+n_y-2)) ## @end example +## ## @end ifnottex -## ## @noindent ## has an F distribution with @math{p} and @math{n_x+n_y-p-1} degrees of ## freedom, where @math{n_x} and @math{n_y} are the sample sizes and
--- a/scripts/strings/bin2dec.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/bin2dec.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} bin2dec (@var{s}) ## Return the decimal number corresponding to the binary number stored -## in the string @var{s}. For example, +## in the string @var{s}. For example: ## ## @example ## @group
--- a/scripts/strings/cstrcat.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/cstrcat.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} cstrcat (@var{s1}, @var{s2}, @dots{}) ## Return a string containing all the arguments concatenated -## horizontally. Trailing white space is preserved. For example, +## horizontally. Trailing white space is preserved. For example: ## ## @example ## @group
--- a/scripts/strings/dec2bin.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/dec2bin.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} dec2bin (@var{n}, @var{len}) ## Return a binary number corresponding to the non-negative decimal number -## @var{n}, as a string of ones and zeros. For example, +## @var{n}, as a string of ones and zeros. For example: ## ## @example ## @group
--- a/scripts/strings/dec2hex.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/dec2hex.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} dec2hex (@var{n}, @var{len}) ## Return the hexadecimal string corresponding to the non-negative -## integer @var{n}. For example, +## integer @var{n}. For example: ## ## @example ## @group
--- a/scripts/strings/findstr.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/findstr.m Mon Jul 26 21:25:36 2010 -0700 @@ -22,7 +22,7 @@ ## Return the vector of all positions in the longer of the two strings ## @var{s} and @var{t} where an occurrence of the shorter of the two starts. ## If the optional argument @var{overlap} is nonzero, the returned vector -## can include overlapping positions (this is the default). For example, +## can include overlapping positions (this is the default). For example: ## ## @example ## @group
--- a/scripts/strings/hex2dec.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/hex2dec.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} hex2dec (@var{s}) ## Return the integer corresponding to the hexadecimal number stored -## in the string @var{s}. For example, +## in the string @var{s}. For example: ## ## @example ## @group
--- a/scripts/strings/index.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/index.m Mon Jul 26 21:25:36 2010 -0700 @@ -21,7 +21,7 @@ ## @deftypefn {Function File} {} index (@var{s}, @var{t}) ## @deftypefnx {Function File} {} index (@var{s}, @var{t}, @var{direction}) ## Return the position of the first occurrence of the string @var{t} in the -## string @var{s}, or 0 if no occurrence is found. For example, +## string @var{s}, or 0 if no occurrence is found. For example: ## ## @example ## @group
--- a/scripts/strings/isstrprop.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/isstrprop.m Mon Jul 26 21:25:36 2010 -0700 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} isstrprop (@var{str}, @var{pred}) -## Test character string properties. For example, +## Test character string properties. For example: ## ## @example ## @group
--- a/scripts/strings/regexptranslate.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/regexptranslate.m Mon Jul 26 21:25:36 2010 -0700 @@ -28,6 +28,7 @@ ## The wildcard characters @code{.}, @code{*} and @code{?} are replaced ## with wildcards that are appropriate for a regular expression. ## For example: +## ## @example ## @group ## regexptranslate ("wildcard", "*.m") @@ -38,12 +39,14 @@ ## @item "escape" ## The characters @code{$.?[]}, that have special meaning for regular ## expressions are escaped so that they are treated literally. For example: +## ## @example ## @group ## regexptranslate ("escape", "12.5") ## @result{} "12\.5" ## @end group ## @end example +## ## @end table ## @seealso{regexp, regexpi, regexprep} ## @end deftypefn
--- a/scripts/strings/rindex.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/rindex.m Mon Jul 26 21:25:36 2010 -0700 @@ -21,7 +21,7 @@ ## @deftypefn {Function File} {} rindex (@var{s}, @var{t}) ## Return the position of the last occurrence of the character string ## @var{t} in the character string @var{s}, or 0 if no occurrence is -## found. For example, +## found. For example: ## ## @example ## @group @@ -30,7 +30,7 @@ ## @end group ## @end example ## -## @strong{Caution:} This function does not work for arrays of +## @strong{Caution:} This function does not work for arrays of ## character strings. ## @seealso{find, index} ## @end deftypefn
--- a/scripts/strings/strcat.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/strcat.m Mon Jul 26 21:25:36 2010 -0700 @@ -25,7 +25,7 @@ ## returns a cell string with the individual cells concatenated. ## For numerical input, each element is converted to the ## corresponding ASCII character. Trailing white space is eliminated. -## For example, +## For example: ## ## @example ## @group
--- a/scripts/strings/substr.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/strings/substr.m Mon Jul 26 21:25:36 2010 -0700 @@ -26,7 +26,7 @@ ## the string. If @var{len} is omitted, the substring extends to the end ## of S. ## -## For example, +## For example: ## ## @example ## @group
--- a/scripts/testfun/demo.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/testfun/demo.m Mon Jul 26 21:25:36 2010 -0700 @@ -59,7 +59,7 @@ ## use @code{eval(example('function',n))} to see them. Because eval only ## evaluates one line, or one statement if the statement crosses ## multiple lines, you must wrap your demo in "if 1 <demo stuff> endif" -## with the 'if' on the same line as 'demo'. For example, +## with the 'if' on the same line as 'demo'. For example: ## ## @example ## @group
--- a/scripts/time/asctime.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/time/asctime.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} asctime (@var{tm_struct}) ## Convert a time structure to a string using the following five-field -## format: Thu Mar 28 08:40:14 1996. For example, +## format: Thu Mar 28 08:40:14 1996. For example: ## ## @example ## @group
--- a/scripts/time/clock.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/time/clock.m Mon Jul 26 21:25:36 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} clock () ## Return a vector containing the current year, month (1-12), day (1-31), -## hour (0-23), minute (0-59) and second (0-61). For example, +## hour (0-23), minute (0-59) and second (0-61). For example: ## ## @example ## @group
--- a/scripts/time/ctime.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/time/ctime.m Mon Jul 26 21:25:36 2010 -0700 @@ -22,7 +22,7 @@ ## Convert a value returned from @code{time} (or any other non-negative ## integer), to the local time and return a string of the same form as ## @code{asctime}. The function @code{ctime (time)} is equivalent to -## @code{asctime (localtime (time))}. For example, +## @code{asctime (localtime (time))}. For example: ## ## @example ## @group
--- a/scripts/time/date.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/time/date.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} date () ## Return the date as a character string in the form DD-MMM-YY@. For -## example, +## example: ## ## @example ## @group
--- a/scripts/time/datenum.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/time/datenum.m Mon Jul 26 21:25:36 2010 -0700 @@ -33,14 +33,19 @@ ## @itemize ## @item ## Years can be negative and/or fractional. +## ## @item ## Months below 1 are considered to be January. +## ## @item ## Days of the month start at 1. +## ## @item ## Days beyond the end of the month go into subsequent months. +## ## @item ## Days before the beginning of the month go to the previous month. +## ## @item ## Days can be fractional. ## @end itemize
--- a/scripts/time/is_leap_year.m Mon Jul 26 07:41:23 2010 -0400 +++ b/scripts/time/is_leap_year.m Mon Jul 26 21:25:36 2010 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} is_leap_year (@var{year}) ## Return 1 if the given year is a leap year and 0 otherwise. If no ## arguments are provided, @code{is_leap_year} will use the current year. -## For example, +## For example: ## ## @example ## @group