Mercurial > octave-nkf
changeset 10793:be55736a0783
Grammarcheck the documentation from m-files.
line wrap: on
line diff
--- a/scripts/@ftp/ftp.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/@ftp/ftp.m Sun Jul 18 20:35:16 2010 -0700 @@ -14,7 +14,7 @@ ## along with this program; If not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{f}} = ftp (@var{host}) +## @deftypefn {Function File} {@var{f}} = ftp (@var{host}) ## @deftypefnx {Function File} {@var{f}} = ftp (@var{host}, @var{username}, ## @var{password}) ## Connect to the FTP server @var{host} with @var{username} and @var{password}. ## If @var{username} and @var{password} are not specified, user "anonymous"
--- a/scripts/@ftp/mget.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/@ftp/mget.m Sun Jul 18 20:35:16 2010 -0700 @@ -14,7 +14,7 @@ ## along with this program; If not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} mget (@var{f}, @var{file}) +## @deftypefn {Function File} {} mget (@var{f}, @var{file}) ## @deftypefnx {Function File} {} mget (@var{f}, @var{dir}) ## @deftypefnx {Function File} {} mget (@dots{}, @var{target}) ## Downloads a remote file @var{file} or directory @var{dir} to the local
--- a/scripts/ChangeLog Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/ChangeLog Sun Jul 18 20:35:16 2010 -0700 @@ -1,19 +1,161 @@ +2010-07-18 Rik <octave@nomad.inbox5.com> + + * scripts/@ftp/ftp.m, scripts/@ftp/mget.m, scripts/audio/lin2mu.m, + scripts/audio/loadaudio.m, scripts/audio/mu2lin.m, + scripts/audio/playaudio.m, scripts/audio/saveaudio.m, + scripts/audio/wavwrite.m, scripts/deprecated/create_set.m, + scripts/deprecated/intwarning.m, scripts/deprecated/lchol.m, + scripts/deprecated/spchol.m, scripts/deprecated/spdiag.m, + scripts/deprecated/spfind.m, scripts/deprecated/splchol.m, + scripts/deprecated/splu.m, scripts/deprecated/spmax.m, + scripts/deprecated/spmin.m, scripts/deprecated/spqr.m, + scripts/deprecated/weibcdf.m, scripts/deprecated/weibrnd.m, + scripts/general/accumarray.m, scripts/general/bitset.m, + scripts/general/colon.m, scripts/general/deal.m, scripts/general/del2.m, + scripts/general/genvarname.m, scripts/general/gradient.m, + scripts/general/interp1.m, scripts/general/interp2.m, + scripts/general/interp3.m, scripts/general/interpft.m, + scripts/general/interpn.m, scripts/general/nargchk.m, + scripts/general/nargoutchk.m, scripts/general/nextpow2.m, + scripts/general/num2str.m, scripts/general/pol2cart.m, + scripts/general/polyarea.m, scripts/general/prepad.m, + scripts/general/quadgk.m, scripts/general/quadl.m, + scripts/general/quadv.m, scripts/general/rat.m, + scripts/general/repmat.m, scripts/general/shiftdim.m, + scripts/general/structfun.m, scripts/general/trapz.m, + scripts/geometry/convhull.m, scripts/geometry/delaunay.m, + scripts/geometry/delaunay3.m, scripts/geometry/delaunayn.m, + scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m, + scripts/geometry/griddata.m, scripts/geometry/trimesh.m, + scripts/geometry/triplot.m, scripts/geometry/trisurf.m, + scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, + scripts/help/__makeinfo__.m, scripts/help/gen_doc_cache.m, + scripts/help/get_first_help_sentence.m, scripts/help/print_usage.m, + scripts/help/type.m, scripts/image/brighten.m, scripts/image/colormap.m, + scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, + scripts/image/imshow.m, scripts/image/imwrite.m, + scripts/image/ind2rgb.m, scripts/io/dlmwrite.m, scripts/io/fileread.m, + scripts/io/strread.m, scripts/io/textread.m, + scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, + scripts/linear-algebra/ishermitian.m, + scripts/linear-algebra/onenormest.m, scripts/miscellaneous/bzip2.m, + scripts/miscellaneous/dir.m, scripts/miscellaneous/dos.m, + scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, + scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/orderfields.m, + scripts/miscellaneous/parseparams.m, scripts/miscellaneous/perl.m, + scripts/miscellaneous/unix.m, scripts/miscellaneous/unpack.m, + scripts/miscellaneous/version.m, scripts/miscellaneous/zip.m, + scripts/optimization/fminbnd.m, scripts/optimization/fminunc.m, + scripts/optimization/fsolve.m, scripts/optimization/glpk.m, + scripts/optimization/glpkmex.m, scripts/optimization/lsqnonneg.m, + scripts/optimization/optimget.m, scripts/optimization/optimset.m, + scripts/optimization/pqpnonneg.m, + scripts/optimization/private/__fdjac__.m, scripts/optimization/qp.m, + scripts/pkg/get_forge_pkg.m, scripts/pkg/pkg.m, + scripts/plot/__fltk_print__.m, scripts/plot/__gnuplot_print__.m, + scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.m, + scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, + scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, + scripts/plot/clabel.m, scripts/plot/close.m, scripts/plot/colorbar.m, + scripts/plot/comet.m, scripts/plot/compass.m, scripts/plot/contour.m, + scripts/plot/contour3.m, scripts/plot/contourc.m, + scripts/plot/contourf.m, scripts/plot/cylinder.m, + scripts/plot/ellipsoid.m, scripts/plot/ezcontour.m, + scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, + scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, + scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, + scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, + scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, + scripts/plot/gcbo.m, scripts/plot/grid.m, scripts/plot/hggroup.m, + scripts/plot/hidden.m, scripts/plot/line.m, scripts/plot/meshgrid.m, + scripts/plot/ndgrid.m, scripts/plot/pareto.m, scripts/plot/patch.m, + scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, + scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/print.m, + scripts/plot/private/__actual_axis_position__.m, scripts/plot/quiver.m, + scripts/plot/quiver3.m, scripts/plot/refresh.m, scripts/plot/rose.m, + scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, + scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, + scripts/plot/subplot.m, scripts/plot/surfl.m, scripts/plot/surfnorm.m, + scripts/plot/text.m, scripts/plot/title.m, scripts/plot/view.m, + scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, + scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, + scripts/plot/zlim.m, scripts/polynomial/compan.m, + scripts/polynomial/mkpp.m, scripts/polynomial/mpoles.m, + scripts/polynomial/pchip.m, scripts/polynomial/ppder.m, + scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m, + scripts/polynomial/ppval.m, scripts/polynomial/spline.m, + scripts/set/intersect.m, scripts/set/powerset.m, scripts/set/setdiff.m, + scripts/set/setxor.m, scripts/set/union.m, scripts/set/unique.m, + scripts/signal/fftshift.m, scripts/signal/filter2.m, + scripts/signal/ifftshift.m, scripts/sparse/bicgstab.m, + scripts/sparse/cgs.m, scripts/sparse/etreeplot.m, + scripts/sparse/gplot.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, + scripts/sparse/spdiags.m, scripts/sparse/speye.m, + scripts/sparse/sprand.m, scripts/sparse/sprandn.m, + scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, + scripts/sparse/spy.m, scripts/sparse/treelayout.m, + scripts/sparse/treeplot.m, scripts/specfun/bessel.m, + scripts/specfun/legendre.m, scripts/specfun/pow2.m, + scripts/statistics/base/center.m, scripts/statistics/base/histc.m, + scripts/statistics/base/kendall.m, scripts/statistics/base/meansq.m, + scripts/statistics/base/prctile.m, scripts/statistics/base/quantile.m, + scripts/statistics/base/range.m, scripts/statistics/base/std.m, + scripts/statistics/base/table.m, + scripts/statistics/distributions/betacdf.m, + scripts/statistics/distributions/betarnd.m, + scripts/statistics/distributions/binornd.m, + scripts/statistics/distributions/cauchy_rnd.m, + scripts/statistics/distributions/chi2rnd.m, + scripts/statistics/distributions/discrete_rnd.m, + scripts/statistics/distributions/empirical_rnd.m, + scripts/statistics/distributions/exprnd.m, + scripts/statistics/distributions/fcdf.m, + scripts/statistics/distributions/frnd.m, + scripts/statistics/distributions/gamrnd.m, + scripts/statistics/distributions/geornd.m, + scripts/statistics/distributions/hygernd.m, + scripts/statistics/distributions/kolmogorov_smirnov_cdf.m, + scripts/statistics/distributions/laplace_rnd.m, + scripts/statistics/distributions/logistic_rnd.m, + scripts/statistics/distributions/lognrnd.m, + scripts/statistics/distributions/nbinrnd.m, + scripts/statistics/distributions/normrnd.m, + scripts/statistics/distributions/stdnormal_rnd.m, + scripts/statistics/distributions/tcdf.m, + scripts/statistics/distributions/trnd.m, + scripts/statistics/distributions/unidrnd.m, + scripts/statistics/distributions/unifcdf.m, + scripts/statistics/distributions/unifrnd.m, + scripts/statistics/distributions/wblcdf.m, + scripts/statistics/distributions/wblrnd.m, + scripts/statistics/tests/kolmogorov_smirnov_test.m, + scripts/statistics/tests/kolmogorov_smirnov_test_2.m, + scripts/statistics/tests/wilcoxon_test.m, scripts/strings/base2dec.m, + scripts/strings/index.m, scripts/strings/mat2str.m, + scripts/strings/strchr.m, scripts/strings/substr.m, + scripts/strings/validatestring.m, scripts/testfun/assert.m, + scripts/testfun/example.m, scripts/testfun/fail.m, + scripts/testfun/speed.m, scripts/testfun/test.m, + scripts/time/calendar.m, scripts/time/date.m, scripts/time/datenum.m, + scripts/time/datetick.m, scripts/time/datevec.m: + Grammarcheck documentation of m-files. + 2010-07-17 Rik <octave@nomad.inbox5.com> - * audio/lin2mu.m, general/common_size.m, general/interp1.m, - general/interp2.m, general/interpn.m, general/quadl.m, - geometry/dsearchn.m, geometry/voronoi.m, geometry/voronoin.m, - image/hsv2rgb.m, image/imread.m, image/rgb2hsv.m, - linear-algebra/commutation_matrix.m, linear-algebra/condest.m, - linear-algebra/expm.m, linear-algebra/krylov.m, - linear-algebra/onenormest.m, miscellaneous/perl.m, - plot/linkprop.m, plot/plot.m, plot/print.m, plot/stem3.m, - signal/diffpara.m, signal/stft.m, sparse/pcg.m, sparse/pcr.m, - specfun/primes.m, special-matrix/hadamard.m, special-matrix/hankel.m, - special-matrix/invhilb.m, special-matrix/pascal.m, - special-matrix/rosser.m, special-matrix/toeplitz.m, - special-matrix/vander.m, special-matrix/wilkinson.m, - testfun/speed.m: Spellcheck documentation + * audio/lin2mu.m, general/common_size.m, general/interp1.m, + general/interp2.m, general/interpn.m, general/quadl.m, + geometry/dsearchn.m, geometry/voronoi.m, geometry/voronoin.m, + image/hsv2rgb.m, image/imread.m, image/rgb2hsv.m, + linear-algebra/commutation_matrix.m, linear-algebra/condest.m, + linear-algebra/expm.m, linear-algebra/krylov.m, + linear-algebra/onenormest.m, miscellaneous/perl.m, + plot/linkprop.m, plot/plot.m, plot/print.m, plot/stem3.m, + signal/diffpara.m, signal/stft.m, sparse/pcg.m, sparse/pcr.m, + specfun/primes.m, special-matrix/hadamard.m, special-matrix/hankel.m, + special-matrix/invhilb.m, special-matrix/pascal.m, + special-matrix/rosser.m, special-matrix/toeplitz.m, + special-matrix/vander.m, special-matrix/wilkinson.m, + testfun/speed.m: Spellcheck documentation 2010-07-15 Jaroslav Hajek <highegg@gmail.com>
--- a/scripts/audio/lin2mu.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/audio/lin2mu.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,13 +18,15 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} lin2mu (@var{x}, @var{n}) -## Converts audio data from linear to mu-law. Mu-law values use 8-bit +## @deftypefn {Function File} {} lin2mu (@var{x}) +## @deftypefnx {Function File} {} lin2mu (@var{x}, @var{n}) +## Convert audio data from linear to mu-law. Mu-law values use 8-bit ## unsigned integers. Linear values use @var{n}-bit signed integers or -## floating point values in the range -1@leq{}@var{x}<=1 if @var{n} is 0. -## If @var{n} is not specified it defaults to 0, 8 or 16 depending on -## the range values in @var{x}. -## @seealso{mu2lin, loadaudio, saveaudio, playaudio, setaudio, record} +## floating point values in the range -1 @leq{} @var{x} @leq{} 1 if +## @var{n} is 0. +## If @var{n} is not specified it defaults to 0, 8, or 16 depending on +## the range of values in @var{x}. +## @seealso{mu2lin, loadaudio, saveaudio} ## @end deftypefn @@ -32,32 +34,32 @@ ## Created: 17 October 1994 ## Adapted-By: jwe -function y = lin2mu (x, bit) +function y = lin2mu (x, n) if (nargin == 1) range = max (abs (x (:))); if (range <= 1) - bit = 0; + n = 0; elseif (range <= 128) - bit = 8; - warning ("lin2mu: no precision specified, so using %d", bit); + n = 8; + warning ("lin2mu: no precision specified, so using %d", n); else - bit = 16; + n = 16; endif elseif (nargin == 2) - if (bit != 0 && bit != 8 && bit != 16) - error ("lin2mu: bit must be either 0, 8 or 16"); + if (n != 0 && n != 8 && n != 16) + error ("lin2mu: n must be either 0, 8 or 16"); endif else print_usage (); endif ## Transform real and n-bit format to 16-bit. - if (bit == 0) + if (n == 0) ## [-1,1] -> [-32768, 32768] x = 32768 * x; - elseif (bit != 16) - x = 2^(16-bit) .* x; + elseif (n != 16) + x = 2^(16-n) .* x; endif ## Determine sign of x, set sign(0) = 1.
--- a/scripts/audio/loadaudio.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/audio/loadaudio.m Sun Jul 18 20:35:16 2010 -0700 @@ -23,7 +23,7 @@ ## vector @var{x}. ## ## The extension @var{ext} determines how the data in the audio file is -## interpreted; the extensions @file{lin} (default) and @file{raw} +## interpreted; the extensions @file{lin} (default) and @file{raw} ## correspond to linear, the extensions @file{au}, @file{mu}, or @file{snd} ## to mu-law encoding. ##
--- a/scripts/audio/mu2lin.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/audio/mu2lin.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,25 +19,25 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} mu2lin (@var{x}, @var{bps}) -## Converts audio data from linear to mu-law. Mu-law values are 8-bit +## Convert audio data from mu-law to linear. Mu-law values are 8-bit ## unsigned integers. Linear values use @var{n}-bit signed integers -## or floating point values in the range -1<=y<=1 if @var{n} is 0. If +## or floating point values in the range -1@leq{}y@leq{}1 if @var{n} is 0. If ## @var{n} is not specified it defaults to 8. -## @seealso{lin2mu, loadaudio, saveaudio, playaudio, setaudio, record} +## @seealso{lin2mu, loadaudio, saveaudio} ## @end deftypefn ## Author: Andreas Weingessel <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 18 October 1994 ## Adapted-By: jwe -function y = mu2lin (x, bit) +function y = mu2lin (x, n) if (nargin == 1) - ## COMPATIBILITY -- bps defaults to 8 for octave, 0 for Matlab - bit = 8; + ## COMPATIBILITY -- bps defaults to 8 for Octave, 0 for Matlab + n = 8; elseif (nargin == 2) - if (bit != 0 && bit != 8 && bit != 16) - error ("mu2lin: bit must be either 0, 8 or 16"); + if (n != 0 && n != 8 && n != 16) + error ("mu2lin: n must be either 0, 8, or 16"); endif else print_usage (); @@ -68,10 +68,10 @@ y(:) = ulaw (x + 1); ## Convert to real or 8-bit. - if (bit == 0) + if (n == 0) ## [ -32768, 32767 ] -> [ -1, 1) y = y/32768; - elseif (bit == 8) + elseif (n == 8) ld = max (abs (y (:))); if (ld < 16384 && ld > 0) sc = 64 / ld;
--- a/scripts/audio/playaudio.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/audio/playaudio.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} playaudio (@var{name}, @var{ext}) +## @deftypefn {Function File} {} playaudio (@var{name}, @var{ext}) ## @deftypefnx {Function File} {} playaudio (@var{x}) ## Plays the audio file @file{@var{name}.@var{ext}} or the audio data ## stored in the vector @var{x}.
--- a/scripts/audio/saveaudio.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/audio/saveaudio.m Sun Jul 18 20:35:16 2010 -0700 @@ -22,7 +22,7 @@ ## Saves a vector @var{x} of audio data to the file ## @file{@var{name}.@var{ext}}. The optional parameters @var{ext} and ## @var{bps} determine the encoding and the number of bits per sample used -## in the audio file (see @code{loadaudio}); defaults are @file{lin} and +## in the audio file (see @code{loadaudio}); defaults are @file{lin} and ## 8, respectively. ## @seealso{lin2mu, mu2lin, loadaudio, playaudio, setaudio, record} ## @end deftypefn
--- a/scripts/audio/wavwrite.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/audio/wavwrite.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} wavwrite (@var{y}, @var{filename}) +## @deftypefn {Function File} {} wavwrite (@var{y}, @var{filename}) ## @deftypefnx {Function File} {} wavwrite (@var{y}, @var{fs}, @var{filename}) ## @deftypefnx {Function File} {} wavwrite (@var{y}, @var{fs}, @var{bits}, @var{filename}) ## Write @var{y} to the canonical RIFF/WAVE sound file @var{filename}
--- a/scripts/deprecated/create_set.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/create_set.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,8 +18,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} create_set (@var{x}) -## @deftypefnx{Function File} {} create_set (@var{x}, "rows") +## @deftypefn {Function File} {} create_set (@var{x}) +## @deftypefnx {Function File} {} create_set (@var{x}, "rows") ## This function has been deprecated. Use unique instead. ## @end deftypefn
--- a/scripts/deprecated/intwarning.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/intwarning.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} intwarning (@var{action}) +## @deftypefn {Function File} {} intwarning (@var{action}) ## @deftypefnx {Function File} {} intwarning (@var{s}) ## @deftypefnx {Function File} {@var{s} =} intwarning (@dots{}) ## Control the state of the warning for integer conversions and math
--- a/scripts/deprecated/lchol.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/lchol.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {@var{l} =} lchol (@var{a}) +## @deftypefn {Loadable Function} {@var{l} =} lchol (@var{a}) ## @deftypefnx {Loadable Function} {[@var{l}, @var{p}] =} lchol (@var{a}) ## This function has been deprecated. Use @code{chol (@dots{},'lower')} ## instead.
--- a/scripts/deprecated/spchol.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/spchol.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {@var{r} =} spchol (@var{a}) +## @deftypefn {Loadable Function} {@var{r} =} spchol (@var{a}) ## @deftypefnx {Loadable Function} {[@var{r}, @var{p}] =} spchol (@var{a}) ## @deftypefnx {Loadable Function} {[@var{r}, @var{p}, @var{q}] =} spchol (@var{a}) ## This function has been deprecated. Use @code{chol} instead.
--- a/scripts/deprecated/spdiag.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/spdiag.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} spdiag (@var{v}, @var{k}) -## This function has been deprecated. Use @code{sparse (diag (@dots{}))} instead. +## This function has been deprecated. Use @code{sparse (diag (@dots{}))} +## instead. ## @end deftypefn ## Deprecated in version 3.2
--- a/scripts/deprecated/spfind.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/spfind.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {} spfind (@var{x}) +## @deftypefn {Loadable Function} {} spfind (@var{x}) ## @deftypefnx {Loadable Function} {} spfind (@var{x}, @var{n}) ## @deftypefnx {Loadable Function} {} spfind (@var{x}, @var{n}, @var{direction}) ## @deftypefnx {Loadable Function} {[@var{i}, @var{j}, @var{v}} spfind (@dots{})
--- a/scripts/deprecated/splchol.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/splchol.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {@var{l} =} splchol (@var{a}) +## @deftypefn {Loadable Function} {@var{l} =} splchol (@var{a}) ## @deftypefnx {Loadable Function} {[@var{l}, @var{p}] =} splchol (@var{a}) ## @deftypefnx {Loadable Function} {[@var{l}, @var{p}, @var{q}] =} splchol (@var{a}) ## This function has been deprecated. Use @code{chol (@dots{},'lower')}
--- a/scripts/deprecated/splu.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/splu.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {[@var{l}, @var{u}] =} splu (@var{a}) +## @deftypefn {Loadable Function} {[@var{l}, @var{u}] =} splu (@var{a}) ## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}] =} splu (@var{a}) ## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}, @var{Q}] =} splu (@var{a}) ## @deftypefnx {Loadable Function} {[@var{l}, @var{u}, @var{P}, @var{Q}] =} splu (@dots{}, @var{thres})
--- a/scripts/deprecated/spmax.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/spmax.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} spmax (@var{x}, @var{y}, @var{dim}) +## @deftypefn {Mapping Function} {} spmax (@var{x}, @var{y}, @var{dim}) ## @deftypefnx {Mapping Function} {[@var{w}, @var{iw}] =} spmax (@var{x}) ## This function has been deprecated. Use @code{max} instead. ## @end deftypefn
--- a/scripts/deprecated/spmin.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/spmin.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} spmin (@var{x}, @var{y}, @var{dim}) +## @deftypefn {Mapping Function} {} spmin (@var{x}, @var{y}, @var{dim}) ## @deftypefnx {Mapping Function} {[@var{w}, @var{iw}] =} spmin (@var{x}) ## This function has been deprecated. Use @code{min} instead. ## @end deftypefn
--- a/scripts/deprecated/spqr.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/spqr.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {@var{r} =} spqr (@var{a}) +## @deftypefn {Loadable Function} {@var{r} =} spqr (@var{a}) ## @deftypefnx {Loadable Function} {@var{r} =} spqr (@var{a},0) ## @deftypefnx {Loadable Function} {[@var{c}, @var{r}] =} spqr (@var{a},@var{b}) ## @deftypefnx {Loadable Function} {[@var{c}, @var{r}] =} spqr (@var{a},@var{b},0)
--- a/scripts/deprecated/weibcdf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/weibcdf.m Sun Jul 18 20:35:16 2010 -0700 @@ -27,7 +27,7 @@ ## @end example ## ## @noindent -## for @var{x} >= 0. +## for @var{x} @geq{} 0. ## @end deftypefn ## Deprecated in version 3.0
--- a/scripts/deprecated/weibrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/deprecated/weibrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{r}, @var{c}) +## @deftypefn {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the ## Weibull distribution with parameters @var{scale} and @var{shape}
--- a/scripts/general/accumarray.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/accumarray.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} accumarray (@var{subs}, @var{vals}, @var{sz}, @var{func}, @var{fillval}, @var{issparse}) +## @deftypefn {Function File} {} accumarray (@var{subs}, @var{vals}, @var{sz}, @var{func}, @var{fillval}, @var{issparse}) ## @deftypefnx {Function File} {} accumarray (@var{csubs}, @var{vals}, @dots{}) ## ## Create an array by accumulating the elements of a vector into the @@ -53,8 +53,10 @@ ## @end group ## @end example ## -## The complexity in the non-sparse case is generally O(M+N), where N is the number of -## subscripts and M is the maximum subscript (linearized in multidimensional case). +## The complexity in the non-sparse case is generally O(M+N), where N is the +## number of +## subscripts and M is the maximum subscript (linearized in multi-dimensional +## case). ## If @var{func} is one of @code{@@sum} (default), @code{@@max}, @code{@@min} ## or @code{@@(x) @{x@}}, an optimized code path is used. ## Note that for general reduction function the interpreter overhead can play a
--- a/scripts/general/bitset.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/bitset.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} bitset (@var{a}, @var{n}) +## @deftypefn {Function File} {@var{x} =} bitset (@var{a}, @var{n}) ## @deftypefnx {Function File} {@var{x} =} bitset (@var{a}, @var{n}, @var{v}) ## Set or reset bit(s) @var{n} of unsigned integers in @var{a}. ## @var{v} = 0 resets and @var{v} = 1 sets the bits.
--- a/scripts/general/colon.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/colon.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{r} =} colon (@var{a}, @var{b}) +## @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.
--- a/scripts/general/deal.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/deal.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a}) +## @deftypefn {Function File} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a}) ## @deftypefnx {Function File} {[@var{r1}, @var{r2}, @dots{}, @var{rn}] =} deal (@var{a1}, @var{a2}, @dots{}, @var{an}) ## ## Copy the input parameters into the corresponding output parameters.
--- a/scripts/general/del2.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/del2.m Sun Jul 18 20:35:16 2010 -0700 @@ -44,16 +44,17 @@ ## @end example ## @end ifnottex ## -## For N-dimensional arrays the sum in parentheses is expanded to include second derivatives +## For N-dimensional arrays the sum in parentheses is expanded to include second +## 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, -## the spacing in each dimension may be defined separately by @var{dx}, @var{dy}, -## etc. A scalar spacing argument defines equidistant spacing, whereas a vector -## argument can be used to specify variable spacing. The length of the spacing vectors -## must match the respective dimension of @var{m}. The default spacing value -## is 1. +## the spacing in each dimension may be defined separately by @var{dx}, +## @var{dy}, etc. A scalar spacing argument defines equidistant spacing, +## whereas a vector argument can be used to specify variable spacing. The +## length of the spacing vectors must match the respective dimension of +## @var{m}. The default spacing value is 1. ## ## At least 3 data points are needed for each dimension. Boundary points are ## calculated from the linear extrapolation of interior points.
--- a/scripts/general/genvarname.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/genvarname.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{varname} =} genvarname (@var{str}) +## @deftypefn {Function File} {@var{varname} =} genvarname (@var{str}) ## @deftypefnx {Function File} {@var{varname} =} genvarname (@var{str}, @var{exclusions}) ## Create unique variable(s) from @var{str}. If @var{exclusions} is ## given, then the variable(s) will be unique to each other and to
--- a/scripts/general/gradient.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/gradient.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{dx} =} gradient (@var{m}) +## @deftypefn {Function File} {@var{dx} =} gradient (@var{m}) ## @deftypefnx {Function File} {[@var{dx}, @var{dy}, @var{dz}, @dots{}] =} gradient (@var{m}) ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{s}) ## @deftypefnx {Function File} {[@dots{}] =} gradient (@var{m}, @var{x}, @var{y}, @var{z}, @dots{}) @@ -38,8 +38,10 @@ ## @var{s} parameter. If @var{s} is a scalar, it is assumed to be the spacing ## for all dimensions. ## Otherwise, separate values of the spacing can be supplied by -## the @var{x}, @dots{} arguments. Scalar values specify an equidistant spacing. -## Vector values for the @var{x}, @dots{} arguments specify the coordinate for that +## the @var{x}, @dots{} arguments. Scalar values specify an equidistant +## spacing. +## Vector values for the @var{x}, @dots{} arguments specify the coordinate for +## that ## dimension. The length must match their respective dimension of @var{m}. ## ## At boundary points a linear extrapolation is applied. Interior points
--- a/scripts/general/interp1.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/interp1.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{yi} =} interp1 (@var{x}, @var{y}, @var{xi}) +## @deftypefn {Function File} {@var{yi} =} interp1 (@var{x}, @var{y}, @var{xi}) ## @deftypefnx {Function File} {@var{yi} =} interp1 (@dots{}, @var{method}) ## @deftypefnx {Function File} {@var{yi} =} interp1 (@dots{}, @var{extrap}) ## @deftypefnx {Function File} {@var{pp} =} interp1 (@dots{}, 'pp')
--- a/scripts/general/interp2.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/interp2.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{zi} =} interp2 (@var{x}, @var{y}, @var{z}, @var{xi}, @var{yi}) +## @deftypefn {Function File} {@var{zi} =} interp2 (@var{x}, @var{y}, @var{z}, @var{xi}, @var{yi}) ## @deftypefnx {Function File} {@var{zi} =} interp2 (@var{Z}, @var{xi}, @var{yi}) ## @deftypefnx {Function File} {@var{zi} =} interp2 (@var{Z}, @var{n}) ## @deftypefnx {Function File} {@var{zi} =} interp2 (@dots{}, @var{method})
--- a/scripts/general/interp3.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/interp3.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{vi} =} interp3 (@var{x}, @var{y},@var{z}, @var{v}, @var{xi}, @var{yi}, @var{zi}) +## @deftypefn {Function File} {@var{vi} =} interp3 (@var{x}, @var{y},@var{z}, @var{v}, @var{xi}, @var{yi}, @var{zi}) ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}, @var{xi}, @var{yi}, @var{zi}) ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}, @var{m}) ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v})
--- a/scripts/general/interpft.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/interpft.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} interpft (@var{x}, @var{n}) +## @deftypefn {Function File} {} interpft (@var{x}, @var{n}) ## @deftypefnx {Function File} {} interpft (@var{x}, @var{n}, @var{dim}) ## ## Fourier interpolation. If @var{x} is a vector, then @var{x} is
--- a/scripts/general/interpn.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/interpn.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{vi} =} interpn (@var{x1}, @var{x2}, @dots{}, @var{v}, @var{y1}, @var{y2}, @dots{}) +## @deftypefn {Function File} {@var{vi} =} interpn (@var{x1}, @var{x2}, @dots{}, @var{v}, @var{y1}, @var{y2}, @dots{}) ## @deftypefnx {Function File} {@var{vi} =} interpn (@var{v}, @var{y1}, @var{y2}, @dots{}) ## @deftypefnx {Function File} {@var{vi} =} interpn (@var{v}, @var{m}) ## @deftypefnx {Function File} {@var{vi} =} interpn (@var{v})
--- a/scripts/general/nargchk.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/nargchk.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{msgstr} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}) +## @deftypefn {Function File} {@var{msgstr} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}) ## @deftypefnx {Function File} {@var{msgstr} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}, "string") ## @deftypefnx {Function File} {@var{msgstruct} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}, "struct") ## Return an appropriate error message string (or structure) if the
--- a/scripts/general/nargoutchk.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/nargoutchk.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{msgstr} =} nargoutchk (@var{minargs}, @var{maxargs}, @var{nargs}) +## @deftypefn {Function File} {@var{msgstr} =} nargoutchk (@var{minargs}, @var{maxargs}, @var{nargs}) ## @deftypefnx {Function File} {@var{msgstr} =} nargoutchk (@var{minargs}, @var{maxargs}, @var{nargs}, "string") ## @deftypefnx {Function File} {@var{msgstruct} =} nargoutchk (@var{minargs}, @var{maxargs}, @var{nargs}, "struct") ## Return an appropriate error message string (or structure) if the
--- a/scripts/general/nextpow2.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/nextpow2.m Sun Jul 18 20:35:16 2010 -0700 @@ -24,7 +24,7 @@ ## $2^n \ge |x|$. ## @end tex ## @ifnottex -## 2^n >= abs (x). +## 2^n @geq{} abs (x). ## @end ifnottex ## ## If @var{x} is a vector, return @code{nextpow2 (length (@var{x}))}.
--- a/scripts/general/num2str.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/num2str.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} num2str (@var{x}) +## @deftypefn {Function File} {} num2str (@var{x}) ## @deftypefnx {Function File} {} num2str (@var{x}, @var{precision}) ## @deftypefnx {Function File} {} num2str (@var{x}, @var{format}) ## Convert a number (or array) to a string (or a character array). The
--- a/scripts/general/pol2cart.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/pol2cart.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{x}, @var{y}] =} pol2cart (@var{theta}, @var{r}) ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} pol2cart (@var{theta}, @var{r}, @var{z}) -## @deftypefnx {Function File} {[@var{x}, @var{y}] =} pol2cart (@var{p}) +## @deftypefnx {Function File} {[@var{x}, @var{y}] =} pol2cart (@var{p}) ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} pol2cart (@var{p}) ## @deftypefnx {Function File} {@var{C} =} pol2cart (@dots{}) ## Transform polar or cylindrical to Cartesian coordinates.
--- a/scripts/general/polyarea.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/polyarea.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} polyarea (@var{x}, @var{y}) +## @deftypefn {Function File} {} polyarea (@var{x}, @var{y}) ## @deftypefnx {Function File} {} polyarea (@var{x}, @var{y}, @var{dim}) ## ## Determines area of a polygon by triangle method. The variables
--- a/scripts/general/prepad.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/prepad.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} prepad (@var{x}, @var{l}, @var{c}) +## @deftypefn {Function File} {} prepad (@var{x}, @var{l}, @var{c}) ## @deftypefnx {Function File} {} prepad (@var{x}, @var{l}, @var{c}, @var{dim}) ## Prepend (append) the scalar value @var{c} to the vector @var{x} ## until it is of length @var{l}. If the third argument is not
--- a/scripts/general/quadgk.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/quadgk.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} quadgk (@var{f}, @var{a}, @var{b}, @var{abstol}, @var{trace}) +## @deftypefn {Function File} {} quadgk (@var{f}, @var{a}, @var{b}, @var{abstol}, @var{trace}) ## @deftypefnx {Function File} {} quadgk (@var{f}, @var{a}, @var{b}, @var{prop}, @var{val}, @dots{}) ## @deftypefnx {Function File} {[@var{q}, @var{err}] =} quadgk (@dots{}) ## Numerically evaluate integral using adaptive Gauss-Konrod quadrature.
--- a/scripts/general/quadl.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/quadl.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{q} =} quadl (@var{f}, @var{a}, @var{b}) +## @deftypefn {Function File} {@var{q} =} quadl (@var{f}, @var{a}, @var{b}) ## @deftypefnx {Function File} {@var{q} =} quadl (@var{f}, @var{a}, @var{b}, @var{tol}) ## @deftypefnx {Function File} {@var{q} =} quadl (@var{f}, @var{a}, @var{b}, @var{tol}, @var{trace}) ## @deftypefnx {Function File} {@var{q} =} quadl (@var{f}, @var{a}, @var{b}, @var{tol}, @var{trace}, @var{p1}, @var{p2}, @dots{})
--- a/scripts/general/quadv.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/quadv.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{q} =} quadv (@var{f}, @var{a}, @var{b}) +## @deftypefn {Function File} {@var{q} =} quadv (@var{f}, @var{a}, @var{b}) ## @deftypefnx {Function File} {@var{q} =} quadv (@var{f}, @var{a}, @var{b}, @var{tol}) ## @deftypefnx {Function File} {@var{q} =} quadv (@var{f}, @var{a}, @var{b}, @var{tol}, @var{trace}) ## @deftypefnx {Function File} {@var{q} =} quadv (@var{f}, @var{a}, @var{b}, @var{tol}, @var{trace}, @var{p1}, @var{p2}, @dots{})
--- a/scripts/general/rat.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/rat.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{s} =} rat (@var{x}, @var{tol}) +## @deftypefn {Function File} {@var{s} =} rat (@var{x}, @var{tol}) ## @deftypefnx {Function File} {[@var{n}, @var{d}] =} rat (@var{x}, @var{tol}) ## ## Find a rational approximation to @var{x} within the tolerance defined
--- a/scripts/general/repmat.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/repmat.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} repmat (@var{A}, @var{m}, @var{n}) +## @deftypefn {Function File} {} repmat (@var{A}, @var{m}, @var{n}) ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n}]) ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} @dots{}]) ## Form a block matrix of size @var{m} by @var{n}, with a copy of matrix
--- a/scripts/general/shiftdim.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/shiftdim.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{y} =} shiftdim (@var{x}, @var{n}) +## @deftypefn {Function File} {@var{y} =} shiftdim (@var{x}, @var{n}) ## @deftypefnx {Function File} {[@var{y}, @var{ns}] =} shiftdim (@var{x}) ## Shifts the dimension of @var{x} by @var{n}, where @var{n} must be ## an integer scalar. When @var{n} is positive, the dimensions of
--- a/scripts/general/structfun.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/structfun.m Sun Jul 18 20:35:16 2010 -0700 @@ -34,9 +34,11 @@ ## a string value. If the function returns more than one argument, they are ## returned as separate output variables. ## -## If the parameter "UniformOutput" is set to true (the default), then the function +## If the parameter "UniformOutput" is set to true (the default), then the +## function ## must return a single element which will be concatenated into the -## return value. If "UniformOutput" is false, the outputs are placed into a structure +## return value. If "UniformOutput" is false, the outputs are placed into a +## structure ## with the same fieldnames as the input structure. ## ## @example
--- a/scripts/general/trapz.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/general/trapz.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{z} =} trapz (@var{y}) +## @deftypefn {Function File} {@var{z} =} trapz (@var{y}) ## @deftypefnx {Function File} {@var{z} =} trapz (@var{x}, @var{y}) ## @deftypefnx {Function File} {@var{z} =} trapz (@dots{}, @var{dim}) ##
--- a/scripts/geometry/convhull.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/convhull.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{H} =} convhull (@var{x}, @var{y}) +## @deftypefn {Function File} {@var{H} =} convhull (@var{x}, @var{y}) ## @deftypefnx {Function File} {@var{H} =} convhull (@var{x}, @var{y}, @var{opt}) ## Returns the index vector to the points of the enclosing convex hull. The ## data points are defined by the x and y vectors.
--- a/scripts/geometry/delaunay.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/delaunay.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{tri} =} delaunay (@var{x}, @var{y}) +## @deftypefn {Function File} {@var{tri} =} delaunay (@var{x}, @var{y}) ## @deftypefnx {Function File} {@var{tri} =} delaunay (@var{x}, @var{y}, @var{opt}) ## The return matrix of size [n, 3] contains a set triangles which are ## described by the indices to the data point x and y vector.
--- a/scripts/geometry/delaunay3.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/delaunay3.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{T} =} delaunay3 (@var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {@var{T} =} delaunay3 (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {@var{T} =} delaunay3 (@var{x}, @var{y}, @var{z}, @var{opt}) ## A matrix of size [n, 4] is returned. Each row contains a ## set of tetrahedron which are
--- a/scripts/geometry/delaunayn.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/delaunayn.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{T} =} delaunayn (@var{P}) +## @deftypefn {Function File} {@var{T} =} delaunayn (@var{P}) ## @deftypefnx {Function File} {@var{T} =} delaunayn (@var{P}, @var{opt}) ## Form the Delaunay triangulation for a set of points. ## The Delaunay triangulation is a tessellation of the convex hull of the
--- a/scripts/geometry/dsearch.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/dsearch.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{idx} =} dsearch (@var{x}, @var{y}, @var{tri}, @var{xi}, @var{yi}) +## @deftypefn {Function File} {@var{idx} =} dsearch (@var{x}, @var{y}, @var{tri}, @var{xi}, @var{yi}) ## @deftypefnx {Function File} {@var{idx} =} dsearch (@var{x}, @var{y}, @var{tri}, @var{xi}, @var{yi}, @var{s}) ## Returns the index @var{idx} or the closest point in @code{@var{x}, @var{y}} ## to the elements @code{[@var{xi}(:), @var{yi}(:)]}. The variable @var{s} is
--- a/scripts/geometry/dsearchn.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/dsearchn.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{idx} =} dsearchn (@var{x}, @var{tri}, @var{xi}) +## @deftypefn {Function File} {@var{idx} =} dsearchn (@var{x}, @var{tri}, @var{xi}) ## @deftypefnx {Function File} {@var{idx} =} dsearchn (@var{x}, @var{tri}, @var{xi}, @var{outval}) ## @deftypefnx {Function File} {@var{idx} =} dsearchn (@var{x}, @var{xi}) ## @deftypefnx {Function File} {[@var{idx}, @var{d}] =} dsearchn (@dots{})
--- a/scripts/geometry/griddata.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/griddata.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{zi} =} griddata (@var{x}, @var{y}, @var{z}, @var{xi}, @var{yi}, @var{method}) +## @deftypefn {Function File} {@var{zi} =} griddata (@var{x}, @var{y}, @var{z}, @var{xi}, @var{yi}, @var{method}) ## @deftypefnx {Function File} {[@var{xi}, @var{yi}, @var{zi}] =} griddata (@var{x}, @var{y}, @var{z}, @var{xi}, @var{yi}, @var{method}) ## ## Generate a regular mesh from irregular data using interpolation.
--- a/scripts/geometry/trimesh.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/trimesh.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,9 +17,9 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} trimesh (@var{tri}, @var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {} trimesh (@var{tri}, @var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {@var{h} =} trimesh (@dots{}) -## Plot a triangular mesh in 3D. The variable @var{tri} is the triangular +## Plot a triangular mesh in 3D@. The variable @var{tri} is the triangular ## meshing of the points @code{(@var{x}, @var{y})} which is returned ## from @code{delaunay}. The variable @var{z} is value at the point ## @code{(@var{x}, @var{y})}. The output argument @var{h} is the graphic
--- a/scripts/geometry/triplot.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/triplot.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,10 +17,10 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} triplot (@var{tri}, @var{x}, @var{y}) +## @deftypefn {Function File} {} triplot (@var{tri}, @var{x}, @var{y}) ## @deftypefnx {Function File} {} triplot (@var{tri}, @var{x}, @var{y}, @var{linespec}) ## @deftypefnx {Function File} {@var{h} =} triplot (@dots{}) -## Plot a triangular mesh in 2D. The variable @var{tri} is the triangular +## Plot a triangular mesh in 2D@. The variable @var{tri} is the triangular ## meshing of the points @code{(@var{x}, @var{y})} which is returned from ## @code{delaunay}. If given, the @var{linespec} determines the properties ## to use for the lines. The output argument @var{h} is the graphic handle
--- a/scripts/geometry/trisurf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/trisurf.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,9 +17,9 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} trisurf (@var{tri}, @var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {} trisurf (@var{tri}, @var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {@var{h} =} trisurf (@dots{}) -## Plot a triangular surface in 3D. The variable @var{tri} is the triangular +## Plot a triangular surface in 3D@. The variable @var{tri} is the triangular ## meshing of the points @code{(@var{x}, @var{y})} which is returned ## from @code{delaunay}. The variable @var{z} is value at the point ## @code{(@var{x}, @var{y})}. The output argument @var{h} is the graphic
--- a/scripts/geometry/voronoi.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/voronoi.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,13 +17,14 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} voronoi (@var{x}, @var{y}) +## @deftypefn {Function File} {} voronoi (@var{x}, @var{y}) ## @deftypefnx {Function File} {} voronoi (@var{x}, @var{y}, "plotstyle") ## @deftypefnx {Function File} {} voronoi (@var{x}, @var{y}, "plotstyle", @var{options}) ## @deftypefnx {Function File} {[@var{vx}, @var{vy}] =} voronoi (@dots{}) ## plots Voronoi diagram of points @code{(@var{x}, @var{y})}. ## The Voronoi facets with points at infinity are not drawn. -## [@var{vx}, @var{vy}] = voronoi(@dots{}) returns the vertices instead of plotting the +## [@var{vx}, @var{vy}] = voronoi(@dots{}) returns the vertices instead of +## plotting the ## diagram. plot (@var{vx}, @var{vy}) shows the Voronoi diagram. ## ## A fourth optional argument, which must be a string, contains extra options
--- a/scripts/geometry/voronoin.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/geometry/voronoin.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{C}, @var{F}] =} voronoin (@var{pts}) +## @deftypefn {Function File} {[@var{C}, @var{F}] =} voronoin (@var{pts}) ## @deftypefnx {Function File} {[@var{C}, @var{F}] =} voronoin (@var{pts}, @var{options}) ## computes n- dimensional Voronoi facets. The input matrix @var{pts} ## of size [n, dim] contains n points of dimension dim.
--- a/scripts/help/__makeinfo__.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/help/__makeinfo__.m Sun Jul 18 20:35:16 2010 -0700 @@ -1,4 +1,4 @@ -## Copyright (C) 2009 Søren Hauberg +## Copyright (C) 2009 S�ren Hauberg ## ## This program is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by @@ -15,8 +15,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}) -## @deftypefnx{Function File} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}, @var{see_also}) +## @deftypefn {Function File} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}) +## @deftypefnx {Function File} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}, @var{see_also}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/help/gen_doc_cache.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/help/gen_doc_cache.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,8 @@ ## @deftypefn {Function File} gen_doc_cache (@var{out_file}, @var{directory}) ## Generate documentation caches for all functions in a given directory. ## -## A documentation cache is generated for all functions in @var{directory}. The +## A documentation cache is generated for all functions in @var{directory}. +## The ## resulting cache is saved in the file @var{out_file}. ## The cache is used to speed up @code{lookfor}. ##
--- a/scripts/help/get_first_help_sentence.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/help/get_first_help_sentence.m Sun Jul 18 20:35:16 2010 -0700 @@ -21,7 +21,8 @@ ## The function reads the first sentence of the help text of the function ## @var{name}. The first sentence is defined as the text after the function ## declaration until either the first period (".") or the first appearance of -## two consecutive end-lines ("\n\n"). The text is truncated to a maximum length +## two consecutive end-lines ("\n\n"). The text is truncated to a maximum +## length ## of @var{max_len}, which defaults to 80. ## ## The optional output argument @var{status} returns the status reported by
--- a/scripts/help/print_usage.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/help/print_usage.m Sun Jul 18 20:35:16 2010 -0700 @@ -1,4 +1,4 @@ -## Copyright (C) 2009 Søren Hauberg +## Copyright (C) 2009 S�ren Hauberg ## ## This program is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by @@ -15,8 +15,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} print_usage () -## @deftypefnx{Function File} {} print_usage (@var{name}) +## @deftypefn {Function File} {} print_usage () +## @deftypefnx {Function File} {} print_usage (@var{name}) ## Print the usage message for a function. When called with no input arguments ## the @code{print_usage} function displays the usage message of the currently ## executing function.
--- a/scripts/help/type.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/help/type.m Sun Jul 18 20:35:16 2010 -0700 @@ -1,4 +1,4 @@ -## Copyright (C) 2009 Søren Hauberg +## Copyright (C) 2009 S�ren Hauberg ## ## This program is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by @@ -21,7 +21,7 @@ ## Display the definition of each @var{name} that refers to a function. ## ## Normally also displays whether each @var{name} is user-defined or built-in; -## the @code{-q} option suppresses this behavior. +## the @option{-q} option suppresses this behavior. ## ## If an output argument is requested nothing is displayed. Instead, a cell ## array of strings is returned, where each element corresponds to the
--- a/scripts/image/brighten.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/brighten.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{map_out} =} brighten (@var{map}, @var{beta}) +## @deftypefn {Function File} {@var{map_out} =} brighten (@var{map}, @var{beta}) ## @deftypefnx {Function File} {@var{map_out} =} brighten (@var{h}, @var{beta}) ## @deftypefnx {Function File} {@var{map_out} =} brighten (@var{beta}) ## Darkens or brightens the given colormap. If the @var{map} argument
--- a/scripts/image/colormap.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/colormap.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} colormap (@var{map}) +## @deftypefn {Function File} {} colormap (@var{map}) ## @deftypefnx {Function File} {} colormap ("default") ## Set the current colormap. ##
--- a/scripts/image/image.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/image.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} image (@var{img}) +## @deftypefn {Function File} {} image (@var{img}) ## @deftypefnx {Function File} {} image (@var{x}, @var{y}, @var{img}) ## Display a matrix as a color image. The elements of @var{x} are indices ## into the current colormap, and the colormap will be scaled so that the
--- a/scripts/image/imagesc.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/imagesc.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} imagesc (@var{a}) +## @deftypefn {Function File} {} imagesc (@var{a}) ## @deftypefnx {Function File} {} imagesc (@var{x}, @var{y}, @var{a}) ## @deftypefnx {Function File} {} imagesc (@dots{}, @var{limits}) ## @deftypefnx {Function File} {} imagesc (@var{h}, @dots{})
--- a/scripts/image/imfinfo.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/imfinfo.m Sun Jul 18 20:35:16 2010 -0700 @@ -54,7 +54,8 @@ ## 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. +## 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"}. @@ -64,7 +65,8 @@ ## @item Matte ## @code{true} if the image has transparency. ## @item ModulusDepth -## Image modulus depth (minimum number of bits required to support red/green/blue +## 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. @@ -74,7 +76,8 @@ ## 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"}, +## Image type. Is either @code{"grayscale"}, @code{"indexed"}, +## @code{"truecolor"}, ## or @code{"undefined"}. ## @item View ## FlashPix viewing parameters.
--- a/scripts/image/imshow.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/imshow.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} imshow (@var{im}) +## @deftypefn {Function File} {} imshow (@var{im}) ## @deftypefnx {Function File} {} imshow (@var{im}, @var{limits}) ## @deftypefnx {Function File} {} imshow (@var{im}, @var{map}) ## @deftypefnx {Function File} {} imshow (@var{rgb}, @dots{})
--- a/scripts/image/imwrite.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/imwrite.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,14 +17,15 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} imwrite (@var{img}, @var{filename}, @var{fmt}, @var{p1}, @var{v1}, @dots{}) +## @deftypefn {Function File} {} imwrite (@var{img}, @var{filename}, @var{fmt}, @var{p1}, @var{v1}, @dots{}) ## @deftypefnx {Function File} {} imwrite (@var{img}, @var{map}, @var{filename}, @var{fmt}, @var{p1}, @var{v1}, @dots{}) ## Write images in various file formats. ## ## If @var{fmt} is missing, the file extension (if any) of ## @var{filename} is used to determine the format. ## -## The parameter-value pairs (@var{p1}, @var{v1}, @dots{}) are optional. Currently +## The parameter-value pairs (@var{p1}, @var{v1}, @dots{}) are optional. +## Currently ## the following options are supported for @t{JPEG} images ## ## @table @samp
--- a/scripts/image/ind2rgb.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/image/ind2rgb.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{rgb} =} ind2rgb (@var{x}, @var{map}) +## @deftypefn {Function File} {@var{rgb} =} ind2rgb (@var{x}, @var{map}) ## @deftypefnx {Function File} {[@var{r}, @var{g}, @var{b}] =} ind2rgb (@var{x}, @var{map}) ## Convert an indexed image to red, green, and blue color components. ## If the colormap doesn't contain enough colors, pad it with the
--- a/scripts/io/dlmwrite.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/io/dlmwrite.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} dlmwrite (@var{file}, @var{a}) +## @deftypefn {Function File} {} dlmwrite (@var{file}, @var{a}) ## @deftypefnx {Function File} {} dlmwrite (@var{file}, @var{a}, @var{delim}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} dlmwrite (@var{file}, @var{a}, @var{key}, @var{val} @dots{}) ## @deftypefnx {Function File} {} dlmwrite (@var{file}, @var{a}, "-append", @dots{})
--- a/scripts/io/fileread.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/io/fileread.m Sun Jul 18 20:35:16 2010 -0700 @@ -15,7 +15,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{str} =} fileread (@var{filename}) +## @deftypefn {Function File} {@var{str} =} fileread (@var{filename}) ## Read the contents of a file and return it as a string. ## @seealso{fread, textread} ## @end deftypefn
--- a/scripts/io/strread.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/io/strread.m Sun Jul 18 20:35:16 2010 -0700 @@ -15,18 +15,21 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{a}, @dots{}] =} strread (@var{str}) -## @deftypefnx {Function File} {[@var{a}, @dots{}] =} strread (@var{str}, @var{format}) +## @deftypefn {Function File} {[@var{a}, @dots{}] =} strread (@var{str}) +## @deftypefnx {Function File} {[@var{a}, @dots{}] =} strread (@var{str}, @var{format}) ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} strread (@var{str}, @var{format}, @ ## @var{prop1}, @var{value1}, @dots{}) ## Read data from a string. ## ## The string @var{str} is split into words that are repeatedly matched to the -## specifiers in @var{format}. The first word is matched to the first specifier, -## the second to the second specifier and so forth. If there are more words than +## specifiers in @var{format}. The first word is matched to the first +## specifier, +## the second to the second specifier and so forth. If there are more words +## than ## specifiers, the process is repeated until all words have been processed. ## -## The string @var{format} describes how the words in @var{str} should be parsed. +## The string @var{format} describes how the words in @var{str} should be +## parsed. ## It may contain any combination of the following specifiers: ## @table @code ## @item %s @@ -41,7 +44,8 @@ ## Parsed word corresponding to the first specifier are returned in the first ## output argument and likewise for the rest of the specifiers. ## -## By default, @var{format} is @t{"%f"}, meaning that numbers are read from @var{str}. +## By default, @var{format} is @t{"%f"}, meaning that numbers are read from +## @var{str}. ## ## For example, the string ##
--- a/scripts/io/textread.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/io/textread.m Sun Jul 18 20:35:16 2010 -0700 @@ -15,14 +15,15 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}) -## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format}) +## @deftypefn {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}) +## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format}) ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format}, @ ## @var{prop1}, @var{value1}, @dots{}) ## Read data from a text file. ## ## The file @var{filename} is read and parsed according to @var{format}. The -## function behaves like @code{strread} except it works by parsing a file instead +## function behaves like @code{strread} except it works by parsing a file +## instead ## of a string. See the documentation of @code{strread} for details. ## In addition to the options supported by @code{strread}, this function ## supports one more:
--- a/scripts/linear-algebra/cond.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/linear-algebra/cond.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} cond (@var{a}) ## @deftypefnx {Function File} {} cond (@var{a},@var{p}) -## Compute the @var{p}-norm condition number of a matrix. @code{cond (@var{a})} is +## Compute the @var{p}-norm condition number of a matrix. @code{cond +## (@var{a})} is ## defined as ## @tex ## $ {\parallel a \parallel_p * \parallel a^{-1} \parallel_p .} $
--- a/scripts/linear-algebra/condest.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/linear-algebra/condest.m Sun Jul 18 20:35:16 2010 -0700 @@ -54,11 +54,13 @@ ## ## References: ## @itemize -## @item N.J. Higham and F. Tisseur, @cite{A Block Algorithm +## @item +## N.J. Higham and F. Tisseur, @cite{A Block Algorithm ## 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 +## @item +## N.J. Higham and F. Tisseur, @cite{A Block Algorithm ## for Matrix 1-Norm Estimation, with an Application to 1-Norm ## Pseudospectra}. @url{http://citeseer.ist.psu.edu/223007.html} ## @end itemize
--- a/scripts/linear-algebra/ishermitian.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/linear-algebra/ishermitian.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} ishermitian (@var{x}, @var{tol}) -## Return true if @var{x} is symmetric within the tolerance specified by @var{tol}, +## Return true if @var{x} is symmetric within the tolerance specified by +## @var{tol}, ## otherwise return false. The default tolerance is zero (uses faster code). ## Matrix @var{x} is considered symmetric if ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}.
--- a/scripts/linear-algebra/onenormest.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/linear-algebra/onenormest.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{a}, @var{t}) +## @deftypefn {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{a}, @var{t}) ## @deftypefnx {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{apply}, @var{apply_t}, @var{n}, @var{t}) ## ## Apply Higham and Tisseur's randomized block 1-norm estimator to @@ -39,11 +39,13 @@ ## ## References: ## @itemize -## @item N.J. Higham and F. Tisseur, @cite{A Block Algorithm +## @item +## N.J. Higham and F. Tisseur, @cite{A Block Algorithm ## 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 +## @item +## N.J. Higham and F. Tisseur, @cite{A Block Algorithm ## for Matrix 1-Norm Estimation, with an Application to 1-Norm ## Pseudospectra}. @url{http://citeseer.ist.psu.edu/223007.html} ## @end itemize
--- a/scripts/miscellaneous/bzip2.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/bzip2.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{entries} =} bzip2 (@var{files}) +## @deftypefn {Function File} {@var{entries} =} bzip2 (@var{files}) ## @deftypefnx {Function File} {@var{entries} =} bzip2 (@var{files}, @var{outdir}) ## Compress the list of files specified in @var{files}. ## Each file is compressed separately and a new file with a '.bz2' extension
--- a/scripts/miscellaneous/dir.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/dir.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} dir (@var{directory}) +## @deftypefn {Function File} {} dir (@var{directory}) ## @deftypefnx {Function File} {[@var{list}] =} dir (@var{directory}) ## Display file listing for directory @var{directory}. If a return ## value is requested, return a structure array with the fields
--- a/scripts/miscellaneous/dos.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/dos.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{status}, @var{text}] =} dos (@var{command}) +## @deftypefn {Function File} {[@var{status}, @var{text}] =} dos (@var{command}) ## @deftypefnx {Function File} {[@var{status}, @var{text}] =} dos (@var{command}, "-echo") ## Execute a system command if running under a Windows-like operating ## system, otherwise do nothing. Return the exit status of the program
--- a/scripts/miscellaneous/edit.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/edit.m Sun Jul 18 20:35:16 2010 -0700 @@ -30,7 +30,7 @@ ## If the function @var{name} is available in a file on your path and ## that file is modifiable, then it will be edited in place. If it ## is a system function, then it will first be copied to the directory -## @code{HOME} (see further down) and then edited. +## @env{HOME} (see further down) and then edited. ## If no file is found, then the m-file ## variant, ending with ".m", will be considered. If still no file ## is found, then variants with a leading "@@" and then with both a @@ -38,13 +38,13 @@ ## ## @item ## If @var{name} is the name of a function defined in the interpreter but -## not in an m-file, then an m-file will be created in @code{HOME} +## not in an m-file, then an m-file will be created in @env{HOME} ## to contain that function along with its current definition. ## ## @item ## If @code{name.cc} is specified, then it will search for @code{name.cc} ## in the path and try to modify it, otherwise it will create a new -## @file{.cc} file in @code{HOME}. If @var{name} happens to be an +## @file{.cc} file in @env{HOME}. If @var{name} happens to be an ## m-file or interpreter defined function, then the text of that ## function will be inserted into the .cc file as a comment. ## @@ -52,7 +52,7 @@ ## If @var{name.ext} is on your path then it will be edited, otherwise ## the editor will be started with @file{HOME/name.ext} as the ## filename. If @file{name.ext} is not modifiable, it will be copied to -## @code{HOME} before editing. +## @env{HOME} before editing. ## ## @strong{WARNING!} You may need to clear name before the new definition ## is available. If you are editing a .cc file, you will need @@ -71,7 +71,7 @@ ## @table @samp ## @item editor ## This is the editor to use to modify the functions. By default it uses -## Octave's @code{EDITOR} built-in function, which comes from +## Octave's @env{EDITOR} built-in function, which comes from ## @code{getenv("EDITOR")} and defaults to @code{emacs}. Use @code{%s} ## In place of the function name. For example, ## @table @samp
--- a/scripts/miscellaneous/gzip.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/gzip.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{entries} =} gzip (@var{files}) +## @deftypefn {Function File} {@var{entries} =} gzip (@var{files}) ## @deftypefnx {Function File} {@var{entries} =} gzip (@var{files}, @var{outdir}) ## Compress the list of files and/or directories specified in @var{files}. ## Each file is compressed separately and a new file with a '.gz' extension
--- a/scripts/miscellaneous/mkoctfile.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/mkoctfile.m Sun Jul 18 20:35:16 2010 -0700 @@ -61,7 +61,7 @@ ## ## @item -p VAR ## @itemx --print VAR -## Print the configuration variable VAR. Recognized variables are: +## Print the configuration variable VAR@. Recognized variables are: ## ## @example ## ALL_CFLAGS FFTW_LIBS
--- a/scripts/miscellaneous/orderfields.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/orderfields.m Sun Jul 18 20:35:16 2010 -0700 @@ -28,7 +28,8 @@ ## order in a permutation vector or a cell array of strings containing ## the fieldnames of @var{s1} in the desired order. ## -## The optional second output argument @var{p} is assigned the permutation vector +## The optional second output argument @var{p} is assigned the permutation +## vector ## which converts the original name order into the new name order. ## ## Examples:
--- a/scripts/miscellaneous/parseparams.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/parseparams.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{reg}, @var{prop}] =} parseparams (@var{params}) +## @deftypefn {Function File} {[@var{reg}, @var{prop}] =} parseparams (@var{params}) ## @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
--- a/scripts/miscellaneous/perl.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/perl.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{output}, @var{status}] =} perl (@var{scriptfile}) +## @deftypefn {Function File} {[@var{output}, @var{status}] =} perl (@var{scriptfile}) ## @deftypefnx {Function File} {[@var{output}, @var{status}] =} perl (@var{scriptfile}, @var{argument1}, @var{argument2}, @dots{}) ## Invoke Perl script @var{scriptfile} with possibly a list of ## command line arguments.
--- a/scripts/miscellaneous/unix.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/unix.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{status}, @var{text}]} unix (@var{command}) +## @deftypefn {Function File} {[@var{status}, @var{text}]} unix (@var{command}) ## @deftypefnx {Function File} {[@var{status}, @var{text}]} unix (@var{command}, "-echo") ## Execute a system command if running under a Unix-like operating ## system, otherwise do nothing. Return the exit status of the program
--- a/scripts/miscellaneous/unpack.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/unpack.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{files} =} unpack (@var{file}, @var{dir}) +## @deftypefn {Function File} {@var{files} =} unpack (@var{file}, @var{dir}) ## @deftypefnx {Function File} {@var{files} =} unpack (@var{file}, @var{dir}, @var{filetype}) ## Unpack the archive @var{file} based on its extension to the directory ## @var{dir}. If @var{file} is a cellstr, then all files will be
--- a/scripts/miscellaneous/version.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/version.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} version () ## Return Octave's version number as a string. This is also the value of -## the built-in variable @w{@code{OCTAVE_VERSION}}. +## the built-in variable @w{@env{OCTAVE_VERSION}}. ## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/zip.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/miscellaneous/zip.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{entries} =} zip (@var{zipfile}, @var{files}) +## @deftypefn {Function File} {@var{entries} =} zip (@var{zipfile}, @var{files}) ## @deftypefnx {Function File} {@var{entries} =} zip (@var{zipfile}, @var{files}, @var{rootdir}) ## Compress the list of files and/or directories specified in @var{files} ## into the archive @var{zipfiles} in the same directory. If @var{rootdir}
--- a/scripts/optimization/fminbnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/fminbnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,8 +20,10 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{x}, @var{fval}, @var{info}, @var{output}] =} fminbnd (@var{fun}, @var{a}, @var{b}, @var{options}) -## Find a minimum point of a univariate function. @var{fun} should be a function -## handle or name. @var{a}, @var{b} specify a starting interval. @var{options} is a +## Find a minimum point of a univariate function. @var{fun} should be a +## function +## handle or name. @var{a}, @var{b} specify a starting interval. @var{options} +## is a ## structure specifying additional options. Currently, @code{fminbnd} ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, ## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}.
--- a/scripts/optimization/fminunc.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/fminunc.m Sun Jul 18 20:35:16 2010 -0700 @@ -22,7 +22,8 @@ ## @deftypefn {Function File} {} fminunc (@var{fcn}, @var{x0}) ## @deftypefnx {Function File} {} fminunc (@var{fcn}, @var{x0}, @var{options}) ## @deftypefnx {Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{grad}, @var{hess}]} = fminunc (@var{fcn}, @dots{}) -## Solve an unconstrained optimization problem defined by the function @var{fcn}. +## Solve an unconstrained optimization problem defined by the function +## @var{fcn}. ## @var{fcn} should accepts a vector (array) defining the unknown variables, ## and return the objective function value, optionally with gradient. ## In other words, this function attempts to determine a vector @var{x} such @@ -50,7 +51,8 @@ ## ## @table @asis ## @item 1 -## Converged to a solution point. Relative gradient error is less than specified +## Converged to a solution point. Relative gradient error is less than +## specified ## by TolFun. ## @item 2 ## Last relative step size was less that TolX. @@ -63,7 +65,7 @@ ## @end table ## ## Optionally, fminunc can also yield a structure with convergence statistics -## (@var{output}), the output gradient (@var{grad}) and approximate hessian +## (@var{output}), the output gradient (@var{grad}) and approximate Hessian ## (@var{hess}). ## ## Note: If you only have a single nonlinear equation of one variable, using
--- a/scripts/optimization/fsolve.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/fsolve.m Sun Jul 18 20:35:16 2010 -0700 @@ -49,7 +49,7 @@ ## it may sometimes deliver unexpected (though mathematically correct) results. ## ## If @code{"Updating"} is "on", the function will attempt to use Broyden -## updates to update the Jacobian, in order to reduce the amount of jacobian +## updates to update the Jacobian, in order to reduce the amount of Jacobian ## calculations. ## If your user function always calculates the Jacobian (regardless of number ## of output arguments), this option provides no advantage and should be set to @@ -68,7 +68,8 @@ ## ## @table @asis ## @item 1 -## Converged to a solution point. Relative residual error is less than specified +## Converged to a solution point. Relative residual error is less than +## specified ## by TolFun. ## @item 2 ## Last relative step size was less that TolX. @@ -84,15 +85,15 @@ ## @code{fzero} is usually a much better idea. ## @seealso{fzero, optimset} ## -## Note about user-supplied jacobians: -## As an inherent property of the algorithm, jacobian is always requested for a +## Note about user-supplied Jacobians: +## As an inherent property of the algorithm, Jacobian is always requested for a ## solution vector whose residual vector is already known, and it is the last ## accepted successful step. Often this will be one of the last two calls, but ## not always. If the savings by reusing intermediate results from residual -## calculation in jacobian calculation are significant, the best strategy is to +## calculation in Jacobian calculation are significant, the best strategy is to ## employ OutputFcn: After a vector is evaluated for residuals, if OutputFcn is ## called with that vector, then the intermediate results should be saved for -## future jacobian evaluation, and should be kept until a jacobian evaluation +## future Jacobian evaluation, and should be kept until a Jacobian evaluation ## is requested or until outputfcn is called with a different vector, in which ## case they should be dropped in favor of this most recent vector. A short ## example how this can be achieved follows:
--- a/scripts/optimization/glpk.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/glpk.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @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 GLPK library. Given three +## Solve a linear program using the GNU @sc{glpk} library. Given three ## arguments, @code{glpk} solves the following standard LP: ## ## @tex @@ -269,8 +269,8 @@ ## ## @item tolpiv (@w{@code{LPX_K_TOLPIV}}, default: 10e-9) ## Relative tolerance used to choose eligible pivotal elements of the -## simplex table. It is not recommended that you change this parameter unless you -## have a detailed understanding of its purpose. +## simplex table. It is not recommended that you change this parameter unless +## you have a detailed understanding of its purpose. ## ## @item objll (@w{@code{LPX_K_OBJLL}}, default: -DBL_MAX) ## Lower limit of the objective function. If on the phase II the objective @@ -388,7 +388,7 @@ ## 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 GLPK is 4.15 or later). +## available if the version of @sc{glpk} is 4.15 or later). ## @end table ## @end table ##
--- a/scripts/optimization/glpkmex.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/glpkmex.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{xopt}, @var{fmin}, @var{status}, @var{extra}] =} glpkmex (@var{sense}, @var{c}, @var{a}, @var{b}, @var{ctype}, @var{lb}, @var{ub}, @var{vartype}, @var{param}, @var{lpsolver}, @var{save_pb}) ## This function is provided for compatibility with the old @sc{matlab} -## interface to the GNU GLPK library. For Octave code, you should use +## interface to the GNU @sc{glpk} library. For Octave code, you should use ## the @code{glpk} function instead. ## @end deftypefn
--- a/scripts/optimization/lsqnonneg.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/lsqnonneg.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} lsqnonneg (@var{c}, @var{d}) +## @deftypefn {Function File} {@var{x} =} lsqnonneg (@var{c}, @var{d}) ## @deftypefnx {Function File} {@var{x} =} lsqnonneg (@var{c}, @var{d}, @var{x0}) ## @deftypefnx {Function File} {[@var{x}, @var{resnorm}] =} lsqnonneg (@dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{resnorm}, @var{residual}] =} lsqnonneg (@dots{})
--- a/scripts/optimization/optimget.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/optimget.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} optimget (@var{options}, @var{parname}) +## @deftypefn {Function File} {} optimget (@var{options}, @var{parname}) ## @deftypefnx {Function File} {} optimget (@var{options}, @var{parname}, @var{default}) ## Return a specific option from a structure created by ## @code{optimset}. If @var{parname} is not a field of the @var{options}
--- a/scripts/optimization/optimset.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/optimset.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} optimset () +## @deftypefn {Function File} {} optimset () ## @deftypefnx {Function File} {} optimset (@var{par}, @var{val}, @dots{}) ## @deftypefnx {Function File} {} optimset (@var{old}, @var{par}, @var{val}, @dots{}) ## @deftypefnx {Function File} {} optimset (@var{old}, @var{new})
--- a/scripts/optimization/pqpnonneg.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/pqpnonneg.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,15 +19,15 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} pqpnonneg (@var{c}, @var{d}) +## @deftypefn {Function File} {@var{x} =} pqpnonneg (@var{c}, @var{d}) ## @deftypefnx {Function File} {@var{x} =} pqpnonneg (@var{c}, @var{d}, @var{x0}) ## @deftypefnx {Function File} {[@var{x}, @var{minval}] =} pqpnonneg (@dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{minval}, @var{exitflag}] =} pqpnonneg (@dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{minval}, @var{exitflag}, @var{output}] =} pqpnonneg (@dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{minval}, @var{exitflag}, @var{output}, @var{lambda}] =} pqpnonneg (@dots{}) -## Minimize @code{1/2*x'*c*x + d'*x} subject to @code{@var{x} >= -## 0}. @var{c} and @var{d} must be real, and @var{c} must be symmetric and positive definite. -## @var{x0} is an optional initial guess for @var{x}. +## Minimize @code{1/2*x'*c*x + d'*x} subject to @code{@var{x} >= 0}. @var{c} +## and @var{d} must be real, and @var{c} must be symmetric and positive +## definite. @var{x0} is an optional initial guess for @var{x}. ## ## Outputs: ## @itemize @bullet
--- a/scripts/optimization/private/__fdjac__.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/private/__fdjac__.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn{Function File} {} __fdjac__ (@var{fcn}, @var{x}, @var{fvec}, @var{err}) +## @deftypefn {Function File} {} __fdjac__ (@var{fcn}, @var{x}, @var{fvec}, @var{err}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/optimization/qp.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/optimization/qp.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{x}, @var{obj}, @var{info}, @var{lambda}] =} qp (@var{x0}, @var{H}) +## @deftypefn {Function File} {[@var{x}, @var{obj}, @var{info}, @var{lambda}] =} qp (@var{x0}, @var{H}) ## @deftypefnx {Function File} {[@var{x}, @var{obj}, @var{info}, @var{lambda}] =} qp (@var{x0}, @var{H}, @var{q}) ## @deftypefnx {Function File} {[@var{x}, @var{obj}, @var{info}, @var{lambda}] =} qp (@var{x0}, @var{H}, @var{q}, @var{A}, @var{b}) ## @deftypefnx {Function File} {[@var{x}, @var{obj}, @var{info}, @var{lambda}] =} qp (@var{x0}, @var{H}, @var{q}, @var{A}, @var{b}, @var{lb}, @var{ub})
--- a/scripts/pkg/get_forge_pkg.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/pkg/get_forge_pkg.m Sun Jul 18 20:35:16 2010 -0700 @@ -15,10 +15,11 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn{Function File} {[@var{ver}, @var{url}] =} get_forge_pkg (@var{name}) +## @deftypefn {Function File} {[@var{ver}, @var{url}] =} get_forge_pkg (@var{name}) ## Tries to discover the current version of an OctaveForge package from the web, ## using a working internet connection and the urlread function. -## If two output arguments are requested, returns also an address to download the file. +## If two output arguments are requested, returns also an address to download +## the file. ## @end deftypefn function [ver, url] = get_forge_pkg (name)
--- a/scripts/pkg/pkg.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/pkg/pkg.m Sun Jul 18 20:35:16 2010 -0700 @@ -69,7 +69,7 @@ ## @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 @code{-nodeps} option. +## 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, @@ -171,7 +171,7 @@ ## @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 @code{-auto} and @code{-noauto} options to allow the +## It can also take the @option{-auto} and @option{-noauto} options to allow the ## autoloading state of a package to be changed. For example ## ## @example @@ -191,7 +191,7 @@ ## @noindent ## where @code{builddir} is the name of a directory where the temporary ## installation will be produced and the binary packages will be found. -## The options @code{-verbose} and @code{-nodeps} are respected, while +## The options @option{-verbose} and @option{-nodeps} are respected, while ## the other options are ignored. ## @end table ## @end deffn
--- a/scripts/plot/__fltk_print__.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/__fltk_print__.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} __fltk_print__ (@var{...}) +## @deftypefn {Function File} {} __fltk_print__ (@var{@dots{}}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/__gnuplot_print__.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/__gnuplot_print__.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} __gnuplot_ginput__ (@var{...}) +## @deftypefn {Function File} {} __gnuplot_ginput__ (@var{@dots{}}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/ancestor.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ancestor.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}) +## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}) ## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, 'toplevel') ## Return the first ancestor of handle object @var{h} whose type matches ## @var{type}, where @var{type} is a character string. If @var{type} is a
--- a/scripts/plot/area.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/area.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} area (@var{x}, @var{y}) +## @deftypefn {Function File} {} area (@var{x}, @var{y}) ## @deftypefnx {Function File} {} area (@var{x}, @var{y}, @var{lvl}) ## @deftypefnx {Function File} {} area (@dots{}, @var{prop}, @var{val}, @dots{}) ## @deftypefnx {Function File} {} area (@var{y}, @dots{})
--- a/scripts/plot/axes.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/axes.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} axes () +## @deftypefn {Function File} {} axes () ## @deftypefnx {Function File} {} axes (@var{property}, @var{value}, @dots{}) ## @deftypefnx {Function File} {} axes (@var{h}) ## Create an axes object and return a handle to it.
--- a/scripts/plot/axis.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/axis.m Sun Jul 18 20:35:16 2010 -0700 @@ -24,8 +24,8 @@ ## @deftypefnx {Function File} {} axis ([@var{x}_lo, @var{x}_hi, @var{y}_lo, @var{y}_hi, @var{z}_lo, @var{z}_hi]) ## @deftypefnx {Function File} {} axis (@var{option}) ## @deftypefnx {Function File} {} axis (@dots{}, @var{option}) -## @deftypefnx {Function File} {} axis (@var{h}, @dots{}) -## @deftypefnx {Function File} {@var{limits} =} axis () +## @deftypefnx {Function File} {} axis (@var{h}, @dots{}) +## @deftypefnx {Function File} {@var{limits} =} axis () ## Set axis limits for plots. ## ## The argument @var{limits} should be a 2, 4, or 6 element vector. The
--- a/scripts/plot/bar.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/bar.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} bar (@var{x}, @var{y}) +## @deftypefn {Function File} {} bar (@var{x}, @var{y}) ## @deftypefnx {Function File} {} bar (@var{y}) ## @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w}) ## @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w}, @var{style})
--- a/scripts/plot/barh.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/barh.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} barh (@var{x}, @var{y}) +## @deftypefn {Function File} {} barh (@var{x}, @var{y}) ## @deftypefnx {Function File} {} barh (@var{y}) ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}) ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}, @var{style})
--- a/scripts/plot/box.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/box.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} box (@var{arg}) +## @deftypefn {Function File} {} box (@var{arg}) ## @deftypefnx {Function File} {} box (@var{h}, @dots{}) ## Control the display of a border around the plot. ## The argument may be either @code{"on"} or @code{"off"}. If it is
--- a/scripts/plot/caxis.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/caxis.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} caxis (@var{limits}) +## @deftypefn {Function File} {} caxis (@var{limits}) ## @deftypefnx {Function File} {} caxis (@var{h}, @dots{}) ## Set color axis limits for plots. ##
--- a/scripts/plot/cla.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/cla.m Sun Jul 18 20:35:16 2010 -0700 @@ -15,7 +15,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} cla () +## @deftypefn {Function File} {} cla () ## @deftypefnx {Function File} {} cla ("reset") ## @deftypefnx {Function File} {} cla (@var{hax}) ## @deftypefnx {Function File} {} cla (@var{hax}, "reset")
--- a/scripts/plot/clabel.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/clabel.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} clabel (@var{c}, @var{h}) +## @deftypefn {Function File} {} clabel (@var{c}, @var{h}) ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, @var{v}) ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, "manual") ## @deftypefnx {Function File} {} clabel (@var{c})
--- a/scripts/plot/close.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/close.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Command} {} close +## @deftypefn {Command} {} close ## @deftypefnx {Command} {} close (@var{n}) ## @deftypefnx {Command} {} close all ## @deftypefnx {Command} {} close all hidden
--- a/scripts/plot/colorbar.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/colorbar.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} colorbar (@var{s}) +## @deftypefn {Function File} {} colorbar (@var{s}) ## @deftypefnx {Function File} {} colorbar ("peer", @var{h}, @dots{}) ## Adds a colorbar to the current axes. Valid values for @var{s} are ##
--- a/scripts/plot/comet.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/comet.m Sun Jul 18 20:35:16 2010 -0700 @@ -15,7 +15,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} comet (@var{y}) +## @deftypefn {Function File} {} comet (@var{y}) ## @deftypefnx {Function File} {} comet (@var{x}, @var{y}) ## @deftypefnx {Function File} {} comet (@var{x}, @var{y}, @var{p}) ## @deftypefnx {Function File} {} comet (@var{ax}, @dots{})
--- a/scripts/plot/compass.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/compass.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} compass (@var{u}, @var{v}) +## @deftypefn {Function File} {} compass (@var{u}, @var{v}) ## @deftypefnx {Function File} {} compass (@var{z}) ## @deftypefnx {Function File} {} compass (@dots{}, @var{style}) ## @deftypefnx {Function File} {} compass (@var{h}, @dots{})
--- a/scripts/plot/contour.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/contour.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} contour (@var{z}) +## @deftypefn {Function File} {} contour (@var{z}) ## @deftypefnx {Function File} {} contour (@var{z}, @var{vn}) ## @deftypefnx {Function File} {} contour (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} contour (@var{x}, @var{y}, @var{z}, @var{vn})
--- a/scripts/plot/contour3.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/contour3.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} contour3 (@var{z}) +## @deftypefn {Function File} {} contour3 (@var{z}) ## @deftypefnx {Function File} {} contour3 (@var{z}, @var{vn}) ## @deftypefnx {Function File} {} contour3 (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} contour3 (@var{x}, @var{y}, @var{z}, @var{vn})
--- a/scripts/plot/contourc.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/contourc.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{c}, @var{lev}] =} contourc (@var{x}, @var{y}, @var{z}, @var{vn}) +## @deftypefn {Function File} {[@var{c}, @var{lev}] =} contourc (@var{x}, @var{y}, @var{z}, @var{vn}) ## Compute isolines (contour lines) of the matrix @var{z}. ## Parameters @var{x}, @var{y} and @var{vn} are optional. ##
--- a/scripts/plot/contourf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/contourf.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}, @var{lvl}) +## @deftypefn {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}, @var{lvl}) ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}, @var{n}) ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@var{z}, @var{n})
--- a/scripts/plot/cylinder.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/cylinder.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} cylinder +## @deftypefn {Function File} {} cylinder ## @deftypefnx {Function File} {} cylinder (@var{r}) ## @deftypefnx {Function File} {} cylinder (@var{r}, @var{n}) ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} cylinder (@dots{})
--- a/scripts/plot/ellipsoid.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ellipsoid.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{x}, @var{y}, @var{z}] =} ellipsoid (@var{xc},@var{yc}, @var{zc}, @var{xr}, @var{yr}, @var{zr}, @var{n}) +## @deftypefn {Function File} {[@var{x}, @var{y}, @var{z}] =} ellipsoid (@var{xc},@var{yc}, @var{zc}, @var{xr}, @var{yr}, @var{zr}, @var{n}) ## @deftypefnx {Function File} {} ellipsoid (@var{h}, @dots{}) ## Generate three matrices in @code{meshgrid} format that define an ## ellipsoid. Called with no return arguments, @code{ellipsoid} calls
--- a/scripts/plot/ezcontour.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezcontour.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezcontour (@var{f}) +## @deftypefn {Function File} {} ezcontour (@var{f}) ## @deftypefnx {Function File} {} ezcontour (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezcontour (@dots{}, @var{n}) ## @deftypefnx {Function File} {} ezcontour (@var{h}, @dots{})
--- a/scripts/plot/ezcontourf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezcontourf.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezcontourf (@var{f}) +## @deftypefn {Function File} {} ezcontourf (@var{f}) ## @deftypefnx {Function File} {} ezcontourf (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezcontourf (@dots{}, @var{n}) ## @deftypefnx {Function File} {} ezcontourf (@var{h}, @dots{})
--- a/scripts/plot/ezmesh.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezmesh.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezmesh (@var{f}) +## @deftypefn {Function File} {} ezmesh (@var{f}) ## @deftypefnx {Function File} {} ezmesh (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{n})
--- a/scripts/plot/ezmeshc.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezmeshc.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezmeshc (@var{f}) +## @deftypefn {Function File} {} ezmeshc (@var{f}) ## @deftypefnx {Function File} {} ezmeshc (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezmeshc (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezmeshc (@dots{}, @var{n})
--- a/scripts/plot/ezplot.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezplot.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezplot (@var{f}) +## @deftypefn {Function File} {} ezplot (@var{f}) ## @deftypefnx {Function File} {} ezplot (@var{fx}, @var{fy}) ## @deftypefnx {Function File} {} ezplot (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezplot (@dots{}, @var{n})
--- a/scripts/plot/ezplot3.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezplot3.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezplot3 (@var{fx}, @var{fy}, @var{fz}) +## @deftypefn {Function File} {} ezplot3 (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezplot3 (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezplot3 (@dots{}, @var{n}) ## @deftypefnx {Function File} {} ezplot3 (@var{h}, @dots{})
--- a/scripts/plot/ezpolar.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezpolar.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezpolar (@var{f}) +## @deftypefn {Function File} {} ezpolar (@var{f}) ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{n}) ## @deftypefnx {Function File} {} ezpolar (@var{h}, @dots{})
--- a/scripts/plot/ezsurf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezsurf.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezsurf (@var{f}) +## @deftypefn {Function File} {} ezsurf (@var{f}) ## @deftypefnx {Function File} {} ezsurf (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{n})
--- a/scripts/plot/ezsurfc.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ezsurfc.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ezsurfc (@var{f}) +## @deftypefn {Function File} {} ezsurfc (@var{f}) ## @deftypefnx {Function File} {} ezsurfc (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezsurfc (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezsurfc (@dots{}, @var{n})
--- a/scripts/plot/feather.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/feather.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} feather (@var{u}, @var{v}) +## @deftypefn {Function File} {} feather (@var{u}, @var{v}) ## @deftypefnx {Function File} {} feather (@var{z}) ## @deftypefnx {Function File} {} feather (@dots{}, @var{style}) ## @deftypefnx {Function File} {} feather (@var{h}, @dots{})
--- a/scripts/plot/figure.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/figure.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} figure (@var{n}) +## @deftypefn {Function File} {} figure (@var{n}) ## @deftypefnx {Function File} {} figure (@var{n}, @var{property}, @var{value}, @dots{}) ## Set the current plot window to plot window @var{n}. If no arguments are ## specified, the next available window number is chosen.
--- a/scripts/plot/fill.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/fill.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} fill (@var{x}, @var{y}, @var{c}) +## @deftypefn {Function File} {} fill (@var{x}, @var{y}, @var{c}) ## @deftypefnx {Function File} {} fill (@var{x1}, @var{y1}, @var{c1}, @var{x2}, @var{y2}, @var{c2}) ## @deftypefnx {Function File} {} fill (@dots{}, @var{prop}, @var{val}) ## @deftypefnx {Function File} {} fill (@var{h}, @dots{})
--- a/scripts/plot/findall.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/findall.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{h} =} findall () +## @deftypefn {Function File} {@var{h} =} findall () ## @deftypefnx {Function File} {@var{h} =} findall (@var{prop_name}, @var{prop_value}) ## @deftypefnx {Function File} {@var{h} =} findall (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} findall (@var{h}, "-depth", @var{d}, @dots{})
--- a/scripts/plot/findobj.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/findobj.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{h} =} findobj () +## @deftypefn {Function File} {@var{h} =} findobj () ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}) ## @deftypefnx {Function File} {@var{h} =} findobj ('-property', @var{prop_name}) ## @deftypefnx {Function File} {@var{h} =} findobj ('-regexp', @var{prop_name}, @var{pattern})
--- a/scripts/plot/fplot.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/fplot.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} fplot (@var{fn}, @var{limits}) +## @deftypefn {Function File} {} fplot (@var{fn}, @var{limits}) ## @deftypefnx {Function File} {} fplot (@var{fn}, @var{limits}, @var{tol}) ## @deftypefnx {Function File} {} fplot (@var{fn}, @var{limits}, @var{n}) ## @deftypefnx {Function File} {} fplot (@dots{}, @var{fmt})
--- a/scripts/plot/gcbo.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/gcbo.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{h} =} gcbo () +## @deftypefn {Function File} {@var{h} =} gcbo () ## @deftypefnx {Function File} {[@var{h}, @var{fig}] =} gcbo () ## Return a handle to the object whose callback is currently ## executing. If no callback is executing, this function returns the
--- a/scripts/plot/grid.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/grid.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} grid (@var{arg}) +## @deftypefn {Function File} {} grid (@var{arg}) ## @deftypefnx {Function File} {} grid ("minor", @var{arg2}) ## @deftypefnx {Function File} {} grid (@var{hax}, @dots{}) ## Force the display of a grid on the plot.
--- a/scripts/plot/hggroup.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/hggroup.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} hggroup () +## @deftypefn {Function File} {} hggroup () ## @deftypefnx {Function File} {} hggroup (@var{h}) ## @deftypefnx {Function File} {} hggroup (@dots{}, @var{property}, @var{value}, @dots{}) ## Create group object with parent @var{h}. If no parent is specified,
--- a/scripts/plot/hidden.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/hidden.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} hidden (@var{mode}) +## @deftypefn {Function File} {} hidden (@var{mode}) ## @deftypefnx {Function File} {} hidden () ## Manipulation the mesh hidden line removal. Called with no argument ## the hidden line removal is toggled. The argument @var{mode} can be either
--- a/scripts/plot/line.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/line.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} line () +## @deftypefn {Function File} {} line () ## @deftypefnx {Function File} {} line (@var{x}, @var{y}) ## @deftypefnx {Function File} {} line (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} line (@var{x}, @var{y}, @var{z}, @var{property}, @var{value}, @dots{})
--- a/scripts/plot/meshgrid.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/meshgrid.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{xx}, @var{yy}, @var{zz}] =} meshgrid (@var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {[@var{xx}, @var{yy}, @var{zz}] =} meshgrid (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {[@var{xx}, @var{yy}] =} meshgrid (@var{x}, @var{y}) ## @deftypefnx {Function File} {[@var{xx}, @var{yy}] =} meshgrid (@var{x}) ## Given vectors of @var{x} and @var{y} and @var{z} coordinates, and
--- a/scripts/plot/ndgrid.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ndgrid.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x1}, @var{x2}, @dots{}, @var{x}n) -## @deftypefnx {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x}) +## @deftypefn {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x1}, @var{x2}, @dots{}, @var{x}n) +## @deftypefnx {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x}) ## Given n vectors @var{x1}, @dots{} @var{x}n, @code{ndgrid} returns ## n arrays of dimension n. The elements of the i-th output argument ## contains the elements of the vector @var{x}i repeated over all
--- a/scripts/plot/pareto.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/pareto.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} pareto (@var{x}) +## @deftypefn {Function File} {} pareto (@var{x}) ## @deftypefnx {Function File} {} pareto (@var{x}, @var{y}) ## @deftypefnx {Function File} {} pareto (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} pareto (@dots{})
--- a/scripts/plot/patch.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/patch.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} patch () +## @deftypefn {Function File} {} patch () ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{c}) ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{z}, @var{c}) ## @deftypefnx {Function File} {} patch (@var{fv})
--- a/scripts/plot/pcolor.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/pcolor.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,11 +17,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} pcolor (@var{x}, @var{y}, @var{c}) +## @deftypefn {Function File} {} pcolor (@var{x}, @var{y}, @var{c}) ## @deftypefnx {Function File} {} pcolor (@var{c}) ## Density plot for given matrices @var{x}, and @var{y} from @code{meshgrid} and ## a matrix @var{c} corresponding to the @var{x} and @var{y} coordinates of -## the mesh's vertices. If @var{x} and @var{y} are vectors, then a typical vertex +## the mesh's vertices. If @var{x} and @var{y} are vectors, then a typical +## vertex ## is (@var{x}(j), @var{y}(i), @var{c}(i,j)). Thus, columns of @var{c} ## correspond to different @var{x} values and rows of @var{c} correspond ## to different @var{y} values.
--- a/scripts/plot/peaks.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/peaks.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} peaks () +## @deftypefn {Function File} {} peaks () ## @deftypefnx {Function File} {} peaks (@var{n}) ## @deftypefnx {Function File} {} peaks (@var{x}, @var{y}) ## @deftypefnx {Function File} {@var{z} =} peaks (@dots{})
--- a/scripts/plot/pie.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/pie.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} pie (@var{y}) +## @deftypefn {Function File} {} pie (@var{y}) ## @deftypefnx {Function File} {} pie (@var{y}, @var{explode}) ## @deftypefnx {Function File} {} pie (@dots{}, @var{labels}) ## @deftypefnx {Function File} {} pie (@var{h}, @dots{});
--- a/scripts/plot/plotmatrix.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/plotmatrix.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} plotmatrix (@var{x}, @var{y}) +## @deftypefn {Function File} {} plotmatrix (@var{x}, @var{y}) ## @deftypefnx {Function File} {} plotmatrix (@var{x}) ## @deftypefnx {Function File} {} plotmatrix (@dots{}, @var{style}) ## @deftypefnx {Function File} {} plotmatrix (@var{h}, @dots{})
--- a/scripts/plot/plotyy.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/plotyy.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} plotyy (@var{x1}, @var{y1}, @var{x2}, @var{y2}) +## @deftypefn {Function File} {} plotyy (@var{x1}, @var{y1}, @var{x2}, @var{y2}) ## @deftypefnx {Function File} {} plotyy (@dots{}, @var{fun}) ## @deftypefnx {Function File} {} plotyy (@dots{}, @var{fun1}, @var{fun2}) ## @deftypefnx {Function File} {} plotyy (@var{h}, @dots{})
--- a/scripts/plot/print.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/print.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} print () +## @deftypefn {Function File} {} print () ## @deftypefnx {Function File} {} print (@var{options}) ## @deftypefnx {Function File} {} print (@var{filename}, @var{options}) ## @deftypefnx {Function File} {} print (@var{h}, @var{filename}, @var{options}) @@ -86,9 +86,9 @@ ## Microsoft Enhanced Metafile ## @item fig ## XFig. If this format is selected the additional options -## @code{-textspecial} or @code{-textnormal} can be used to control +## @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 @code{-textnormal}). +## the figure (default is @option{-textnormal}). ## @item hpgl ## HP plotter language ## @item mf @@ -155,7 +155,7 @@ ## devices as well. ## ## @itemx -S@var{xsize},@var{ysize} -## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG and SVG. If +## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG and SVG@. If ## using the command form of the print function, you must quote the ## @var{xsize},@var{ysize} option. For example, by writing ## @w{@code{"-S640,480"}}. The size defaults to that specified by the
--- a/scripts/plot/private/__actual_axis_position__.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/private/__actual_axis_position__.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} __actual_axis_position__ (@var{h}) +## @deftypefn {Function File} {} __actual_axis_position__ (@var{h}) ## @deftypefnx {Function File} {} __actual_axis_position__ (@var{axis_struct}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/quiver.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/quiver.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} quiver (@var{u}, @var{v}) +## @deftypefn {Function File} {} quiver (@var{u}, @var{v}) ## @deftypefnx {Function File} {} quiver (@var{x}, @var{y}, @var{u}, @var{v}) ## @deftypefnx {Function File} {} quiver (@dots{}, @var{s}) ## @deftypefnx {Function File} {} quiver (@dots{}, @var{style})
--- a/scripts/plot/quiver3.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/quiver3.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} quiver3 (@var{u}, @var{v}, @var{w}) +## @deftypefn {Function File} {} quiver3 (@var{u}, @var{v}, @var{w}) ## @deftypefnx {Function File} {} quiver3 (@var{x}, @var{y}, @var{z}, @var{u}, @var{v}, @var{w}) ## @deftypefnx {Function File} {} quiver3 (@dots{}, @var{s}) ## @deftypefnx {Function File} {} quiver3 (@dots{}, @var{style})
--- a/scripts/plot/refresh.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/refresh.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} refresh () +## @deftypefn {Function File} {} refresh () ## @deftypefnx {Function File} {} refresh (@var{h}) ## Refresh a figure, forcing it to be redrawn. Called without an ## argument the current figure is redrawn, otherwise the figure pointed
--- a/scripts/plot/rose.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/rose.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} rose (@var{th}, @var{r}) +## @deftypefn {Function File} {} rose (@var{th}, @var{r}) ## @deftypefnx {Function File} {} rose (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} rose (@dots{}) ## @deftypefnx {Function File} {[@var{r}, @var{th}] =} rose (@dots{})
--- a/scripts/plot/scatter.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/scatter.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} scatter (@var{x}, @var{y}) +## @deftypefn {Function File} {} scatter (@var{x}, @var{y}) ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s}) ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{c}) ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s}, @var{c})
--- a/scripts/plot/scatter3.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/scatter3.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,14 +17,14 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} scatter3 (@var{x}, @var{y}, @var{z}, @var{s}, @var{c}) +## @deftypefn {Function File} {} scatter3 (@var{x}, @var{y}, @var{z}, @var{s}, @var{c}) ## @deftypefnx {Function File} {} scatter3 (@dots{}, 'filled') ## @deftypefnx {Function File} {} scatter3 (@dots{}, @var{style}) ## @deftypefnx {Function File} {} scatter3 (@dots{}, @var{prop}, @var{val}) ## @deftypefnx {Function File} {} scatter3 (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} scatter3 (@dots{}) ## -## Plot a scatter plot of the data in 3D. A marker is plotted at each point +## Plot a scatter plot of the data in 3D@. A marker is plotted at each point ## defined by the points in the vectors @var{x}, @var{y} and @var{z}. The size ## of the markers used is determined by @var{s}, which can be a scalar or ## a vector of the same length of @var{x}, @var{y} and @var{z}. If @var{s} is
--- a/scripts/plot/shading.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/shading.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} shading (@var{type}) +## @deftypefn {Function File} {} shading (@var{type}) ## @deftypefnx {Function File} {} shading (@var{ax}, @dots{}) ## Set the shading of surface or patch graphic objects. Valid arguments ## for @var{type} are
--- a/scripts/plot/slice.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/slice.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} slice (@var{x}, @var{y}, @var{z}, @var{v}, @var{sx}, @var{sy}, @var{sz}) +## @deftypefn {Function File} {} slice (@var{x}, @var{y}, @var{z}, @var{v}, @var{sx}, @var{sy}, @var{sz}) ## @deftypefnx {Function File} {} slice (@var{x}, @var{y}, @var{z}, @var{v}, @var{xi}, @var{yi}, @var{zi}) ## @deftypefnx {Function File} {} slice (@var{v}, @var{sx}, @var{sy}, @var{sz}) ## @deftypefnx {Function File} {} slice (@var{v}, @var{xi}, @var{yi}, @var{zi})
--- a/scripts/plot/specular.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/specular.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,13 +17,16 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{l}, @var{v}) +## @deftypefn {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{l}, @var{v}) ## @deftypefnx {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{l}, @var{v}, @var{se}) ## Calculate specular reflection strength of a surface defined by the normal ## vector elements @var{sx}, @var{sy}, @var{sz} using Phong's approximation. -## The light and view vectors can be specified using parameter @var{L} and @var{V} respectively. -## Both can be given as 2-element vectors [azimuth, elevation] in degrees or as 3-element -## vector [x, y, z]. An optional 6th argument describes the specular exponent (spread) @var{se}. +## The light and view vectors can be specified using parameter @var{L} and +## @var{V} respectively. +## Both can be given as 2-element vectors [azimuth, elevation] in degrees or as +## 3-element +## vector [x, y, z]. An optional 6th argument describes the specular exponent +## (spread) @var{se}. ## @seealso{surfl, diffuse} ## @end deftypefn
--- a/scripts/plot/sphere.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/sphere.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{x}, @var{y}, @var{z}] =} sphere (@var{n}) +## @deftypefn {Function File} {[@var{x}, @var{y}, @var{z}] =} sphere (@var{n}) ## @deftypefnx {Function File} {} sphere (@var{h}, @dots{}) ## Generates three matrices in @code{meshgrid} format, such that ## @code{surf (@var{x}, @var{y}, @var{z})} generates a unit sphere.
--- a/scripts/plot/subplot.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/subplot.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} subplot (@var{rows}, @var{cols}, @var{index}) +## @deftypefn {Function File} {} subplot (@var{rows}, @var{cols}, @var{index}) ## @deftypefnx {Function File} {} subplot (@var{rcn}) ## Set up a plot grid with @var{cols} by @var{rows} subwindows and plot ## in location given by @var{index}.
--- a/scripts/plot/surfl.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/surfl.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,12 +17,13 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} surfl (@var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {} surfl (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} surfl (@var{z}) ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}) ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}, @var{P}) ## @deftypefnx {Function File} {} surfl (@dots{},"light") -## Plot a lighted surface given matrices @var{x}, and @var{y} from @code{meshgrid} and +## Plot a lighted surface given matrices @var{x}, and @var{y} from +## @code{meshgrid} and ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex ## is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, columns of @var{z} @@ -30,7 +31,8 @@ ## to different @var{y} values. ## ## The light direction can be specified using @var{L}. It can be -## given as 2-element vector [azimuth, elevation] in degrees or as 3-element vector [lx, ly, lz]. +## given as 2-element vector [azimuth, elevation] in degrees or as 3-element +## vector [lx, ly, lz]. ## The default value is rotated 45° counter-clockwise from the current view. ## ## The material properties of the surface can specified using a 4-element vector @@ -43,8 +45,10 @@ ## @item "EXP" specular exponent ## @end table ## -## The default lighting mode "cdata", changes the cdata property to give the impression -## of a lighted surface. Please note: the alternative "light" mode, which creates a light +## The default lighting mode "cdata", changes the cdata property to give the +## impression +## of a lighted surface. Please note: the alternative "light" mode, which +## creates a light ## object to illuminate the surface is not implemented (yet). ## ## Example:
--- a/scripts/plot/surfnorm.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/surfnorm.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} surfnorm (@var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {} surfnorm (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} surfnorm (@var{z}) ## @deftypefnx {Function File} {[@var{nx}, @var{ny}, @var{nz}] =} surfnorm (@dots{}) ## @deftypefnx {Function File} {} surfnorm (@var{h}, @dots{})
--- a/scripts/plot/text.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/text.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{label}) +## @deftypefn {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{label}) ## @deftypefnx {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{z}, @var{label}) ## @deftypefnx {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{label}, @var{p1}, @var{v1}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{z}, @var{label}, @var{p1}, @var{v1}, @dots{})
--- a/scripts/plot/title.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/title.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} title (@var{title}) +## @deftypefn {Function File} {} title (@var{title}) ## @deftypefnx {Function File} {} title (@var{title}, @var{p1}, @var{v1}, @dots{}) ## Create a title object and return a handle to it. ## @end deftypefn
--- a/scripts/plot/view.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/view.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} view (@var{azimuth}, @var{elevation}) +## @deftypefn {Function File} {} view (@var{azimuth}, @var{elevation}) ## @deftypefnx {Function File} {} view (@var{dims}) ## @deftypefnx {Function File} {[@var{azimuth}, @var{elevation}] =} view () ## Set or get the viewpoint for the current axes.
--- a/scripts/plot/whitebg.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/whitebg.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,11 +17,11 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} whitebg () +## @deftypefn {Function File} {} whitebg () ## @deftypefnx {Function File} {} whitebg (@var{color}) ## @deftypefnx {Function File} {} whitebg (@var{fig}) ## @deftypefnx {Function File} {} whitebg (@var{fig}, @var{color}) -## Inverts the colors in the current current. The root properties are +## Invert the colors in the current color scheme. The root properties are ## also inverted such that all subsequent plot use the new color scheme. ## ## If defined, @var{fig} is the handle to the figure to be inverted. In @@ -29,7 +29,7 @@ ## ## The background colors of the figure and its children can be set ## specifically if @var{color} is defined. @var{color} must be a valid -## color set as a string or an RGB triplet, or the value "none". +## color set as a string or an RGB triplet, or the value "none". ## ## @seealso{reset, colordef} ## @end deftypefn
--- a/scripts/plot/xlabel.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/xlabel.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} xlabel (@var{string}) +## @deftypefn {Function File} {} xlabel (@var{string}) ## @deftypefnx {Function File} {} ylabel (@var{string}) ## @deftypefnx {Function File} {} zlabel (@var{string}) ## @deftypefnx {Function File} {} xlabel (@var{h}, @var{string})
--- a/scripts/plot/xlim.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/xlim.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{xl} =} xlim () +## @deftypefn {Function File} {@var{xl} =} xlim () ## @deftypefnx {Function File} {} xlim (@var{xl}) ## @deftypefnx {Function File} {@var{m} =} xlim ('mode') ## @deftypefnx {Function File} {} xlim (@var{m})
--- a/scripts/plot/ylabel.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ylabel.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ylabel (@var{string}) +## @deftypefn {Function File} {} ylabel (@var{string}) ## @deftypefnx {Function File} {} ylabel (@var{h}, @var{string}) ## @seealso{xlabel}. ## @end deftypefn
--- a/scripts/plot/ylim.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/ylim.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{xl} =} ylim () +## @deftypefn {Function File} {@var{xl} =} ylim () ## @deftypefnx {Function File} {} ylim (@var{xl}) ## @deftypefnx {Function File} {@var{m} =} ylim ('mode') ## @deftypefnx {Function File} {} ylim (@var{m})
--- a/scripts/plot/zlabel.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/zlabel.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} zlabel (@var{string}) +## @deftypefn {Function File} {} zlabel (@var{string}) ## @deftypefnx {Function File} {} zlabel (@var{h}, @var{string}) ## @seealso{xlabel}. ## @end deftypefn
--- a/scripts/plot/zlim.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/plot/zlim.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{xl} =} zlim () +## @deftypefn {Function File} {@var{xl} =} zlim () ## @deftypefnx {Function File} {} zlim (@var{xl}) ## @deftypefnx {Function File} {@var{m} =} zlim ('mode') ## @deftypefnx {Function File} {} zlim (@var{m})
--- a/scripts/polynomial/compan.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/compan.m Sun Jul 18 20:35:16 2010 -0700 @@ -34,17 +34,18 @@ ## $$ ## @end tex ## @ifnottex -## ## @c Set example in small font to prevent overfull line ## @smallexample +## @group ## _ _ ## | -c(2)/c(1) -c(3)/c(1) @dots{} -c(N)/c(1) -c(N+1)/c(1) | ## | 1 0 @dots{} 0 0 | ## | 0 1 @dots{} 0 0 | -## A = | . . . . . | +## A = | . . . . . | ## | . . . . . | -## | . . . . . | +## | . . . . . | ## |_ 0 0 @dots{} 1 0 _| +## @end group ## @end smallexample ## @end ifnottex ##
--- a/scripts/polynomial/mkpp.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/mkpp.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}) +## @deftypefn {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}) ## @deftypefnx {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}, @var{d}) ## ## Construct a piece-wise polynomial structure from sample points @@ -28,7 +28,8 @@ ## @code{rows (@var{p}) == length (@var{x}) - 1}. ## ## @var{p} may also be a multi-dimensional array, specifying a vector-valued -## or array-valued polynomial. The shape is determined by @var{d}. If @var{d} is +## or array-valued polynomial. The shape is determined by @var{d}. If @var{d} +## is ## not given, the default is @code{size (p)(1:end-2)}. If @var{d} is given, the ## leading dimensions of @var{p} are reshaped to conform to @var{d}. ##
--- a/scripts/polynomial/mpoles.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/mpoles.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{multp}, @var{indx}] =} mpoles (@var{p}) +## @deftypefn {Function File} {[@var{multp}, @var{indx}] =} mpoles (@var{p}) ## @deftypefnx {Function File} {[@var{multp}, @var{indx}] =} mpoles (@var{p}, @var{tol}) ## @deftypefnx {Function File} {[@var{multp}, @var{indx}] =} mpoles (@var{p}, @var{tol}, @var{reorder}) ## Identify unique poles in @var{p} and associates their multiplicity,
--- a/scripts/polynomial/pchip.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/pchip.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{pp} =} pchip (@var{x}, @var{y}) +## @deftypefn {Function File} {@var{pp} =} pchip (@var{x}, @var{y}) ## @deftypefnx {Function File} {@var{yi} =} pchip (@var{x}, @var{y}, @var{xi}) ## ## Piecewise Cubic Hermite interpolating polynomial. Called with two
--- a/scripts/polynomial/ppder.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/ppder.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn{Function File} {ppd =} ppder (pp) +## @deftypefn {Function File} {ppd =} ppder (pp) ## Computes the piecewise derivative of a piecewise polynomial struct @var{pp}. ## @seealso{mkpp,ppval} ## @end deftypefn
--- a/scripts/polynomial/ppint.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/ppint.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn{Function File} {ppd =} ppint (pp, c) +## @deftypefn {Function File} {ppd =} ppint (pp, c) ## Computes the antiderivative of a piecewise polynomial struct @var{pp}. ## @var{c}, if given, is the constant of integration. ## @seealso{mkpp,ppval}
--- a/scripts/polynomial/ppjumps.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/ppjumps.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn{Function File} {ppd =} ppjumps (pp) +## @deftypefn {Function File} {ppd =} ppjumps (pp) ## Evaluates the boundary jumps of a piecewise polynomial. ## If there are n intervals, and the dimensionality of pp is d, ## the resulting array has dimensions @code{[d, n-1]}.
--- a/scripts/polynomial/ppval.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/ppval.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{yi} =} ppval (@var{pp}, @var{xi}) ## Evaluate piece-wise polynomial @var{pp} at the points @var{xi}. -## If @var{pp} is scalar-valued, the result is an array of the same shape as @var{xi}. +## If @var{pp} is scalar-valued, the result is an array of the same shape as +## @var{xi}. ## Otherwise, the size of the result is @code{[pp.d, length(@var{xi})]} if ## @var{xi} is a vector, or @code{[pp.d, size(@var{xi})]} if it is a multi-dimensional ## array. If pp.orient is 1, the dimensions are permuted as in interp1, to
--- a/scripts/polynomial/spline.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/polynomial/spline.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{pp} =} spline (@var{x}, @var{y}) +## @deftypefn {Function File} {@var{pp} =} spline (@var{x}, @var{y}) ## @deftypefnx {Function File} {@var{yi} =} spline (@var{x}, @var{y}, @var{xi}) ## ## Return the cubic spline interpolant of @var{y} at points @var{x}.
--- a/scripts/set/intersect.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/set/intersect.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} intersect (@var{a}, @var{b}) +## @deftypefn {Function File} {} intersect (@var{a}, @var{b}) ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} intersect (@var{a}, @var{b}) ## ## Return the elements in both @var{a} and @var{b}, sorted in ascending
--- a/scripts/set/powerset.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/set/powerset.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} powerset (@var{a}) +## @deftypefn {Function File} {} powerset (@var{a}) ## @deftypefnx {Function File} {} powerset (@var{a}, "rows") ## ## Return the cell array of all subsets of the set @var{a}.
--- a/scripts/set/setdiff.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/set/setdiff.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} setdiff (@var{a}, @var{b}) +## @deftypefn {Function File} {} setdiff (@var{a}, @var{b}) ## @deftypefnx {Function File} {} setdiff (@var{a}, @var{b}, "rows") ## @deftypefnx {Function File} {[@var{c}, @var{i}] =} setdiff (@var{a}, @var{b}) ## Return the elements in @var{a} that are not in @var{b}, sorted in
--- a/scripts/set/setxor.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/set/setxor.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} setxor (@var{a}, @var{b}) +## @deftypefn {Function File} {} setxor (@var{a}, @var{b}) ## @deftypefnx {Function File} {} setxor (@var{a}, @var{b}, 'rows') ## ## Return the elements exclusive to @var{a} or @var{b}, sorted in ascending @@ -28,7 +28,8 @@ ## ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} setxor (@var{a}, @var{b}) ## -## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and @code{b(ib)} are +## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and +## @code{b(ib)} are ## disjoint sets whose union is @var{c}. ## ## @seealso{unique, union, intersect, setdiff, ismember}
--- a/scripts/set/union.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/set/union.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,8 +19,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} union (@var{a}, @var{b}) -## @deftypefnx{Function File} {} union (@var{a}, @var{b}, "rows") +## @deftypefn {Function File} {} union (@var{a}, @var{b}) +## @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, @@ -46,7 +46,8 @@ ## ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b}) ## -## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and @code{b(ib)} are +## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and +## @code{b(ib)} are ## disjoint sets whose union is @var{c}. ## ## @seealso{intersect, setdiff, unique}
--- a/scripts/set/unique.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/set/unique.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} unique (@var{x}) +## @deftypefn {Function File} {} unique (@var{x}) ## @deftypefnx {Function File} {} unique (@var{x}, "rows") ## @deftypefnx {Function File} {} unique (@dots{}, "first") ## @deftypefnx {Function File} {} unique (@dots{}, "last")
--- a/scripts/signal/fftshift.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/signal/fftshift.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} fftshift (@var{v}) +## @deftypefn {Function File} {} fftshift (@var{v}) ## @deftypefnx {Function File} {} fftshift (@var{v}, @var{dim}) ## Perform a shift of the vector @var{v}, for use with the @code{fft} ## and @code{ifft} functions, in order the move the frequency 0 to the
--- a/scripts/signal/filter2.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/signal/filter2.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{y} =} filter2 (@var{b}, @var{x}) +## @deftypefn {Function File} {@var{y} =} filter2 (@var{b}, @var{x}) ## @deftypefnx {Function File} {@var{y} =} filter2 (@var{b}, @var{x}, @var{shape}) ## Apply the 2-D FIR filter @var{b} to @var{x}. If the argument ## @var{shape} is specified, return an array of the desired shape.
--- a/scripts/signal/ifftshift.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/signal/ifftshift.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ifftshift (@var{v}) +## @deftypefn {Function File} {} ifftshift (@var{v}) ## @deftypefnx {Function File} {} ifftshift (@var{v}, @var{dim}) ## Undo the action of the @code{fftshift} function. For even length ## @var{v}, @code{fftshift} is its own inverse, but odd lengths differ
--- a/scripts/sparse/bicgstab.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/bicgstab.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,20 +17,26 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} bicgstab (@var{A}, @var{b}) +## @deftypefn {Function File} {} bicgstab (@var{A}, @var{b}) ## @deftypefnx {Function File} {} bicgstab (@var{A}, @var{b}, @var{tol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) ## This procedure attempts to solve a system of linear equations A*x = b for x. ## The @var{A} must be square, symmetric and positive definite real matrix N*N. ## The @var{b} must be a one column vector with a length of N. -## The @var{tol} specifies the tolerance of the method, the default value is 1e-6. -## The @var{maxit} specifies the maximum number of iterations, the default value is min(20,N). -## The @var{M1} specifies a preconditioner, can also be a function handler which returns M\X. -## The @var{M2} combined with @var{M1} defines preconditioner as preconditioner=M1*M2. +## The @var{tol} specifies the tolerance of the method, the default value is +## 1e-6. +## The @var{maxit} specifies the maximum number of iterations, the default value +## is min(20,N). +## The @var{M1} specifies a preconditioner, can also be a function handler which +## returns M\X. +## The @var{M2} combined with @var{M1} defines preconditioner as +## preconditioner=M1*M2. ## The @var{x0} is the initial guess, the default value is zeros(N,1). ## ## The value @var{x} is a computed result of this procedure. -## The value @var{flag} can be 0 when we reach tolerance in @var{maxit} iterations, 1 when -## we don't reach tolerance in @var{maxit} iterations and 3 when the procedure stagnates. +## The value @var{flag} can be 0 when we reach tolerance in @var{maxit} +## iterations, 1 when +## we don't reach tolerance in @var{maxit} iterations and 3 when the procedure +## stagnates. ## The value @var{relres} is a relative residual - norm(b-A*x)/norm(b). ## The value @var{iter} is an iteration number in which x was computed. ## The value @var{resvec} is a vector of @var{relres} for each iteration.
--- a/scripts/sparse/cgs.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/cgs.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,15 +17,18 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} cgs (@var{A}, @var{b}) +## @deftypefn {Function File} {} cgs (@var{A}, @var{b}) ## @deftypefnx {Function File} {} cgs (@var{A}, @var{b}, @var{tol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) ## This procedure attempts to solve a system of linear equations A*x = b for x. ## The @var{A} must be square, symmetric and positive definite real matrix N*N. ## The @var{b} must be a one column vector with a length of N. ## The @var{tol} specifies the tolerance of the method, default value is 1e-6. -## The @var{maxit} specifies the maximum number of iteration, default value is MIN(20,N). -## The @var{M1} specifies a preconditioner, can also be a function handler which returns M\X. -## The @var{M2} combined with @var{M1} defines preconditioner as preconditioner=M1*M2. +## The @var{maxit} specifies the maximum number of iteration, default value is +## MIN(20,N). +## The @var{M1} specifies a preconditioner, can also be a function handler which +## returns M\X. +## The @var{M2} combined with @var{M1} defines preconditioner as +## preconditioner=M1*M2. ## The @var{x0} is initial guess, default value is zeros(N,1). ## ## @end deftypefn
--- a/scripts/sparse/etreeplot.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/etreeplot.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} etreeplot (@var{tree}) +## @deftypefn {Function File} {} etreeplot (@var{tree}) ## @deftypefnx {Function File} {} etreeplot (@var{tree}, @var{node_style}, @var{edge_style}) ## Plot the elimination tree of the matrix @var{s} or ## @code{@var{s}+@var{s}'} if @var{s} in non-symmetric. The optional
--- a/scripts/sparse/gplot.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/gplot.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} gplot (@var{a}, @var{xy}) +## @deftypefn {Function File} {} gplot (@var{a}, @var{xy}) ## @deftypefnx {Function File} {} gplot (@var{a}, @var{xy}, @var{line_style}) ## @deftypefnx {Function File} {[@var{x}, @var{y}] =} gplot (@var{a}, @var{xy}) ## Plot a graph defined by @var{A} and @var{xy} in the graph theory
--- a/scripts/sparse/pcg.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/pcg.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} pcg (@var{a}, @var{b}, @var{tol}, @var{maxit}, @var{m1}, @var{m2}, @var{x0}, @dots{}) +## @deftypefn {Function File} {@var{x} =} pcg (@var{a}, @var{b}, @var{tol}, @var{maxit}, @var{m1}, @var{m2}, @var{x0}, @dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}, @var{eigest}] =} pcg (@dots{}) ## ## Solves the linear system of equations @code{@var{a} * @var{x} = @@ -198,12 +198,16 @@ ## ## References: ## -## [1] C.T. Kelley, @cite{Iterative Methods for Linear and Nonlinear Equations}, -## SIAM, 1995 (the base PCG algorithm) +## @enumerate +## @item +## C.T. Kelley, @cite{Iterative Methods for Linear and Nonlinear Equations}, +## SIAM, 1995. (the base PCG algorithm) ## -## [2] Y. Saad, @cite{Iterative Methods for Sparse Linear Systems}, PWS 1996 -## (condition number estimate from PCG) Revised version of this book is -## available online at @url{http://www-users.cs.umn.edu/~saad/books.html} +## @item +## Y. Saad, @cite{Iterative Methods for Sparse Linear Systems}, PWS 1996. +## (condition number estimate from PCG) Revised version of this book is +## available online at @url{http://www-users.cs.umn.edu/~saad/books.html} +## @end enumerate ## ## @seealso{sparse, pcr} ## @end deftypefn
--- a/scripts/sparse/pcr.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/pcr.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} pcr (@var{a}, @var{b}, @var{tol}, @var{maxit}, @var{m}, @var{x0}, @dots{}) +## @deftypefn {Function File} {@var{x} =} pcr (@var{a}, @var{b}, @var{tol}, @var{maxit}, @var{m}, @var{x0}, @dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} pcr (@dots{}) ## ## Solves the linear system of equations @code{@var{a} * @var{x} =
--- a/scripts/sparse/spdiags.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/spdiags.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{b}, @var{c}] =} spdiags (@var{a}) +## @deftypefn {Function File} {[@var{b}, @var{c}] =} spdiags (@var{a}) ## @deftypefnx {Function File} {@var{b} =} spdiags (@var{a}, @var{c}) ## @deftypefnx {Function File} {@var{b} =} spdiags (@var{v}, @var{c}, @var{a}) ## @deftypefnx {Function File} {@var{b} =} spdiags (@var{v}, @var{c}, @var{m}, @var{n})
--- a/scripts/sparse/speye.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/speye.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{y} =} speye (@var{m}) +## @deftypefn {Function File} {@var{y} =} speye (@var{m}) ## @deftypefnx {Function File} {@var{y} =} speye (@var{m}, @var{n}) ## @deftypefnx {Function File} {@var{y} =} speye (@var{sz}) ## Returns a sparse identity matrix. This is significantly more
--- a/scripts/sparse/sprand.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/sprand.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,7 @@ ## public domain. ## -*- texinfo -*- -## @deftypefn {Function File} {} sprand (@var{m}, @var{n}, @var{d}) +## @deftypefn {Function File} {} sprand (@var{m}, @var{n}, @var{d}) ## @deftypefnx {Function File} {} sprand (@var{s}) ## Generate a random sparse matrix. The size of the matrix will be ## @var{m} by @var{n}, with a density of values given by @var{d}.
--- a/scripts/sparse/sprandn.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/sprandn.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,7 @@ ## public domain. ## -*- texinfo -*- -## @deftypefn {Function File} {} sprandn (@var{m}, @var{n}, @var{d}) +## @deftypefn {Function File} {} sprandn (@var{m}, @var{n}, @var{d}) ## @deftypefnx {Function File} {} sprandn (@var{s}) ## Generate a random sparse matrix. The size of the matrix will be ## @var{m} by @var{n}, with a density of values given by @var{d}.
--- a/scripts/sparse/sprandsym.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/sprandsym.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} sprandsym (@var{n}, @var{d}) +## @deftypefn {Function File} {} sprandsym (@var{n}, @var{d}) ## @deftypefnx {Function File} {} sprandsym (@var{s}) ## Generate a symmetric random sparse matrix. The size of the matrix will be ## @var{n} by @var{n}, with a density of values given by @var{d}.
--- a/scripts/sparse/spstats.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/spstats.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{s}) +## @deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{s}) ## @deftypefnx {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{s}, @var{j}) ## Return the stats for the non-zero elements of the sparse matrix @var{s}. ## @var{count} is the number of non-zeros in each column, @var{mean}
--- a/scripts/sparse/spy.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/spy.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} spy (@var{x}) +## @deftypefn {Function File} {} spy (@var{x}) ## @deftypefnx {Function File} {} spy (@dots{}, @var{markersize}) ## @deftypefnx {Function File} {} spy (@dots{}, @var{line_spec}) ## Plot the sparsity pattern of the sparse matrix @var{x}. If the argument
--- a/scripts/sparse/treelayout.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/treelayout.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,10 +17,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} treelayout (@var{Tree}) +## @deftypefn {Function File} {} treelayout (@var{Tree}) ## @deftypefnx {Function File} {} treelayout (@var{Tree}, @var{permutation}) -## treelayout lays out a tree or a forest. The first argument @var{Tree} is a vector of -## predecessors, optional parameter @var{permutation} is an optional postorder permutation. +## treelayout lays out a tree or a forest. The first argument @var{Tree} is a +## vector of +## predecessors, optional parameter @var{permutation} is an optional postorder +## permutation. ## The complexity of the algorithm is O(n) in ## terms of time and memory requirements. ## @seealso{etreeplot, gplot,treeplot}
--- a/scripts/sparse/treeplot.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/sparse/treeplot.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} treeplot (@var{tree}) +## @deftypefn {Function File} {} treeplot (@var{tree}) ## @deftypefnx {Function File} {} treeplot (@var{tree}, @var{line_style}, @var{edge_style}) ## Produces a graph of tree or forest. The first argument is vector of ## predecessors, optional parameters @var{line_style} and @var{edge_style}
--- a/scripts/specfun/bessel.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/specfun/bessel.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt}) +## @deftypefn {Loadable Function} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt}) ## @deftypefnx {Loadable Function} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt}) ## @deftypefnx {Loadable Function} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt}) ## @deftypefnx {Loadable Function} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt}) @@ -33,14 +33,17 @@ ## 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, +## 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, +## 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 by +## = 2) kind. If the argument @var{opt} is supplied, the result is multiplied +## by ## @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for ## @var{k} = 2. ## @end table
--- a/scripts/specfun/legendre.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/specfun/legendre.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,10 +18,10 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{l} =} legendre (@var{n}, @var{x}) +## @deftypefn {Function File} {@var{l} =} legendre (@var{n}, @var{x}) ## @deftypefnx {Function File} {@var{l} =} legendre (@var{n}, @var{x}, @var{normalization}) ## Compute the Legendre function of degree @var{n} and order -## @var{m} = 0 @dots{} N. The optional argument, @var{normalization}, +## @var{m} = 0 @dots{} N@. The optional argument, @var{normalization}, ## may be one of @code{"unnorm"}, @code{"sch"}, or @code{"norm"}. ## The default is @code{"unnorm"}. The value of @var{n} must be a ## non-negative scalar integer.
--- a/scripts/specfun/pow2.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/specfun/pow2.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} pow2 (@var{x}) +## @deftypefn {Mapping Function} {} pow2 (@var{x}) ## @deftypefnx {Mapping Function} {} pow2 (@var{f}, @var{e}) ## With one argument, computes ## @tex
--- a/scripts/statistics/base/center.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/center.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} center (@var{x}) +## @deftypefn {Function File} {} center (@var{x}) ## @deftypefnx {Function File} {} center (@var{x}, @var{dim}) ## If @var{x} is a vector, subtract its mean. ## If @var{x} is a matrix, do the above for each column.
--- a/scripts/statistics/base/histc.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/histc.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{n} =} histc (@var{y}, @var{edges}) +## @deftypefn {Function File} {@var{n} =} histc (@var{y}, @var{edges}) ## @deftypefnx {Function File} {@var{n} =} histc (@var{y}, @var{edges}, @var{dim}) ## @deftypefnx {Function File} {[@var{n}, @var{idx}] =} histc (@dots{}) ## Produce histogram counts.
--- a/scripts/statistics/base/kendall.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/kendall.m Sun Jul 18 20:35:16 2010 -0700 @@ -30,7 +30,7 @@ ## ## For two data vectors @var{x}, @var{y} of common length @var{n}, ## Kendall's @var{tau} is the correlation of the signs of all rank -## differences of @var{x} and @var{y}; i.e., if both @var{x} and +## differences of @var{x} and @var{y}; i.e., if both @var{x} and ## @var{y} have distinct entries, then ## ## @tex
--- a/scripts/statistics/base/meansq.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/meansq.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} meansq (@var{x}) +## @deftypefn {Function File} {} meansq (@var{x}) ## @deftypefnx {Function File} {} meansq (@var{x}, @var{dim}) ## For vector arguments, return the mean square of the values. ## For matrix arguments, return a row vector containing the mean square
--- a/scripts/statistics/base/prctile.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/prctile.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{y} =} prctile (@var{x}, @var{p}) +## @deftypefn {Function File} {@var{y} =} prctile (@var{x}, @var{p}) ## @deftypefnx {Function File} {@var{q} =} prctile (@var{x}, @var{p}, @var{dim}) ## For a sample @var{x}, compute the quantiles, @var{y}, corresponding ## to the cumulative probability values, P, in percent. All non-numeric
--- a/scripts/statistics/base/quantile.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/quantile.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,11 +17,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{q} =} quantile (@var{x}, @var{p}) +## @deftypefn {Function File} {@var{q} =} quantile (@var{x}, @var{p}) ## @deftypefnx {Function File} {@var{q} =} quantile (@var{x}, @var{p}, @var{dim}) ## @deftypefnx {Function File} {@var{q} =} quantile (@var{x}, @var{p}, @var{dim}, @var{method}) ## For a sample, @var{x}, calculate the quantiles, @var{q}, corresponding to -## the cumulative probability values in @var{p}. All non-numeric values (NaNs) of +## the cumulative probability values in @var{p}. All non-numeric values (NaNs) +## of ## @var{x} are ignored. ## ## If @var{x} is a matrix, compute the quantiles for each column and
--- a/scripts/statistics/base/range.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/range.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} range (@var{x}) +## @deftypefn {Function File} {} range (@var{x}) ## @deftypefnx {Function File} {} range (@var{x}, @var{dim}) ## If @var{x} is a vector, return the range, i.e., the difference ## between the maximum and the minimum, of the input data.
--- a/scripts/statistics/base/std.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/std.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} std (@var{x}) +## @deftypefn {Function File} {} std (@var{x}) ## @deftypefnx {Function File} {} std (@var{x}, @var{opt}) ## @deftypefnx {Function File} {} std (@var{x}, @var{opt}, @var{dim}) ## If @var{x} is a vector, compute the standard deviation of the elements @@ -40,19 +40,20 @@ ## If @var{x} is a matrix, compute the standard deviation for ## each column and return them in a row vector. ## -## The argument @var{opt} determines the type of normalization to use. Valid values -## are +## The argument @var{opt} determines the type of normalization to use. Valid +## values are ## ## @table @asis ## @item 0: -## normalizes with @math{N-1}, provides the square root of best unbiased estimator of -## the variance [default] +## 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 +## normalizes with @math{N}, this provides the square root of the second +## moment around the mean ## @end table ## -## The third argument @var{dim} determines the dimension along which the standard +## The third argument @var{dim} determines the dimension along which the +## standard ## deviation is calculated. ## @seealso{mean, median} ## @end deftypefn
--- a/scripts/statistics/base/table.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/base/table.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{t}, @var{l_x}] =} table (@var{x}) +## @deftypefn {Function File} {[@var{t}, @var{l_x}] =} table (@var{x}) ## @deftypefnx {Function File} {[@var{t}, @var{l_x}, @var{l_y}] =} table (@var{x}, @var{y}) ## Create a contingency table @var{t} from data vectors. The @var{l} ## vectors are the corresponding levels.
--- a/scripts/statistics/distributions/betacdf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/betacdf.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} betacdf (@var{x}, @var{a}, @var{b}) ## For each element of @var{x}, returns the CDF at @var{x} of the beta ## distribution with parameters @var{a} and @var{b}, i.e., -## PROB (beta (@var{a}, @var{b}) <= @var{x}). +## PROB (beta (@var{a}, @var{b}) @leq{} @var{x}). ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/betarnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/betarnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} betarnd (@var{a}, @var{b}, @var{r}, @var{c}) +## @deftypefn {Function File} {} betarnd (@var{a}, @var{b}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} betarnd (@var{a}, @var{b}, @var{sz}) ## Return an @var{r} by @var{c} or @code{size (@var{sz})} matrix of ## random samples from the Beta distribution with parameters @var{a} and
--- a/scripts/statistics/distributions/binornd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/binornd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} binornd (@var{n}, @var{p}, @var{r}, @var{c}) +## @deftypefn {Function File} {} binornd (@var{n}, @var{p}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} binornd (@var{n}, @var{p}, @var{sz}) ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of ## random samples from the binomial distribution with parameters @var{n}
--- a/scripts/statistics/distributions/cauchy_rnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/cauchy_rnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} cauchy_rnd (@var{lambda}, @var{sigma}, @var{r}, @var{c}) +## @deftypefn {Function File} {} cauchy_rnd (@var{lambda}, @var{sigma}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} cauchy_rnd (@var{lambda}, @var{sigma}, @var{sz}) ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of ## random samples from the Cauchy distribution with parameters @var{lambda}
--- a/scripts/statistics/distributions/chi2rnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/chi2rnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} chi2rnd (@var{n}, @var{r}, @var{c}) +## @deftypefn {Function File} {} chi2rnd (@var{n}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} chi2rnd (@var{n}, @var{sz}) ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of ## random samples from the chisquare distribution with @var{n} degrees
--- a/scripts/statistics/distributions/discrete_rnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/discrete_rnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} discrete_rnd (@var{n}, @var{v}, @var{p}) +## @deftypefn {Function File} {} discrete_rnd (@var{n}, @var{v}, @var{p}) ## @deftypefnx {Function File} {} discrete_rnd (@var{v}, @var{p}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} discrete_rnd (@var{v}, @var{p}, @var{sz}) ## Generate a row vector containing a random sample of size @var{n} from
--- a/scripts/statistics/distributions/empirical_rnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/empirical_rnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} empirical_rnd (@var{n}, @var{data}) +## @deftypefn {Function File} {} empirical_rnd (@var{n}, @var{data}) ## @deftypefnx {Function File} {} empirical_rnd (@var{data}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} empirical_rnd (@var{data}, @var{sz}) ## Generate a bootstrap sample of size @var{n} from the empirical
--- a/scripts/statistics/distributions/exprnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/exprnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} exprnd (@var{lambda}, @var{r}, @var{c}) +## @deftypefn {Function File} {} exprnd (@var{lambda}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} exprnd (@var{lambda}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the ## exponential distribution with mean @var{lambda}, which must be a
--- a/scripts/statistics/distributions/fcdf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/fcdf.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} fcdf (@var{x}, @var{m}, @var{n}) ## For each element of @var{x}, compute the CDF at @var{x} of the F ## distribution with @var{m} and @var{n} degrees of freedom, i.e., -## PROB (F (@var{m}, @var{n}) <= @var{x}). +## PROB (F (@var{m}, @var{n}) @leq{} @var{x}). ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/frnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/frnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} frnd (@var{m}, @var{n}, @var{r}, @var{c}) +## @deftypefn {Function File} {} frnd (@var{m}, @var{n}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} frnd (@var{m}, @var{n}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the F ## distribution with @var{m} and @var{n} degrees of freedom. Both
--- a/scripts/statistics/distributions/gamrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/gamrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} gamrnd (@var{a}, @var{b}, @var{r}, @var{c}) +## @deftypefn {Function File} {} gamrnd (@var{a}, @var{b}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} gamrnd (@var{a}, @var{b}, @var{sz}) ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of ## random samples from the Gamma distribution with parameters @var{a}
--- a/scripts/statistics/distributions/geornd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/geornd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} geornd (@var{p}, @var{r}, @var{c}) +## @deftypefn {Function File} {} geornd (@var{p}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} geornd (@var{p}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the ## geometric distribution with parameter @var{p}, which must be a scalar
--- a/scripts/statistics/distributions/hygernd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/hygernd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} hygernd (@var{t}, @var{m}, @var{n}, @var{r}, @var{c}) +## @deftypefn {Function File} {} hygernd (@var{t}, @var{m}, @var{n}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} hygernd (@var{t}, @var{m}, @var{n}, @var{sz}) ## @deftypefnx {Function File} {} hygernd (@var{t}, @var{m}, @var{n}) ## Return an @var{r} by @var{c} matrix of random samples from the
--- a/scripts/statistics/distributions/kolmogorov_smirnov_cdf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/kolmogorov_smirnov_cdf.m Sun Jul 18 20:35:16 2010 -0700 @@ -37,7 +37,7 @@ ## for @var{x} > 0. ## ## The optional parameter @var{tol} specifies the precision up to which -## the series should be evaluated; the default is @var{tol} = @code{eps}. +## the series should be evaluated; the default is @var{tol} = @code{eps}. ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/laplace_rnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/laplace_rnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} laplace_rnd (@var{r}, @var{c}) +## @deftypefn {Function File} {} laplace_rnd (@var{r}, @var{c}) ## @deftypefnx {Function File} {} laplace_rnd (@var{sz}); ## Return an @var{r} by @var{c} matrix of random numbers from the ## Laplace distribution. Or if @var{sz} is a vector, create a matrix of
--- a/scripts/statistics/distributions/logistic_rnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/logistic_rnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} logistic_rnd (@var{r}, @var{c}) +## @deftypefn {Function File} {} logistic_rnd (@var{r}, @var{c}) ## @deftypefnx {Function File} {} logistic_rnd (@var{sz}) ## Return an @var{r} by @var{c} matrix of random numbers from the ## logistic distribution. Or if @var{sz} is a vector, create a matrix of
--- a/scripts/statistics/distributions/lognrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/lognrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} lognrnd (@var{mu}, @var{sigma}, @var{r}, @var{c}) +## @deftypefn {Function File} {} lognrnd (@var{mu}, @var{sigma}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} lognrnd (@var{mu}, @var{sigma}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the ## lognormal distribution with parameters @var{mu} and @var{sigma}. Both
--- a/scripts/statistics/distributions/nbinrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/nbinrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} nbinrnd (@var{n}, @var{p}, @var{r}, @var{c}) +## @deftypefn {Function File} {} nbinrnd (@var{n}, @var{p}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} nbinrnd (@var{n}, @var{p}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the Pascal ## (negative binomial) distribution with parameters @var{n} and @var{p}.
--- a/scripts/statistics/distributions/normrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/normrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} normrnd (@var{m}, @var{s}, @var{r}, @var{c}) +## @deftypefn {Function File} {} normrnd (@var{m}, @var{s}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} normrnd (@var{m}, @var{s}, @var{sz}) ## Return an @var{r} by @var{c} or @code{size (@var{sz})} matrix of ## random samples from the normal distribution with parameters mean @var{m}
--- a/scripts/statistics/distributions/stdnormal_rnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/stdnormal_rnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} stdnormal_rnd (@var{r}, @var{c}) +## @deftypefn {Function File} {} stdnormal_rnd (@var{r}, @var{c}) ## @deftypefnx {Function File} {} stdnormal_rnd (@var{sz}) ## Return an @var{r} by @var{c} or @code{size (@var{sz})} matrix of ## random numbers from the standard normal distribution.
--- a/scripts/statistics/distributions/tcdf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/tcdf.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} tcdf (@var{x}, @var{n}) ## For each element of @var{x}, compute the cumulative distribution ## function (CDF) at @var{x} of the t (Student) distribution with -## @var{n} degrees of freedom, i.e., PROB (t(@var{n}) <= @var{x}). +## @var{n} degrees of freedom, i.e., PROB (t(@var{n}) @leq{} @var{x}). ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/trnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/trnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} trnd (@var{n}, @var{r}, @var{c}) +## @deftypefn {Function File} {} trnd (@var{n}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} trnd (@var{n}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the t ## (Student) distribution with @var{n} degrees of freedom. @var{n} must
--- a/scripts/statistics/distributions/unidrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/unidrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,12 +17,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} unidrnd (@var{mx}); +## @deftypefn {Function File} {} unidrnd (@var{mx}); ## @deftypefnx {Function File} {} unidrnd (@var{mx}, @var{v}); ## @deftypefnx {Function File} {} unidrnd (@var{mx}, @var{m}, @var{n}, @dots{}); ## Return random values from discrete uniform distribution, with maximum ## value(s) given by the integer @var{mx}, which may be a scalar or -## multidimensional array. +## multi-dimensional array. ## ## If @var{mx} is a scalar, the size of the result is specified by ## the vector @var{v}, or by the optional arguments @var{m}, @var{n},
--- a/scripts/statistics/distributions/unifcdf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/unifcdf.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} unifcdf (@var{x}, @var{a}, @var{b}) ## Return the CDF at @var{x} of the uniform distribution on [@var{a}, -## @var{b}], i.e., PROB (uniform (@var{a}, @var{b}) <= x). +## @var{b}], i.e., PROB (uniform (@var{a}, @var{b}) @leq{} x). ## ## Default values are @var{a} = 0, @var{b} = 1. ## @end deftypefn
--- a/scripts/statistics/distributions/unifrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/unifrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} unifrnd (@var{a}, @var{b}, @var{r}, @var{c}) +## @deftypefn {Function File} {} unifrnd (@var{a}, @var{b}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} unifrnd (@var{a}, @var{b}, @var{sz}) ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of ## random samples from the uniform distribution on [@var{a}, @var{b}].
--- a/scripts/statistics/distributions/wblcdf.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/wblcdf.m Sun Jul 18 20:35:16 2010 -0700 @@ -30,7 +30,7 @@ ## @example ## 1 - exp(-(x/shape)^scale) ## @end example -## for @var{x} >= 0. +## for @var{x} @geq{} 0. ## @end ifnottex ## @end deftypefn
--- a/scripts/statistics/distributions/wblrnd.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/distributions/wblrnd.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} wblrnd (@var{scale}, @var{shape}, @var{r}, @var{c}) +## @deftypefn {Function File} {} wblrnd (@var{scale}, @var{shape}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} wblrnd (@var{scale}, @var{shape}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the ## Weibull distribution with parameters @var{scale} and @var{shape}
--- a/scripts/statistics/tests/kolmogorov_smirnov_test.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/tests/kolmogorov_smirnov_test.m Sun Jul 18 20:35:16 2010 -0700 @@ -39,7 +39,7 @@ ## With the optional argument string @var{alt}, the alternative of ## interest can be selected. If @var{alt} is @code{"!="} or ## @code{"<>"}, the null is tested against the two-sided alternative F -## != G. In this case, the test statistic @var{ks} follows a two-sided +## != G@. In this case, the test statistic @var{ks} follows a two-sided ## Kolmogorov-Smirnov distribution. If @var{alt} is @code{">"}, the ## one-sided alternative F > G is considered. Similarly for @code{"<"}, ## the one-sided alternative F > G is considered. In this case, the
--- a/scripts/statistics/tests/kolmogorov_smirnov_test_2.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/tests/kolmogorov_smirnov_test_2.m Sun Jul 18 20:35:16 2010 -0700 @@ -28,7 +28,7 @@ ## With the optional argument string @var{alt}, the alternative of ## interest can be selected. If @var{alt} is @code{"!="} or ## @code{"<>"}, the null is tested against the two-sided alternative F -## != G. In this case, the test statistic @var{ks} follows a two-sided +## != G@. In this case, the test statistic @var{ks} follows a two-sided ## Kolmogorov-Smirnov distribution. If @var{alt} is @code{">"}, the ## one-sided alternative F > G is considered. Similarly for @code{"<"}, ## the one-sided alternative F < G is considered. In this case, the
--- a/scripts/statistics/tests/wilcoxon_test.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/statistics/tests/wilcoxon_test.m Sun Jul 18 20:35:16 2010 -0700 @@ -25,7 +25,7 @@ ## approximately follows a standard normal distribution when @var{n} > 25. ## ## @strong{Warning}: This function assumes a normal distribution for @var{z} -## and thus is invalid for @var{n} <= 25. +## and thus is invalid for @var{n} @leq{} 25. ## ## With the optional argument string @var{alt}, the alternative of ## interest can be selected. If @var{alt} is @code{"!="} or
--- a/scripts/strings/base2dec.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/strings/base2dec.m Sun Jul 18 20:35:16 2010 -0700 @@ -30,7 +30,7 @@ ## ## If @var{s} is a matrix, returns a column vector with one value per ## row of @var{s}. If a row contains invalid symbols then the -## corresponding value will be NaN. Rows are right-justified before +## corresponding value will be NaN@. Rows are right-justified before ## converting so that trailing spaces are ignored. ## ## If @var{b} is a string, the characters of @var{b} are used as the
--- a/scripts/strings/index.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/strings/index.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} index (@var{s}, @var{t}) +## @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,
--- a/scripts/strings/mat2str.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/strings/mat2str.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{s} =} mat2str (@var{x}, @var{n}) +## @deftypefn {Function File} {@var{s} =} mat2str (@var{x}, @var{n}) ## @deftypefnx {Function File} {@var{s} =} mat2str (@dots{}, 'class') ## ## Format real/complex numerical matrices as strings. This function
--- a/scripts/strings/strchr.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/strings/strchr.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,10 +17,11 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{idx} =} strchr (@var{str}, @var{chars}) +## @deftypefn {Function File} {@var{idx} =} strchr (@var{str}, @var{chars}) ## @deftypefnx {Function File} {@var{idx} =} strchr (@var{str}, @var{chars}, @var{n}) ## @deftypefnx {Function File} {@var{idx} =} strchr (@var{str}, @var{chars}, @var{n}, @var{direction}) -## Search for the string @var{str} for occurrences of characters from the set @var{chars}. +## Search for the string @var{str} for occurrences of characters from the set +## @var{chars}. ## The return value, as well as the @var{n} and @var{direction} arguments behave ## identically as in @code{find}. ##
--- a/scripts/strings/substr.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/strings/substr.m Sun Jul 18 20:35:16 2010 -0700 @@ -35,7 +35,7 @@ ## @end group ## @end example ## -## This function is patterned after AWK. You can get the same result by +## This function is patterned after AWK@. You can get the same result by ## @code{@var{s}(@var{offset} : (@var{offset} + @var{len} - 1))}. ## @end deftypefn
--- a/scripts/strings/validatestring.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/strings/validatestring.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{validstr} =} validatestring (@var{str}, @var{strarray}) +## @deftypefn {Function File} {@var{validstr} =} validatestring (@var{str}, @var{strarray}) ## @deftypefnx {Function File} {@var{validstr} =} validatestring (@var{str}, @var{strarray}, @var{funcname}) ## @deftypefnx {Function File} {@var{validstr} =} validatestring (@var{str}, @var{strarray}, @var{funcname}, @var{varname}) ## @deftypefnx {Function File} {@var{validstr} =} validatestring (@dots{}, @var{position})
--- a/scripts/testfun/assert.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/testfun/assert.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} assert (@var{cond}) +## @deftypefn {Function File} {} assert (@var{cond}) ## @deftypefnx {Function File} {} assert (@var{cond}, @var{errmsg}, @dots{}) ## @deftypefnx {Function File} {} assert (@var{cond}, @var{msg_id}, @var{errmsg}, @dots{}) ## @deftypefnx {Function File} {} assert (@var{observed},@var{expected}) @@ -42,11 +42,14 @@ ## ## @item assert(@var{observed}, @var{expected}, @var{tol}) ## Accept a tolerance when comparing numbers. -## If @var{tol} is positive use it as an absolute tolerance, will produce an error if +## If @var{tol} is positive use it as an absolute tolerance, will produce an +## error if ## @code{abs(@var{observed} - @var{expected}) > abs(@var{tol})}. -## If @var{tol} is negative use it as a relative tolerance, will produce an error if +## If @var{tol} is negative use it as a relative tolerance, will produce an +## error if ## @code{abs(@var{observed} - @var{expected}) > abs(@var{tol} * @var{expected})}. -## If @var{expected} is zero @var{tol} will always be used as an absolute tolerance. +## If @var{expected} is zero @var{tol} will always be used as an absolute +## tolerance. ## @end table ## @seealso{test} ## @end deftypefn
--- a/scripts/testfun/example.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/testfun/example.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} example ('@var{name}',@var{n}) +## @deftypefn {Function File} {} example ('@var{name}',@var{n}) ## @deftypefnx {Function File} {[@var{x}, @var{idx}] =} example ('@var{name}',@var{n}) ## ## Display the code for example @var{n} associated with the function
--- a/scripts/testfun/fail.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/testfun/fail.m Sun Jul 18 20:35:16 2010 -0700 @@ -20,7 +20,7 @@ ## public domain. ## -*- texinfo -*- -## @deftypefn {Function File} {} fail (@var{code},@var{pattern}) +## @deftypefn {Function File} {} fail (@var{code},@var{pattern}) ## @deftypefnx {Function File} {} fail (@var{code},'warning',@var{pattern}) ## ## Return true if @var{code} fails with an error message matching
--- a/scripts/testfun/speed.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/testfun/speed.m Sun Jul 18 20:35:16 2010 -0700 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} speed (@var{f}, @var{init}, @var{max_n}, @var{f2}, @var{tol}) +## @deftypefn {Function File} {} speed (@var{f}, @var{init}, @var{max_n}, @var{f2}, @var{tol}) ## @deftypefnx {Function File} {[@var{order}, @var{n}, @var{T_f}, @var{T_f2}] =} speed (@dots{}) ## ## Determine the execution time of an expression for various @var{n}.
--- a/scripts/testfun/test.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/testfun/test.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} test @var{name} +## @deftypefn {Function File} {} test @var{name} ## @deftypefnx {Function File} {} test @var{name} quiet|normal|verbose ## @deftypefnx {Function File} {} test ('@var{name}', 'quiet|normal|verbose', @var{fid}) ## @deftypefnx {Function File} {} test ([], 'explain', @var{fid})
--- a/scripts/time/calendar.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/time/calendar.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} calendar (@dots{}) +## @deftypefn {Function File} {} calendar (@dots{}) ## @deftypefnx {Function File} {@var{c} =} calendar () ## @deftypefnx {Function File} {@var{c} =} calendar (@var{d}) ## @deftypefnx {Function File} {@var{c} =} calendar (@var{y}, @var{m})
--- a/scripts/time/date.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/time/date.m Sun Jul 18 20:35:16 2010 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} date () -## Return the date as a character string in the form DD-MMM-YY. For +## Return the date as a character string in the form DD-MMM-YY@. For ## example, ## ## @example
--- a/scripts/time/datenum.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/time/datenum.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} datenum (@var{year}, @var{month}, @var{day}) +## @deftypefn {Function File} {} datenum (@var{year}, @var{month}, @var{day}) ## @deftypefnx {Function File} {} datenum (@var{year}, @var{month}, @var{day}, @var{hour}) ## @deftypefnx {Function File} {} datenum (@var{year}, @var{month}, @var{day}, @var{hour}, @var{minute}) ## @deftypefnx {Function File} {} datenum (@var{year}, @var{month}, @var{day}, @var{hour}, @var{minute}, @var{second})
--- a/scripts/time/datetick.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/time/datetick.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} datetick () +## @deftypefn {Function File} {} datetick () ## @deftypefnx {Function File} {} datetick (@var{form}) ## @deftypefnx {Function File} {} datetick (@var{axis}, @var{form}) ## @deftypefnx {Function File} {} datetick (@dots{}, "keeplimits")
--- a/scripts/time/datevec.m Mon Jul 19 06:17:54 2010 +0300 +++ b/scripts/time/datevec.m Sun Jul 18 20:35:16 2010 -0700 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{v} =} datevec (@var{date}) +## @deftypefn {Function File} {@var{v} =} datevec (@var{date}) ## @deftypefnx {Function File} {@var{v} =} datevec (@var{date}, @var{f}) ## @deftypefnx {Function File} {@var{v} =} datevec (@var{date}, @var{p}) ## @deftypefnx {Function File} {@var{v} =} datevec (@var{date}, @var{f}, @var{p})