Mercurial > octave-nkf
changeset 5642:2618a0750ae6
[project @ 2006-03-06 21:26:48 by jwe]
line wrap: on
line diff
--- a/doc/ChangeLog Sat Mar 04 22:21:01 2006 +0000 +++ b/doc/ChangeLog Mon Mar 06 21:26:54 2006 +0000 @@ -1,3 +1,8 @@ +2006-03-06 Keith Goodman <kwgoodman@gmail.com> + + * interpreter/octave.texi (@seealso): Display args instead of + discarding them. + 2006-03-02 John W. Eaton <jwe@octave.org> * faq/Makefile.in (Octave-FAQ.ps): Depend on Octave-FAQ.dvi, not
--- a/doc/interpreter/octave.texi Sat Mar 04 22:21:01 2006 +0000 +++ b/doc/interpreter/octave.texi Mon Mar 06 21:26:54 2006 +0000 @@ -11,6 +11,9 @@ @c each group of functions and variables). @macro seealso {args} +@sp 1 +@noindent +See also: \args\. @end macro @ifinfo
--- a/scripts/ChangeLog Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/ChangeLog Mon Mar 06 21:26:54 2006 +0000 @@ -1,3 +1,70 @@ +2006-03-06 Keith Goodman <kwgoodman@gmail.com> + + * audio/lin2mu.m, audio/loadaudio.m, audio/mu2lin.m, + audio/playaudio.m, audio/record.m, audio/saveaudio.m, + audio/wavread.m, audio/wavwrite.m, control/base/DEMOcontrol.m, + control/base/__stepimp__.m, control/base/are.m, + control/base/controldemo.m, control/base/damp.m, + control/base/dare.m, control/base/impulse.m, control/base/lqg.m, + control/base/step.m, control/system/abcddim.m, + control/system/is_abcd.m, control/system/is_controllable.m, + control/system/is_detectable.m, control/system/is_observable.m, + control/system/is_stabilizable.m, control/system/is_stable.m, + control/system/jet707.m, control/system/sys2fir.m, + control/system/sysdimensions.m, control/system/sysupdate.m, + control/system/tfout.m, control/system/ugain.m, + control/system/zpout.m, elfun/lcm.m, finance/irr.m, + finance/nper.m, finance/npv.m, finance/pmt.m, finance/pv.m, + finance/rate.m, general/__isequal__.m, general/bitcmp.m, + general/bitget.m, general/bitset.m, general/blkdiag.m, + general/cart2pol.m, general/cart2sph.m, general/cell2mat.m, + general/circshift.m, general/columns.m, general/flipdim.m, + general/fliplr.m, general/flipud.m, general/ind2sub.m, + general/int2str.m, general/isdefinite.m, general/isequal.m, + general/isequalwithequalnans.m, general/isscalar.m, + general/issquare.m, general/issymmetric.m, general/isvector.m, + general/logspace.m, general/mod.m, general/nextpow2.m, + general/num2str.m, general/perror.m, general/pol2cart.m, + general/rem.m, general/rot90.m, general/rotdim.m, general/rows.m, + general/shiftdim.m, general/sph2cart.m, general/sub2ind.m, + general/tril.m, image/hsv2rgb.m, image/image.m, image/imagesc.m, + image/imshow.m, image/ind2gray.m, image/ind2rgb.m, + image/loadimage.m, image/rgb2hsv.m, image/rgb2ind.m, + image/saveimage.m, io/beep.m, linear-algebra/cond.m, + linear-algebra/norm.m, miscellaneous/comma.m, miscellaneous/dir.m, + miscellaneous/license.m, miscellaneous/menu.m, + miscellaneous/semicolon.m, miscellaneous/texas_lotto.m, + miscellaneous/unix.m, miscellaneous/ver.m, optimization/sqp.m, + plot/__errcomm__.m, plot/__errplot__.m, plot/__pltopt1__.m, + plot/__pltopt__.m, plot/bar.m, plot/contour.m, plot/errorbar.m, + plot/grid.m, plot/hist.m, plot/loglog.m, plot/loglogerr.m, + plot/mesh.m, plot/meshgrid.m, plot/plot.m, plot/polar.m, + plot/semilogx.m, plot/semilogxerr.m, plot/semilogy.m, + plot/semilogyerr.m, plot/shg.m, plot/stairs.m, plot/title.m, + plot/xlabel.m, polynomial/compan.m, polynomial/conv.m, + polynomial/deconv.m, polynomial/polyderiv.m, polynomial/polygcd.m, + polynomial/polyinteg.m, polynomial/polyout.m, + polynomial/polyreduce.m, polynomial/polyval.m, + polynomial/polyvalm.m, polynomial/residue.m, set/complement.m, + set/create_set.m, set/intersection.m, set/ismember.m, + set/setdiff.m, set/union.m, set/unique.m, sparse/etreeplot.m, + sparse/gplot.m, sparse/spalloc.m, sparse/sphcat.m, + sparse/sprand.m, sparse/sprandn.m, sparse/sprandsym.m, + sparse/spvcat.m, sparse/treeplot.m, specfun/erfinv.m, + specfun/log2.m, specfun/pow2.m, special-matrix/hankel.m, + special-matrix/hilb.m, special-matrix/invhilb.m, + special-matrix/sylvester_matrix.m, special-matrix/toeplitz.m, + special-matrix/vander.m, statistics/base/median.m, + statistics/base/std.m, statistics/distributions/gamcdf.m, + statistics/distributions/gaminv.m, + statistics/distributions/gampdf.m, + statistics/distributions/gamrnd.m, strings/base2dec.m, + strings/bin2dec.m, strings/dec2base.m, strings/dec2bin.m, + strings/dec2hex.m, strings/hex2dec.m, strings/isletter.m, + strings/lower.m, strings/upper.m, testfun/assert.m, + testfun/demo.m, testfun/example.m, testfun/test.m, time/etime.m: + Move @seealso inside @defXXX macro. Remove "and" from @seealso. + 2006-02-27 John W. Eaton <jwe@octave.org> * time/tic.m: Move here from miscellaneous/tic.m.
--- a/scripts/audio/lin2mu.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/lin2mu.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,9 @@ ## floating point values in the range -1<=@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} ## @end deftypefn -## -## @seealso{mu2lin, loadaudio, saveaudio, playaudio, setaudio, and record} + ## Author: Andreas Weingessel <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/audio/loadaudio.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/loadaudio.m Mon Mar 06 21:26:54 2006 +0000 @@ -29,9 +29,9 @@ ## ## The argument @var{bps} can be either 8 (default) or 16, and specifies ## the number of bits per sample used in the audio file. +## @seealso{lin2mu, mu2lin, saveaudio, playaudio, setaudio, record} ## @end deftypefn -## -## @seealso{lin2mu, mu2lin, saveaudio, playaudio, setaudio, and record} + ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 10 April 1994
--- a/scripts/audio/mu2lin.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/mu2lin.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,9 +23,8 @@ ## 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 ## @var{n} is not specified it defaults to 8. +## @seealso{lin2mu, loadaudio, saveaudio, playaudio, setaudio, record} ## @end deftypefn -## -## @seealso{lin2mu, loadaudio, saveaudio, playaudio, setaudio, and record} ## Author: Andreas Weingessel <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 18 October 1994
--- a/scripts/audio/playaudio.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/playaudio.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,9 +22,8 @@ ## @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}. +## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, setaudio, record} ## @end deftypefn -## -## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 11 April 1994
--- a/scripts/audio/record.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/record.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,9 +23,8 @@ ## default value for @var{sampling_rate} is 8000 samples per second, or ## 8kHz. The program waits until the user types @key{RET} and then ## immediately starts to record. +## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, playaudio, setaudio} ## @end deftypefn -## -## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, playaudio, and setaudio} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 19 September 1994
--- a/scripts/audio/saveaudio.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/saveaudio.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## @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 ## 8, respectively. +## @seealso{lin2mu, mu2lin, loadaudio, playaudio, setaudio, record} ## @end deftypefn -## -## @seealso{lin2mu, mu2lin, loadaudio, playaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 5 September 1994
--- a/scripts/audio/wavread.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/wavread.m Mon Mar 06 21:26:54 2006 +0000 @@ -36,10 +36,8 @@ ## @deftypefnx {Function File} {[@var{samples}, @var{channels}]} = wavread (@var{filename}, "size") ## Return the number of samples (@var{n}) and channels (@var{ch}) ## instead of the audio data. -## +## @seealso{wavwrite} ## @end deftypefn -## -## @seealso{wavwrite} ## Author: Michael Zeising <michael.zeising@stud.uni-erlangen.de> ## Created: 06 December 2005
--- a/scripts/audio/wavwrite.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/audio/wavwrite.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,10 +28,8 @@ ## ## @deftypefnx {Function File} {} wavwrite(@var{filename}, @var{y}, @var{fs}, @var{bits}) ## Set the sample rate to @var{fs} Hz and resolution to @var{bits} bits. -## +## @seealso{wavread} ## @end deftypefn -## -## @seealso{wavread} ## Author: Michael Zeising <michael.zeising@stud.uni-erlangen.de> ## Created: 06 December 2005
--- a/scripts/control/base/DEMOcontrol.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/DEMOcontrol.m Mon Mar 06 21:26:54 2006 +0000 @@ -38,10 +38,9 @@ ## @end example ## Command examples are interactively run for users to observe the use ## of @acronym{OCST} functions. -## @end deftypefn -## ## @seealso{Demo Programs: bddemo.m, frdemo.m, analdemo.m, ## moddmeo.m, rldemo.m} +## @end deftypefn ## Author: David Clem ## Created: August 15, 1994
--- a/scripts/control/base/__stepimp__.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/__stepimp__.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## Limited argument checking; ``do not attempt to do this at home''. ## Used internally in @command{impulse}, @command{step}. Use @command{step} ## or @command{impulse} instead. +## @seealso{step, impulse} ## @end deftypefn -## -## @seealso{step, impulse} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: October 2, 1997
--- a/scripts/control/base/are.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/are.m Mon Mar 06 21:26:54 2006 +0000 @@ -60,10 +60,8 @@ ## Laub's Schur method (@acronym{IEEE} Transactions on ## Automatic Control, 1979) is applied to the appropriate Hamiltonian ## matrix. -## +## @seealso{balance, dare} ## @end deftypefn -## -## @seealso{balance and dare} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/base/controldemo.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/controldemo.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} controldemo () ## Control Systems Toolbox demo. +## @seealso{Demo programs: bddemo, frdemo, analdemo, moddmeo, rldemo} ## @end deftypefn -## -## @seealso{Demo programs: bddemo, frdemo, analdemo, moddmeo, rldemo} ## Author: David Clem ## Created: August 15, 1994
--- a/scripts/control/base/damp.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/damp.m Mon Mar 06 21:26:54 2006 +0000 @@ -25,9 +25,8 @@ ## If @var{p} is a system, @var{tsam} must not be specified. ## If @var{p} is a matrix and @var{tsam} is specified, eigenvalues ## of @var{p} are assumed to be in @var{z}-domain. +## @seealso{eig} ## @end deftypefn -## -## @seealso{eig} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: September 29, 1997.
--- a/scripts/control/base/dare.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/dare.m Mon Mar 06 21:26:54 2006 +0000 @@ -69,10 +69,8 @@ ## See also: Ran and Rodman, @cite{Stable Hermitian Solutions of Discrete ## Algebraic Riccati Equations}, Mathematics of Control, Signals and ## Systems, Vol 5, no 2 (1992), pp 165--194. -## +## @seealso{balance, are} ## @end deftypefn -## -## @seealso{balance and are} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/base/impulse.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/impulse.m Mon Mar 06 21:26:54 2006 +0000 @@ -46,9 +46,8 @@ ## @item t ## Times of the impulse response. ## @end table +## @seealso{step, __stepimp__} ## @end deftypefn -## -## @seealso{step, __stepimp__} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: October 2, 1997
--- a/scripts/control/base/lqg.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/lqg.m Mon Mar 06 21:26:54 2006 +0000 @@ -61,9 +61,8 @@ ## @item es ## Controller poles. ## @end table +## @seealso{h2syn, lqe, lqr} ## @end deftypefn -## -## @seealso{h2syn, lqe, and lqr} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1995
--- a/scripts/control/base/step.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/base/step.m Mon Mar 06 21:26:54 2006 +0000 @@ -48,9 +48,8 @@ ## @end table ## ## When invoked with the output parameter @var{y} the plot is not displayed. +## @seealso{impulse, __stepimp__} ## @end deftypefn -## -## @seealso{impulse and __stepimp__} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: September 30, 1997
--- a/scripts/control/system/abcddim.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/abcddim.m Mon Mar 06 21:26:54 2006 +0000 @@ -58,10 +58,8 @@ ## Otherwise @code{abcddim} returns @var{n} = @var{m} = @var{p} = @minus{}1. ## ## Note: n = 0 (pure gain block) is returned without warning. -## +## @seealso{is_abcd} ## @end deftypefn -## -## @seealso{is_abcd} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993.
--- a/scripts/control/system/is_abcd.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/is_abcd.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,9 +23,8 @@ ## @var{c}, @var{d} are compatible, otherwise @var{retval} = 0 with an ## appropriate diagnostic message printed to the screen. The matrices ## @var{b}, @var{c}, or @var{d} may be omitted. +## @seealso{abcddim} ## @end deftypefn -## -## @seealso{abcddim} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: November 4, 1997
--- a/scripts/control/system/is_controllable.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/is_controllable.m Mon Mar 06 21:26:54 2006 +0000 @@ -53,10 +53,9 @@ ## The Arnoldi iteration is executed with @code{krylov} if the system ## has a single input; otherwise a block Arnoldi iteration is performed ## with @code{krylovb}. +## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector +## is_observable, is_stabilizable, is_detectable, krylov, krylovb} ## @end deftypefn -## -## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector -## is_observable, is_stabilizable, is_detectable, krylov, and krylovb} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/system/is_detectable.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/is_detectable.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,12 +28,9 @@ ## ## @strong{See} @command{is_stabilizable} for detailed description of ## arguments and computational method. -## -## +## @seealso{is_stabilizable, size, rows, columns, length, ismatrix, +## isscalar, isvector} ## @end deftypefn -## -## @seealso{is_stabilizable, size, rows, columns, length, ismatrix, -## isscalar, and isvector} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/system/is_observable.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/is_observable.m Mon Mar 06 21:26:54 2006 +0000 @@ -29,9 +29,8 @@ ## ## See @command{is_controllable} for detailed description of arguments ## and default values. +## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector} ## @end deftypefn -## -## @seealso{size, rows, columns, length, ismatrix, isscalar, and isvector} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/system/is_stabilizable.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/is_stabilizable.m Mon Mar 06 21:26:54 2006 +0000 @@ -35,10 +35,9 @@ ## @var{dflg}!=0 ## @end ifinfo ## assume that discrete-time matrices (a,b) are supplied. -## @end deftypefn -## ## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector ## is_observable, is_stabilizable, is_detectable} +## @end deftypefn ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/system/is_stable.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/is_stable.m Mon Mar 06 21:26:54 2006 +0000 @@ -37,10 +37,9 @@ ## stable if eig(a) is in the open LHP (default) ## @end table ## @end table +## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector +## is_observable, is_stabilizable, is_detectable, krylov, krylovb} ## @end deftypefn -## -## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector -## is_observable, is_stabilizable, is_detectable, krylov, and krylovb} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/system/jet707.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/jet707.m Mon Mar 06 21:26:54 2006 +0000 @@ -35,9 +35,8 @@ ## System outputs: (1) airspeed and (2) pitch angle. ## ## @strong{Reference}: R. Brockhaus: @cite{Flugregelung} (Flight Control), Springer, 1994. +## @seealso{ord2} ## @end deftypefn -## -## @seealso{ord2} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: September 28, 1997
--- a/scripts/control/system/sys2fir.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/sys2fir.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,9 +22,8 @@ ## ## Extract @acronym{FIR} data from system data structure; see @command{fir2sys} for ## parameter descriptions. +## @seealso{fir2sys} ## @end deftypefn -## -## @seealso{fir2sys} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: July 1996
--- a/scripts/control/system/sysdimensions.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/sysdimensions.m Mon Mar 06 21:26:54 2006 +0000 @@ -63,9 +63,8 @@ ## discrete. ## @math{yd(ii) = 0} if output @var{ii} is continous ## @end table +## @seealso{sysgetsignals, sysgettsam} ## @end deftypefn -## -## @seealso{sysgetsignals and sysgettsam} function [n, nz, m, p, yd] = sysdimensions (sys, opt)
--- a/scripts/control/system/sysupdate.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/sysupdate.m Mon Mar 06 21:26:54 2006 +0000 @@ -48,9 +48,8 @@ ## ## Conversion to @command{tf} or @command{zp} exits with an error if the system is ## mixed continuous/digital. +## @seealso{tf, ss, zp, sysout, sys2ss, sys2tf, sys2zp} ## @end deftypefn -## -## @seealso{tf, ss, zp, sysout, sys2ss, sys2tf, and sys2zp} ## Author: John Ingram <ingraje@eng.auburn.edu> ## Created: July 9, 1996
--- a/scripts/control/system/tfout.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/tfout.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,10 +21,9 @@ ## @deftypefn {Function File} {} tfout (@var{num}, @var{denom}, @var{x}) ## Print formatted transfer function @math{n(s)/d(s)} to the screen. ## @var{x} defaults to the string @code{"s"} +## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, +## filter, polyderiv, polyinteg, polyout} ## @end deftypefn -## -## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg, and polyout} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: June 1995
--- a/scripts/control/system/ugain.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/ugain.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## complex systems from simple systems with @command{buildssic}. ## Watch out if you are forming sampled systems since @command{ugain} ## does not contain a sampling period. +## @seealso{hinfdemo, jet707} ## @end deftypefn -## -## @seealso{hinfdemo and jet707} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: April 1998
--- a/scripts/control/system/zpout.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/control/system/zpout.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,10 +21,9 @@ ## @deftypefn {Function File} {} zpout (@var{zer}, @var{pol}, @var{k}, @var{x}) ## print formatted zero-pole form to the screen. ## @var{x} defaults to the string @code{"s"} +## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, +## filter, polyderiv, polyinteg, polyout} ## @end deftypefn -## -## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg, and polyout} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: June 1995
--- a/scripts/elfun/lcm.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/elfun/lcm.m Mon Mar 06 21:26:54 2006 +0000 @@ -34,9 +34,8 @@ ## @end example ## ## All elements must be the same size or scalar. +## @seealso{gcd, min, max, ceil, floor} ## @end deftypefn -## -## @seealso{gcd, min, max, ceil, and floor} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Created: 16 September 1994
--- a/scripts/finance/irr.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/finance/irr.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,9 +23,8 @@ ## from an initial investment @var{i} (i.e., the solution of ## @code{npv (r, p) = i}. If the second argument is omitted, a value of ## 0 is used. +## @seealso{npv, pv, rate} ## @end deftypefn -## -## @seealso{npv, pv, and rate} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Internal rate of return of an investment
--- a/scripts/finance/nper.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/finance/nper.m Mon Mar 06 21:26:54 2006 +0000 @@ -31,9 +31,8 @@ ## ## Note that the rate @var{r} is specified as a fraction (i.e., 0.05, ## not 5 percent). +## @seealso{pv, pmt, rate, npv} ## @end deftypefn -## -## @seealso{pv, pmt, rate, and npv} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Number of payments needed for amortizing a loan
--- a/scripts/finance/npv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/finance/npv.m Mon Mar 06 21:26:54 2006 +0000 @@ -30,9 +30,8 @@ ## ## Note that the rate @var{r} is specified as a fraction (i.e., 0.05, ## not 5 percent). +## @seealso{irr, pv} ## @end deftypefn -## -## @seealso{irr and pv} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Net present value of a series of payments
--- a/scripts/finance/pmt.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/finance/pmt.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## The optional argument @var{method} may be used to specify whether ## payments are made at the end (@var{"e"}, default) or at the beginning ## (@var{"b"}) of each period. +## @seealso{pv, nper, rate} ## @end deftypefn -## -## @seealso{pv, nper, and rate} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Amount of periodic payment needed to amortize a loan
--- a/scripts/finance/pv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/finance/pv.m Mon Mar 06 21:26:54 2006 +0000 @@ -31,9 +31,8 @@ ## ## Note that the rate @var{r} is specified as a fraction (i.e., 0.05, ## not 5 percent). +## @seealso{pmt, nper, rate, npv} ## @end deftypefn -## -## @seealso{pmt, nper, rate, and npv} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Present value of an investment
--- a/scripts/finance/rate.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/finance/rate.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## The optional string argument @var{method} may be used to specify ## whether payments are made at the end (@code{"e"}, default) or at the ## beginning (@code{"b"}) of each period. +## @seealso{pv, pmt, nper, npv} ## @end deftypefn -## -## @seealso{pv, pmt, nper, and npv} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Rate of return of an investment
--- a/scripts/general/__isequal__.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/__isequal__.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## @var{nans_compare_equal} evaluates to false. ## ## If @var{nans_compare_equal} evaluates to true, then assume NaN == NaN. +## @seealso{isequal, isequalwithequalnans} ## @end deftypefn -## -## @seealso{isequal, isequalwithequalnans} ## Modified by: William Poetra Yoga Hadisoeseno
--- a/scripts/general/bitcmp.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/bitcmp.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## dec2bin(bitcmp(11)) ## @result{} 11111111111111111111111111110100 ## @end example +## @seealso{bitand, bitor, bitxor, bitset, bitget, bitcmp, bitshift, bitmax} ## @end deftypefn -## -## @seealso{bitand,bitor,bitxor,bitset,bitget,bitcmp,bitshift,bitmax} ## Liberally based of the version by Kai Habel from octave-forge
--- a/scripts/general/bitget.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/bitget.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## bitget (100, 8:-1:1) ## @result{} 0 1 1 0 0 1 0 0 ## @end example +## @seealso{bitand, bitor, bitxor, bitset, bitcmp, bitshift, bitmax} ## @end deftypefn -## -## @seealso{bitand, bitor, bitxor, bitset, bitcmp, bitshift, bitmax} ## Liberally based of the version by Kai Habel from octave-forge
--- a/scripts/general/bitset.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/bitset.m Mon Mar 06 21:26:54 2006 +0000 @@ -26,9 +26,8 @@ ## dec2bin (bitset (10, 1)) ## @result{} 1011 ## @end example +## @seealso{bitand, bitor, bitxor, bitget, bitcmp, bitshift, bitmax} ## @end deftypefn -## -## @seealso{bitand, bitor, bitxor, bitget, bitcmp, bitshift, bitmax} ## Liberally based of the version by Kai Habel from octave-forge
--- a/scripts/general/blkdiag.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/blkdiag.m Mon Mar 06 21:26:54 2006 +0000 @@ -19,9 +19,8 @@ ## Build a block diagonal matrix from @var{a}, @var{b}, @var{c}, ... . ## All the arguments must be numeric and are two-dimensional matrices or ## scalars. +## @seealso{diag, horzcat, vertcat} ## @end deftypefn -## -## @seealso{diag, horzcat, vertcat} ## Author: Daniel Calvelo ## Modified by: William Poetra Yoga Hadisoeseno
--- a/scripts/general/cart2pol.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/cart2pol.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## @var{x}, @var{y} (and @var{z}) must be of same shape. ## @var{theta} describes the angle relative to the x - axis. ## @var{r} is the distance to the z - axis (0, 0, z). +## @seealso{pol2cart, cart2sph, sph2cart} ## @end deftypefn -## -## @seealso{pol2cart, cart2sph, sph2cart} ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe
--- a/scripts/general/cart2sph.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/cart2sph.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## @var{theta} describes the angle relative to the x - axis. ## @var{phi} is the angle relative to the xy - plane. ## @var{r} is the distance to the origin (0, 0, 0). +## @seealso{pol2cart, cart2pol, sph2cart} ## @end deftypefn -## -## @seealso{pol2cart, cart2pol, sph2cart} ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe
--- a/scripts/general/cell2mat.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/cell2mat.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## elements of @var{c} into a hyperrectangle. Elements of @var{c} must ## be numeric, logical or char, and @code{cat} must be able to ## concatenate them together. +## @seealso{mat2cell, num2cell} ## @end deftypefn -## -## @seealso{mat2cell, num2cell} function m = cell2mat (c)
--- a/scripts/general/circshift.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/circshift.m Mon Mar 06 21:26:54 2006 +0000 @@ -43,9 +43,8 @@ ## 9, 7, 8 ## @end group ## @end example +## @seealso {permute, ipermute, shiftdim} ## @end deftypefn -## -## @seealso {permute, ipermute, shiftdim} function y = circshift (x, n)
--- a/scripts/general/columns.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/columns.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} columns (@var{a}) ## Return the number of columns of @var{a}. +## @seealso{size, rows, length, isscalar, isvector, ismatrix} ## @end deftypefn -## -## @seealso{size, rows, length, isscalar, isvector, and ismatrix} ## Author: jwe
--- a/scripts/general/flipdim.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/flipdim.m Mon Mar 06 21:26:54 2006 +0000 @@ -29,9 +29,8 @@ ## 4 3 ## @end group ## @end example +## @seealso{fliplr, flipud, rot90, rotdim} ## @end deftypefn -## -## @seealso{fliplr, flipud, rot90 and rotdim} ## Author: David Bateman
--- a/scripts/general/fliplr.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/fliplr.m Mon Mar 06 21:26:54 2006 +0000 @@ -32,9 +32,8 @@ ## ## Note that @code{fliplr} only work with 2-D arrays. To flip N-d arrays ## use @code{flipdim} instead. +## @seealso{flipud, flipdim, rot90, rotdim} ## @end deftypefn -## -## @seealso{flipud, flipdim, rot90 and rotdim} ## Author: jwe
--- a/scripts/general/flipud.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/flipud.m Mon Mar 06 21:26:54 2006 +0000 @@ -33,9 +33,8 @@ ## Due to the difficulty of defining which axis about which to flip the ## matrix @code{flipud} only work with 2-d arrays. To flip N-d arrays ## use @code{flipdim} instead. +## @seealso{fliplr, flipdim, rot90, rotdim} ## @end deftypefn -## -## @seealso{fliplr, flipdim, rot90 and rotdim} ## Author: jwe
--- a/scripts/general/ind2sub.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/ind2sub.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{s1}, @var{s2}, @dots{}, @var{sN}] =} ind2sub (@var{dims}, @var{ind}) ## Convert a linear index into subscripts. +## @seealso{sub2ind} ## @end deftypefn -## -## @seealso{sub2ind} ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> ## Adapted-by: jwe
--- a/scripts/general/int2str.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/int2str.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## Convert a number to a string. These functions are not very flexible, ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). +## @seealso{sprintf, num2str} ## @end deftypefn -## -## @seealso{sprintf and num2str} ## Author: jwe @@ -93,4 +92,4 @@ endif endif -endfunction \ No newline at end of file +endfunction
--- a/scripts/general/isdefinite.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/isdefinite.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,10 +22,9 @@ ## Return 1 if @var{x} is symmetric positive definite within the ## tolerance specified by @var{tol} or 0 if @var{x} is symmetric ## positive semidefinite. Otherwise, return -1. If @var{tol} -## is omitted, use a tolerance equal to 100 times the machine precision. +## is omitted, use a tolerance equal to 100 times the machine precision. +## @seealso{issymmetric} ## @end deftypefn -## -## @seealso{issymmetric} ## Author: Gabriele Pannocchia <g.pannocchia@ing.unipi.it> ## Created: November 2003
--- a/scripts/general/isequal.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/isequal.m Mon Mar 06 21:26:54 2006 +0000 @@ -19,9 +19,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} isequal (@var{x1}, @var{x2}, @dots{}) ## Return true if all of @var{x1}, @var{x2}, @dots{} are equal. +## @seealso{isequalwithequalnans} ## @end deftypefn -## -## @seealso{isequalwithequalnans} function retval = isequal (x, varargin)
--- a/scripts/general/isequalwithequalnans.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/isequalwithequalnans.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## @deftypefn {Function File} {} isequalwithequalnans (@var{x1}, @var{x2}, @dots{}) ## Assuming NaN == NaN, return true if all of @var{x1}, @var{x2}, @dots{} ## are equal. +## @seealso{isequal} ## @end deftypefn -## -## @seealso{isequal} function retval = isequalwithequalnans (x, varargin)
--- a/scripts/general/isscalar.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/isscalar.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} isscalar (@var{a}) ## Return 1 if @var{a} is a scalar. Otherwise, return 0. +## @seealso{size, rows, columns, length, isscalar, ismatrix} ## @end deftypefn -## -## @seealso{size, rows, columns, length, isscalar, and ismatrix} ## Author: jwe
--- a/scripts/general/issquare.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/issquare.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,9 +21,8 @@ ## @deftypefn {Function File} {} issquare (@var{x}) ## If @var{x} is a square matrix, then return the dimension of @var{x}. ## Otherwise, return 0. +## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector} ## @end deftypefn -## -## @seealso{size, rows, columns, length, ismatrix, isscalar, and isvector} ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993
--- a/scripts/general/issymmetric.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/issymmetric.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,10 +22,9 @@ ## If @var{x} is symmetric within the tolerance specified by @var{tol}, ## then return the dimension of @var{x}. Otherwise, return 0. If ## @var{tol} is omitted, use a tolerance equal to the machine precision. +## @seealso{size, rows, columns, length, ismatrix, isscalar, +## issquare, isvector} ## @end deftypefn -## -## @seealso{size, rows, columns, length, ismatrix, isscalar, -## issquare, and isvector} ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993
--- a/scripts/general/isvector.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/isvector.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} isvector (@var{a}) ## Return 1 if @var{a} is a vector. Otherwise, return 0. +## @seealso{size, rows, columns, length, isscalar, ismatrix} ## @end deftypefn -## -## @seealso{size, rows, columns, length, isscalar, and ismatrix} ## Author: jwe
--- a/scripts/general/logspace.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/logspace.m Mon Mar 06 21:26:54 2006 +0000 @@ -58,9 +58,8 @@ ## 10^base and 10^pi, ## @end ifinfo ## in order to be compatible with the corresponding @sc{Matlab} function. +## @seealso{linspace} ## @end deftypefn -## -## @seealso{linspace} ## Author: jwe
--- a/scripts/general/mod.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/mod.m Mon Mar 06 21:26:54 2006 +0000 @@ -31,9 +31,8 @@ ## ## An error message is printed if the dimensions of the arguments do not ## agree, or if either of the arguments is complex. +## @seealso{rem, round} ## @end deftypefn -## -## @seealso{rem, round} ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> ## Modified by: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/general/nextpow2.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/nextpow2.m Mon Mar 06 21:26:54 2006 +0000 @@ -30,9 +30,8 @@ ## @end ifinfo ## ## If @var{x} is a vector, return @code{nextpow2 (length (@var{x}))}. +## @seealso{pow2} ## @end deftypefn -## -## @seealso{pow2} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Created: 7 October 1994
--- a/scripts/general/num2str.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/num2str.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## Convert a number to a string. These functions are not very flexible, ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). +## @seealso{sprintf, int2str} ## @end deftypefn -## -## @seealso{sprintf and int2str} ## Author: jwe
--- a/scripts/general/perror.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/perror.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,9 +23,8 @@ ## error number @var{num}. This function is intended to be used to print ## useful error messages for those functions that return numeric error ## codes. +## @seealso{strerror} ## @end deftypefn -## -## @seealso{strerror} ## Author: jwe
--- a/scripts/general/pol2cart.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/pol2cart.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## @var{theta}, @var{r} (and @var{z}) must be of same shape. ## @var{theta} describes the angle relative to the x - axis. ## @var{r} is the distance to the z - axis (0, 0, z). +## @seealso{cart2pol, cart2sph, sph2cart} ## @end deftypefn -## -## @seealso{cart2pol, cart2sph, sph2cart} ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe
--- a/scripts/general/rem.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/rem.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## ## An error message is printed if the dimensions of the arguments do not ## agree, or if either of the arguments is complex. +## @seealso{mod, round} ## @end deftypefn -## -## @seealso{mod, round} ## Author: jwe
--- a/scripts/general/rot90.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/rot90.m Mon Mar 06 21:26:54 2006 +0000 @@ -48,9 +48,8 @@ ## Due to the difficulty of defining an axis about which to rotate the ## matrix @code{rot90} only work with 2-D arrays. To rotate N-d arrays ## use @code{rotdim} instead. +## @seealso{rotdim, flipud, fliplr, flipdim} ## @end deftypefn -## -## @seealso{rotdim, flipud, fliplr and flipdim} ## Author: jwe
--- a/scripts/general/rotdim.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/rotdim.m Mon Mar 06 21:26:54 2006 +0000 @@ -49,9 +49,8 @@ ## rotdim ([1, 2; 3, 4], 7, [1, 2]) ## @end group ## @end example +## @seealso{rot90, flipud, fliplr, flipdim} ## @end deftypefn -## -## @seealso{rot90, flipud, fliplr and flipdim} function y = rotdim (x, k, plane)
--- a/scripts/general/rows.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/rows.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} rows (@var{a}) ## Return the number of rows of @var{a}. +## @seealso{size, columns, length, isscalar, isvector, ismatrix} ## @end deftypefn -## -## @seealso{size, columns, length, isscalar, isvector, and ismatrix} ## Author: jwe
--- a/scripts/general/shiftdim.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/shiftdim.m Mon Mar 06 21:26:54 2006 +0000 @@ -45,9 +45,8 @@ ## @result{} ns = 1 ## @end group ## @end example +## @seealso {reshape, permute, ipermute, circshift, squeeze} ## @end deftypefn -## -## @seealso {reshape, permute, ipermute, circshift, squeeze} function [y, ns] = shiftdim (x, n)
--- a/scripts/general/sph2cart.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/sph2cart.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,9 +24,8 @@ ## @var{theta} describes the angle relative to the x-axis. ## @var{phi} is the angle relative to the xy-plane. ## @var{r} is the distance to the origin (0, 0, 0). +## @seealso{pol2cart, cart2pol, cart2sph} ## @end deftypefn -## -## @seealso{pol2cart, cart2pol, cart2sph} ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe
--- a/scripts/general/sub2ind.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/sub2ind.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,9 +21,8 @@ ## @deftypefn {Function File} {@var{ind} =} sub2ind (@var{dims}, @var{i}, @var{j}) ## @deftypefnx {Function File} {@var{ind} =} sub2ind (@var{dims}, @var{s1}, @var{s2}, @dots{}, @var{sN}) ## Convert subscripts into a linear index. +## @seealso{ind2sub} ## @end deftypefn -## -## @seealso{ind2sub} ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> ## Adapted-by: jwe
--- a/scripts/general/tril.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/general/tril.m Mon Mar 06 21:26:54 2006 +0000 @@ -59,9 +59,8 @@ ## 1 1 1 ## @end group ## @end example +## @seealso{triu, diag} ## @end deftypefn -## -## @seealso{triu and diag} ## Author: jwe
--- a/scripts/image/hsv2rgb.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/hsv2rgb.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} @var{rgb_map} = hsv2rgb (@var{hsv_map}) ## Transform a colormap from the hsv space to the rgb space. +## @seealso{rgb2hsv} ## @end deftypefn -## -## @seealso{rgb2hsv} ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe
--- a/scripts/image/image.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/image.m Mon Mar 06 21:26:54 2006 +0000 @@ -30,9 +30,8 @@ ## ## The axis values corresponding to the matrix elements are specified in ## @var{x} and @var{y}. At present they are ignored. +## @seealso{imshow, imagesc, colormap} ## @end deftypefn -## -## @seealso{imshow, imagesc, and colormap} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/image/imagesc.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/imagesc.m Mon Mar 06 21:26:54 2006 +0000 @@ -34,9 +34,8 @@ ## @var{x} and @var{y}, either as pairs giving the minimum and maximum ## values for the respective axes, or as values for each row and column ## of the matrix @var{A}. At present they are ignored. +## @seealso{image, imshow} ## @end deftypefn -## -## @seealso{image and imshow} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/image/imshow.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/imshow.m Mon Mar 06 21:26:54 2006 +0000 @@ -41,8 +41,8 @@ ## ## The character string @code{"truesize"} can always be used as an ## optional final argument to prevent automatic zooming of the image. +## @seealso{image, imagesc, colormap, gray2ind, rgb2ind} ## @end deftypefn -## @seealso{image, imagesc, colormap, gray2ind, and rgb2ind} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/image/ind2gray.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/ind2gray.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,9 +22,8 @@ ## Convert an Octave indexed image to a gray scale intensity image. ## If @var{map} is omitted, the current colormap is used to determine the ## intensities. +## @seealso{gray2ind, rgb2ntsc, image, colormap} ## @end deftypefn -## -## @seealso{gray2ind, rgb2ntsc, image, and colormap} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/image/ind2rgb.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/ind2rgb.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,9 +21,8 @@ ## @deftypefn {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 @var{map} is omitted, the current colormap is used for the conversion. +## @seealso{rgb2ind, image, imshow, ind2gray, gray2ind} ## @end deftypefn -## -## @seealso{rgb2ind, image, imshow, ind2gray, and gray2ind} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/image/loadimage.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/loadimage.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,9 +21,8 @@ ## @deftypefn {Function File} {[@var{x}, @var{map}] =} loadimage (@var{file}) ## Load an image file and it's associated color map from the specified ## @var{file}. The image must be stored in Octave's image format. +## @seealso{saveimage, load, save} ## @end deftypefn -## -## @seealso{saveimage, load, and save} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/image/rgb2hsv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/rgb2hsv.m Mon Mar 06 21:26:54 2006 +0000 @@ -26,10 +26,9 @@ ## In the HSV space each color is represented by their hue, saturation ## and value (brightness). Value gives the amount of light in the color. ## Hue describes the dominant wavelegth. -## Saturation is the amount of Hue mixed into the color. +## Saturation is the amount of Hue mixed into the color. +## @seealso{hsv2rgb} ## @end deftypefn -## -## @seealso{hsv2rgb} ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe
--- a/scripts/image/rgb2ind.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/rgb2ind.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{x}, @var{map}] =} rgb2ind (@var{r}, @var{g}, @var{b}) ## Convert and RGB image to an Octave indexed image. +## @seealso{ind2rgb, rgb2ntsc} ## @end deftypefn -## -## @seealso{ind2rgb and rgb2ntsc} ## Bugs: The color map may have duplicate entries.
--- a/scripts/image/saveimage.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/image/saveimage.m Mon Mar 06 21:26:54 2006 +0000 @@ -42,9 +42,8 @@ ## image is a gray scale image (the entries within each row of the colormap ## are equal) the gray scale ppm and PostScript image formats are used, ## otherwise the full color formats are used. +## @seealso{loadimage, save, load, colormap} ## @end deftypefn -## -## @seealso{loadimage, save, load, and colormap} ## The conversion to PostScript is based on pbmtolps.c, which was ## written by
--- a/scripts/io/beep.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/io/beep.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} puts (@var{string}) ## Produce a beep from the speaker (or visual bell). +## @seealso{puts, fputs, printf, fprintf} ## @end deftypefn -## -## @seealso{puts, fputs, printf and fprintf} ## Author: jwe
--- a/scripts/linear-algebra/cond.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/linear-algebra/cond.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,9 +22,8 @@ ## Compute the (two-norm) condition number of a matrix. @code{cond (a)} is ## defined as @code{norm (a) * norm (inv (a))}, and is computed via a ## singular value decomposition. +## @seealso{norm, svd, rank} ## @end deftypefn -## -## @seealso{norm, svd, and rank} ## Author: jwe
--- a/scripts/linear-algebra/norm.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/linear-algebra/norm.m Mon Mar 06 21:26:54 2006 +0000 @@ -52,9 +52,8 @@ ## @item other ## p-norm of @var{a}, @code{(sum (abs (@var{a}) .^ @var{p})) ^ (1/@var{p})}. ## @end table +## @seealso{cond, svd} ## @end deftypefn -## -## @seealso{cond and svd} ## Author: jwe
--- a/scripts/miscellaneous/comma.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/comma.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,6 +20,5 @@ ## -*- texinfo -*- ## @deffn {Operator} , ## Array index, function argument, or command separator. +## @seealso{semicolon} ## @end deffn -## -## @seealso{semicolon}
--- a/scripts/miscellaneous/dir.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/dir.m Mon Mar 06 21:26:54 2006 +0000 @@ -39,10 +39,8 @@ ## If @var{directory} is not a directory, return information about the ## named file. ## @var{filename}. -## ## @seealso{ls, stat, readdir, glob, filesep} ## @end deftypefn -## ## Author: jwe
--- a/scripts/miscellaneous/license.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/license.m Mon Mar 06 21:26:54 2006 +0000 @@ -49,8 +49,8 @@ ## on failure. ## ## This function is provided for compatibility with @sc{Matlab}. +## @seealso{ver, version} ## @end deftypefn -## @seealso{ver, version} ## Author: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
--- a/scripts/miscellaneous/menu.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/menu.m Mon Mar 06 21:26:54 2006 +0000 @@ -25,9 +25,8 @@ ## programs. There is no limit to the number of options that may be passed ## in, but it may be confusing to present more than will fit easily on one ## screen. +## @seealso{disp, printf, input} ## @end deftypefn -## -## @seealso{disp, printf, and input} ## Author: jwe
--- a/scripts/miscellaneous/semicolon.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/semicolon.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,6 +20,5 @@ ## -*- texinfo -*- ## @deffn {Operator} ; ## Array row or command separator. +## @seealso{comma} ## @end deffn -## -## @seealso{comma}
--- a/scripts/miscellaneous/texas_lotto.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/texas_lotto.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,9 +21,8 @@ ## @deftypefn {Function File} {} texas_lotto () ## Pick 6 unique numbers between 1 and 50 that are guaranteed to win ## the Texas Lotto. +## @seealso{rand} ## @end deftypefn -## -## @seealso{rand} ## Author: jwe
--- a/scripts/miscellaneous/unix.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/unix.m Mon Mar 06 21:26:54 2006 +0000 @@ -25,9 +25,8 @@ ## in @var{status} and any output sent to the standard output in ## @var{text}. If the optional second argument @code{"-echo"} is given, ## then also send the output from the command to the standard output. +## @seealso{isunix, ispc, system} ## @end deftypefn -## -## @seealso{isunix, ispc, system} ## Author: octave-forge ??? ## Adapted by: jwe
--- a/scripts/miscellaneous/ver.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/miscellaneous/ver.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,8 +22,8 @@ ## @code{ver} displays a header containing the current Octave version ## number, license string and operating system, followed by the version ## number for octave-forge, if installed. +## @seealso{license, version} ## @end deftypefn -## @seealso{license, version} ## Author: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
--- a/scripts/optimization/sqp.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/optimization/sqp.m Mon Mar 06 21:26:54 2006 +0000 @@ -162,8 +162,8 @@ ## allowed iterations is currently fixed at 100---edit @file{sqp.m} to ## increase this value). ## @end table +## @seealso{qp} ## @end deftypefn -## @seealso{qp} function [x, obj, info, iter, nf, lambda] = sqp (x, objf, cef, cif)
--- a/scripts/plot/__errcomm__.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/__errcomm__.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,10 +21,8 @@ ## @deftypefn {Function File} {} __errcomm__ (@var{args}) ## Common argument handling code for all error plots (errorbar, loglogerr, ## semilogyerr, semilogxerr). -## +## @seealso{errorbar, semilogxerr, semilogyerr, loglogerr, __pltopt__} ## @end deftypefn -## -## @seealso{errorbar, semilogxerr, semilogyerr, loglogerr, __pltopt__} ## Created: 20.02.2001 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/plot/__errplot__.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/__errplot__.m Mon Mar 06 21:26:54 2006 +0000 @@ -25,11 +25,9 @@ ## __errplot__ (@var{arg1}, @var{arg2}, ..., @var{fmt}) ## @end example ## +## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__, +## bar, stairs, errorbar, replot, xlabel, ylabel, and title} ## @end deftypefn -## -## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ -## bar, stairs, errorbar, replot, xlabel, ylabel, and title} - ## Created: 18.7.2000 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi> ## Keywords: errorbar, plotting
--- a/scripts/plot/__pltopt1__.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/__pltopt1__.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} __pltopt1__ (@var{caller}, @var{opt}) ## Really decode plot option strings. +## @seealso{__pltopt__} ## @end deftypefn -## -## @seealso{__pltopt__} ## Author: Rick Niles <niles@axp745.gsfc.nasa.gov> ## Adapted-By: jwe
--- a/scripts/plot/__pltopt__.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/__pltopt__.m Mon Mar 06 21:26:54 2006 +0000 @@ -103,9 +103,8 @@ ## 5 cyan cyan dot long dash triangle filled square ## 6 brown yellow dot short dash "*" "o" ## @end example +## @seealso{__pltopt1__} ## @end deftypefn -## -## @seealso{__pltopt1__} ## Author: jwe
--- a/scripts/plot/bar.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/bar.m Mon Mar 06 21:26:54 2006 +0000 @@ -41,10 +41,9 @@ ## ## @noindent ## are equivalent. +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## stairs, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## stairs, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/contour.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/contour.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,9 +23,8 @@ ## Make a contour plot of the three-dimensional surface described by ## @var{z}. Someone needs to improve @code{gnuplot}'s contour routines ## before this will be very useful. +## @seealso{plot, mesh, meshgrid} ## @end deftypefn -## -## @seealso{plot, mesh, meshgrid} ## Author: jwe
--- a/scripts/plot/errorbar.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/errorbar.m Mon Mar 06 21:26:54 2006 +0000 @@ -101,11 +101,9 @@ ## xyerrorbar plot of @var{y} versus @var{x} where @var{x} errorbars ## are drawn from @var{x}-@var{lx} to @var{x}+@var{ux} and @var{y} errorbars ## from @var{y}-@var{ly} to @var{y}+@var{uy}. -## +## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__, +## bar, stairs, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__, -## bar, stairs, replot, xlabel, ylabel, and title} ## Created: 18.7.2000 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/plot/grid.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/grid.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,10 +22,9 @@ ## For two-dimensional plotting, force the display of a grid on the plot. ## The argument may be either @code{"on"} or @code{"off"}. If it is ## omitted, @code{"on"} is assumed. +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/hist.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/hist.m Mon Mar 06 21:26:54 2006 +0000 @@ -38,9 +38,8 @@ ## ## With two output arguments, produce the values @var{nn} and @var{xx} such ## that @code{bar (@var{xx}, @var{nn})} will plot the histogram. +## @seealso{bar} ## @end deftypefn -## -## @seealso{bar} ## Author: jwe
--- a/scripts/plot/loglog.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/loglog.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,10 +22,9 @@ ## Make a two-dimensional plot using log scales for both axes. See the ## description of @code{plot} for a description of the arguments that ## @code{loglog} will accept. +## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, +## replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -## replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/loglogerr.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/loglogerr.m Mon Mar 06 21:26:54 2006 +0000 @@ -32,11 +32,9 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. See errorbar for available formats and ## additional information. -## +## @seealso{errorbar, semilogxerr, semilogyerr, polar, mesh, contour, +## __pltopt__, bar, stairs, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{errorbar, semilogxerr, semilogyerr, polar, mesh, contour, -## __pltopt__, bar, stairs, replot, xlabel, ylabel, and title} ## Created: 20.2.2001 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/plot/mesh.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/mesh.m Mon Mar 06 21:26:54 2006 +0000 @@ -25,9 +25,8 @@ ## is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, columns of @var{z} ## correspond to different @var{x} values and rows of @var{z} correspond ## to different @var{y} values. +## @seealso{meshgrid, contour} ## @end deftypefn -## -## @seealso{meshgrid, contour} ## Author: jwe
--- a/scripts/plot/meshgrid.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/meshgrid.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## of a mesh. The rows of @var{xx} are copies of @var{x}, and the ## columns of @var{yy} are copies of @var{y}. If @var{y} is omitted, ## then it is assumed to be the same as @var{x}. +## @seealso{mesh, contour} ## @end deftypefn -## -## @seealso{mesh, contour} ## Author: jwe
--- a/scripts/plot/plot.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/plot.m Mon Mar 06 21:26:54 2006 +0000 @@ -162,10 +162,9 @@ ## ## This will plot the cosine and sine functions and label them accordingly ## in the key. +## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ +## bar, stairs, errorbar, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ -## bar, stairs, errorbar, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/polar.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/polar.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,10 +23,9 @@ ## @var{rho}. ## ## The optional third argument specifies the line type. +## @seealso{plot, semilogx, semilogy, loglog, mesh, contour, bar, +## stairs, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogx, semilogy, loglog, mesh, contour, bar, -## stairs, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/semilogx.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/semilogx.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,10 +22,9 @@ ## Make a two-dimensional plot using a log scale for the @var{x} axis. See ## the description of @code{plot} for a description of the arguments ## that @code{semilogx} will accept. +## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, +## replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -## replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/semilogxerr.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/semilogxerr.m Mon Mar 06 21:26:54 2006 +0000 @@ -32,11 +32,9 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. See errorbar for available formats and ## additional information. -## +## @seealso{errorbar, loglogerr semilogyerr, polar, mesh, contour, __pltopt__, +## bar, stairs, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{errorbar, loglogerr semilogyerr, polar, mesh, contour, __pltopt__, -## bar, stairs, replot, xlabel, ylabel, and title} ## Created: 20.2.2001 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/plot/semilogy.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/semilogy.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,10 +22,9 @@ ## Make a two-dimensional plot using a log scale for the @var{y} axis. See ## the description of @code{plot} for a description of the arguments ## that @code{semilogy} will accept. +## @seealso{plot, semilogx, loglog, polar, mesh, contour, bar, stairs, +## replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogx, loglog, polar, mesh, contour, bar, stairs, -## replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/semilogyerr.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/semilogyerr.m Mon Mar 06 21:26:54 2006 +0000 @@ -32,11 +32,9 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. See errorbar for available formats and ## additional information. -## +## @seealso{errorbar, loglogerr semilogxerr, polar, mesh, contour, __pltopt__, +## bar, stairs, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{errorbar, loglogerr semilogxerr, polar, mesh, contour, __pltopt__, -## bar, stairs, replot, xlabel, ylabel, and title} ## Created: 20.2.2001 ## Author: Teemu Ikonen <tpikonen@pcu.helsinki.fi>
--- a/scripts/plot/shg.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/shg.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,11 +22,9 @@ ## ## Show the graph window. Currently, this is the same as executing ## replot. -## +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, replot, xlabel, ylabel} ## @end deftypefn -## -## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, replot, xlabel, and ylabel} ## Author: jwe
--- a/scripts/plot/stairs.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/stairs.m Mon Mar 06 21:26:54 2006 +0000 @@ -41,10 +41,9 @@ ## ## @noindent ## are equivalent. +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, replot, xlabel, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/title.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/title.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,10 +20,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} title (@var{string}) ## Specify a title for a plot. +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, replot, xlabel, ylabel} ## @end deftypefn -## -## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, replot, xlabel, and ylabel} ## Author: jwe
--- a/scripts/plot/xlabel.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/plot/xlabel.m Mon Mar 06 21:26:54 2006 +0000 @@ -24,10 +24,9 @@ ## Specify x, y, and z axis labels for the plot. If you already have a plot ## displayed, use the command @code{replot} to redisplay it with the new ## labels. +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, replot, ylabel, title} ## @end deftypefn -## -## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, replot, ylabel, and title} ## Author: jwe
--- a/scripts/polynomial/compan.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/compan.m Mon Mar 06 21:26:54 2006 +0000 @@ -51,10 +51,9 @@ ## ## The eigenvalues of the companion matrix are equal to the roots of the ## polynomial. +## @seealso{poly, roots, residue, conv, deconv, polyval, polyderiv, +## polyinteg} ## @end deftypefn -## -## @seealso{poly, roots, residue, conv, deconv, polyval, polyderiv, and -## polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/conv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/conv.m Mon Mar 06 21:26:54 2006 +0000 @@ -25,9 +25,8 @@ ## @code{length (a) + length (b) - 1}. ## If @var{a} and @var{b} are polynomial coefficient vectors, @code{conv} ## returns the coefficients of the product polynomial. +## @seealso{deconv, poly, roots, residue, polyval, polyderiv, polyinteg} ## @end deftypefn -## -## @seealso{deconv, poly, roots, residue, polyval, polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/deconv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/deconv.m Mon Mar 06 21:26:54 2006 +0000 @@ -27,9 +27,8 @@ ## If @var{y} and @var{a} are polynomial coefficient vectors, @var{b} will ## contain the coefficients of the polynomial quotient and @var{r} will be ## a remander polynomial of lowest order. +## @seealso{conv, poly, roots, residue, polyval, polyderiv, polyinteg} ## @end deftypefn -## -## @seealso{conv, poly, roots, residue, polyval, polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/polyderiv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/polyderiv.m Mon Mar 06 21:26:54 2006 +0000 @@ -26,9 +26,9 @@ ## is given @var{b} and @var{a}, the derivative of the product is ## returned in @var{q}, or the quotient numerator in @var{q} and the ## quotient denominator in @var{r}. +## @seealso{poly, polyinteg, polyreduce, roots, conv, deconv, residue, +## filter, polygcd, polyval, polyvalm} ## @end deftypefn -## @seealso{poly, polyinteg, polyreduce, roots, conv, deconv, residue, -## filter, polygcd, polyval, and polyvalm} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/polygcd.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/polygcd.m Mon Mar 06 21:26:54 2006 +0000 @@ -33,10 +33,9 @@ ## polygcd (poly(1:8), poly(3:12)) - poly(3:8) ## deconv (poly(1:8), polygcd (poly(1:8), poly(3:12))) - poly(1:2) ## @end example -## @end deftypefn -## ## @seealso{poly, polyinteg, polyderiv, polyreduce, roots, conv, deconv, ## residue, filter, polyval, and polyvalm} +## @end deftypefn function x = polygcd (b, a, tol)
--- a/scripts/polynomial/polyinteg.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/polyinteg.m Mon Mar 06 21:26:54 2006 +0000 @@ -23,10 +23,9 @@ ## coefficients are represented by the vector @var{c}. ## ## The constant of integration is set to zero. -## @end deftypefn -## ## @seealso{poly, polyderiv, polyreduce, roots, conv, deconv, residue, ## filter, polyval, and polyvalm} +## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/polyout.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/polyout.m Mon Mar 06 21:26:54 2006 +0000 @@ -33,10 +33,9 @@ ## and return it as a string or write it to the screen (if ## @var{nargout} is zero). ## @var{x} defaults to the string @code{"s"}. -## @end deftypefn -## ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, ## filter, polyderiv, and polyinteg} +## @end deftypefn ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: May 1995
--- a/scripts/polynomial/polyreduce.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/polyreduce.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,10 +21,9 @@ ## @deftypefn {Function File} {} polyreduce (@var{c}) ## Reduces a polynomial coefficient vector to a minimum number of terms by ## stripping off any leading zeros. +## @seealso{poly, roots, conv, deconv, residue, filter, polyval, +## polyvalm, polyderiv, polyinteg} ## @end deftypefn -## -## @seealso{poly, roots, conv, deconv, residue, filter, polyval, -## polyvalm, polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/polyval.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/polyval.m Mon Mar 06 21:26:54 2006 +0000 @@ -26,10 +26,9 @@ ## ## If @var{x} is a vector or matrix, the polynomial is evaluated at each of ## the elements of @var{x}. +## @seealso{polyvalm, poly, roots, conv, deconv, residue, filter, +## polyderiv, polyinteg} ## @end deftypefn -## -## @seealso{polyvalm, poly, roots, conv, deconv, residue, filter, -## polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/polyvalm.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/polyvalm.m Mon Mar 06 21:26:54 2006 +0000 @@ -26,10 +26,9 @@ ## element multiplication as is used in polyval. ## ## The argument @var{x} must be a square matrix. -## @end deftypefn -## ## @seealso{polyval, poly, roots, conv, deconv, residue, filter, ## polyderiv, and polyinteg} +## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/polynomial/residue.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/polynomial/residue.m Mon Mar 06 21:26:54 2006 +0000 @@ -99,9 +99,8 @@ ## s^3 - 5s^2 + 8s - 4 (s-2) (s-2)^2 (s-1) ## @end example ## @end ifinfo +## @seealso{poly, roots, conv, deconv, polyval, polyderiv, and polyinteg} ## @end deftypefn -## -## @seealso{poly, roots, conv, deconv, polyval, polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: June 1994
--- a/scripts/set/complement.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/set/complement.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## @result{} 5 ## @end group ## @end example +## @seealso{create_set, union, intersection} ## @end deftypefn -## -## @seealso{create_set, union, and intersection} ## Author: jwe
--- a/scripts/set/create_set.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/set/create_set.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## @result{} [ 1, 2, 3, 4 ] ## @end group ## @end example +## @seealso{union, intersection, complement} ## @end deftypefn -## -## @seealso{union, intersection, and complement} ## Author: jwe
--- a/scripts/set/intersection.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/set/intersection.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## @result{} [ 2, 3 ] ## @end group ## @end example +## @seealso{create_set, union, complement} ## @end deftypefn -## -## @seealso{create_set, union, and complement} ## Author: jwe
--- a/scripts/set/ismember.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/set/ismember.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,8 +21,8 @@ ## @deftypefn {Function File} {} ismember (@var{A}, @var{S}) ## Return a matrix the same shape as @var{A} which has 1 if ## @code{A(i,j)} is in @var{S} or 0 if it isn't. +## @seealso{unique, union, intersection, setxor, setdiff} ## @end deftypefn -## @seealso{unique, union, intersection, setxor, setdiff} ## Author: Paul Kienzle ## Adapted-by: jwe
--- a/scripts/set/setdiff.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/set/setdiff.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,8 +22,8 @@ ## Return the elements in @var{a} but not in @var{b}, sorted in ## ascending order. If @var{a} and @var{b} are both column vectors ## return a column vector, otherwise return a row vector. +## @seealso{unique, union, intersect, setxor, ismember} ## @end deftypefn -## @seealso{unique, union, intersect, setxor, ismember} ## Author: Paul Kienzle ## Adapted-by: jwe @@ -49,4 +49,4 @@ endif endfunction - \ No newline at end of file +
--- a/scripts/set/union.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/set/union.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## @result{} [ 1, 2, 3, 4, 5 ] ## @end group ## @end example +## @seealso{create_set, intersection, complement} ## @end deftypefn -## -## @seealso{create_set, intersection, and complement} ## Author: jwe
--- a/scripts/set/unique.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/set/unique.m Mon Mar 06 21:26:54 2006 +0000 @@ -30,9 +30,8 @@ ## ## Return index vectors @var{i} and @var{j} such that @code{x(i)==y} and ## @code{y(j)==x}. -## +## @seealso{union, intersect, setdiff, setxor, ismember} ## @end deftypefn -## @seealso{union, intersect, setdiff, setxor, ismember} function [y, i, j] = unique (x, r)
--- a/scripts/sparse/etreeplot.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/etreeplot.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,8 +22,8 @@ ## @code{@var{s}+@var{s}'} if @var{s} in non-symmetric. The optional ## parameters @var{line_style} and @var{edge_style} define the output ## style. +## @seealso{treeplot, gplot} ## @end deftypefn -## @seealso{treeplot,gplot} function etreeplot (s, varargin) treeplot (etree (s+s'), varargin{:});
--- a/scripts/sparse/gplot.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/gplot.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,8 +28,8 @@ ## the plot. Called with no output arguments the graph is plotted ## directly. Otherwise, return the coordinates of the plot in @var{x} ## and @var{y}. +## @seealso{treeplot, etreeplot, spy} ## @end deftypefn -## @seealso{treeplot, etreeplot, spy} function [x, y] = gplot (A, xy, line_style)
--- a/scripts/sparse/spalloc.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/spalloc.m Mon Mar 06 21:26:54 2006 +0000 @@ -36,8 +36,8 @@ ## ## will reallocate memory at each step. It is therefore vitally important ## that code like this is vectorized as much as possible. +## @seealso{sparse, nzmax} ## @end deftypefn -## @seealso{sparse, nzmax} function s = spalloc (r, c, nz) s = sparse (r, c);
--- a/scripts/sparse/sphcat.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/sphcat.m Mon Mar 06 21:26:54 2006 +0000 @@ -18,9 +18,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{y} =} sphcat (@var{a1}, @var{a2}, @dots{}, @var{aN}) ## Return the horizontal concatenation of sparse matrices. This function -## is obselete and @code{horzcat} should be used +## is obselete and @code{horzcat} should be used. +## @seealso {spvcat, vertcat, horzcat, cat} ## @end deftypefn -## @seealso {spvcat, vertcat, horzcat, cat} function y = sphcat (varargin)
--- a/scripts/sparse/sprand.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/sprand.m Mon Mar 06 21:26:54 2006 +0000 @@ -15,9 +15,8 @@ ## ## If called with a single matrix argument, a random sparse matrix is ## generated wherever the matrix @var{S} is non-zero. +## @seealso{sprandn} ## @end deftypefn -## @seealso{sprandn} - ## This program is public domain ## Author: Paul Kienzle <pkienzle@users.sf.net>
--- a/scripts/sparse/sprandn.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/sprandn.m Mon Mar 06 21:26:54 2006 +0000 @@ -15,8 +15,8 @@ ## ## If called with a single matrix argument, a random sparse matrix is ## generated wherever the matrix @var{S} is non-zero. +## @seealso{sprand} ## @end deftypefn -## @seealso{sprand} ## This program is public domain ## Author: Paul Kienzle <pkienzle@users.sf.net>
--- a/scripts/sparse/sprandsym.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/sprandsym.m Mon Mar 06 21:26:54 2006 +0000 @@ -29,8 +29,8 @@ ## If called with a single matrix argument, a random sparse matrix is ## generated wherever the matrix @var{S} is non-zero in its lower ## triangular part. +## @seealso{sprand, sprandn} ## @end deftypefn -## @seealso{sprand, sprandn} function S = sprandsym(n,d) if nargin == 1
--- a/scripts/sparse/spvcat.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/spvcat.m Mon Mar 06 21:26:54 2006 +0000 @@ -19,8 +19,8 @@ ## @deftypefn {Function File} {@var{y} =} spvcat (@var{a1}, @var{a2}, @dots{}, @var{aN}) ## Return the vertical concatenation of sparse matrices. This function ## is obselete and @code{vertcat} should be used +## @seealso{sphcat, vertcat, horzcat, cat} ## @end deftypefn -## @seealso {sphcat, vertcat, horzcat, cat} function y = spvcat (varargin)
--- a/scripts/sparse/treeplot.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/sparse/treeplot.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,8 +22,8 @@ ## predecessors, optional parametres @var{LineStyle} and @var{EdgeStyle} ## define the output style. The complexity of the algorithm is O(n) in ## terms of is time and memory requirements. +## @seealso{etreeplot, gplot} ## @end deftypefn -## @seealso{etreeplot,gplot} function treeplot (Tree, NodeS, EdgeS)
--- a/scripts/specfun/erfinv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/specfun/erfinv.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Mapping Function} {} erfinv (@var{z}) ## Computes the inverse of the error function. +## @seealso{erf, erfc} ## @end deftypefn -## -## @seealso{erf and erfc} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Created: 27 September 1994
--- a/scripts/specfun/log2.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/specfun/log2.m Mon Mar 06 21:26:54 2006 +0000 @@ -30,9 +30,8 @@ ## @ifinfo ## 1/2 <= abs(f) < 1 and x = f * 2^e. ## @end ifinfo +## @seealso{log, log10, logspace, exp} ## @end deftypefn -## -## @seealso{log, log10, logspace, and exp} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/specfun/pow2.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/specfun/pow2.m Mon Mar 06 21:26:54 2006 +0000 @@ -38,9 +38,8 @@ ## @ifinfo ## f .* (2 .^ e). ## @end ifinfo +## @seealso{nextpow2} ## @end deftypefn -## -## @seealso{nextpow2} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/special-matrix/hankel.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/special-matrix/hankel.m Mon Mar 06 21:26:54 2006 +0000 @@ -43,9 +43,8 @@ ## @end group ## @end example ## @end ifinfo +## @seealso{vander, sylvester_matrix, hilb, invhilb, toeplitz} ## @end deftypefn -## -## @seealso{vander, sylvester_matrix, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/hilb.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/special-matrix/hilb.m Mon Mar 06 21:26:54 2006 +0000 @@ -42,9 +42,8 @@ ## H (i, j) = 1 / (i + j - 1) ## @end example ## @end ifinfo +## @seealso{hankel, vander, sylvester_matrix, invhilb, toeplitz} ## @end deftypefn -## -## @seealso{hankel, vander, sylvester_matrix, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/invhilb.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/special-matrix/invhilb.m Mon Mar 06 21:26:54 2006 +0000 @@ -61,10 +61,8 @@ ## Compare this with the numerical calculation of @code{inverse (hilb (n))}, ## which suffers from the ill-conditioning of the Hilbert matrix, and the ## finite precision of your computer's floating point arithmetic. -## +## @seealso{hankel, vander, sylvester_matrix, hilb, toeplitz} ## @end deftypefn -## -## @seealso{hankel, vander, sylvester_matrix, hilb, and toeplitz} ## Author: Dirk Laurie <dlaurie@na-net.ornl.gov>
--- a/scripts/special-matrix/sylvester_matrix.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/special-matrix/sylvester_matrix.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,9 +28,8 @@ ## @ifinfo ## n = 2^k. ## @end ifinfo +## @seealso{hankel, vander, hilb, invhilb, toeplitz} ## @end deftypefn -## -## @seealso{hankel, vander, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/toeplitz.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/special-matrix/toeplitz.m Mon Mar 06 21:26:54 2006 +0000 @@ -51,9 +51,8 @@ ## @end group ## @end example ## @end ifinfo +## @seealso{hankel, vander, sylvester_matrix, hilb, invhib} ## @end deftypefn -## -## @seealso{hankel, vander, sylvester_matrix, hilb, and invhib} ## Author: jwe
--- a/scripts/special-matrix/vander.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/special-matrix/vander.m Mon Mar 06 21:26:54 2006 +0000 @@ -45,9 +45,8 @@ ## @end group ## @end example ## @end ifinfo +## @seealso{hankel, sylvester_matrix, hilb, invhilb, toeplitz} ## @end deftypefn -## -## @seealso{hankel, sylvester_matrix, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/statistics/base/median.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/statistics/base/median.m Mon Mar 06 21:26:54 2006 +0000 @@ -42,9 +42,8 @@ ## @end ifinfo ## If @var{x} is a matrix, compute the median value for each ## column and return them in a row vector. +## @seealso{std, mean} ## @end deftypefn -## -## @seealso{std and mean} ## Author: jwe
--- a/scripts/statistics/base/std.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/statistics/base/std.m Mon Mar 06 21:26:54 2006 +0000 @@ -55,9 +55,8 @@ ## ## The third argument @var{dim} determines the dimension along which the standard ## deviation is calculated. +## @seealso{mean, median} ## @end deftypefn -## -## @seealso{mean and median} ## Author: jwe
--- a/scripts/statistics/distributions/gamcdf.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/statistics/distributions/gamcdf.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,9 +22,8 @@ ## For each element of @var{x}, compute the cumulative distribution ## function (CDF) at @var{x} of the Gamma distribution with parameters ## @var{a} and @var{b}. +## @seealso{gamma, gammaln, gammainc, gampdf, gaminv, gamrnd} ## @end deftypefn -## -## @seealso{gamma, gammaln, gammainc, gampdf, gaminv, gamrnd} ## Author: TT <Teresa.Twaroch@ci.tuwien.ac.at> ## Description: CDF of the Gamma distribution
--- a/scripts/statistics/distributions/gaminv.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/statistics/distributions/gaminv.m Mon Mar 06 21:26:54 2006 +0000 @@ -21,10 +21,9 @@ ## @deftypefn {Function File} {} gaminv (@var{x}, @var{a}, @var{b}) ## For each component of @var{x}, compute the quantile (the inverse of ## the CDF) at @var{x} of the Gamma distribution with parameters @var{a} -## and @var{b}. +## and @var{b}. +## @seealso{gamma, gammaln, gammainc, gampdf, gamcdf, gamrnd} ## @end deftypefn -## -## @seealso{gamma, gammaln, gammainc, gampdf, gamcdf, gamrnd} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Quantile function of the Gamma distribution
--- a/scripts/statistics/distributions/gampdf.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/statistics/distributions/gampdf.m Mon Mar 06 21:26:54 2006 +0000 @@ -22,9 +22,8 @@ ## For each element of @var{x}, return the probability density function ## (PDF) at @var{x} of the Gamma distribution with parameters @var{a} ## and @var{b}. +## @seealso{gamma, gammaln, gammainc, gamcdf, gaminv, gamrnd} ## @end deftypefn -## -## @seealso{gamma, gammaln, gammainc, gamcdf, gaminv, gamrnd} ## Author: TT <Teresa.Twaroch@ci.tuwien.ac.at> ## Description: PDF of the Gamma distribution
--- a/scripts/statistics/distributions/gamrnd.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/statistics/distributions/gamrnd.m Mon Mar 06 21:26:54 2006 +0000 @@ -27,9 +27,8 @@ ## ## If @var{r} and @var{c} are omitted, the size of the result matrix is ## the common size of @var{a} and @var{b}. +## @seealso{gamma, gammaln, gammainc, gampdf, gamcdf, gaminv} ## @end deftypefn -## -## @seealso{gamma, gammaln, gammainc, gampdf, gamcdf, gaminv} ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Random deviates from the Gamma distribution
--- a/scripts/strings/base2dec.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/base2dec.m Mon Mar 06 21:26:54 2006 +0000 @@ -40,10 +40,8 @@ ## base2dec ("yyyzx", "xyz") ## @result{} 123 ## @end example -## +## @seealso{dec2base, dec2bin, bin2dec, hex2dec, dec2hex} ## @end deftypefn -## -## @seealso{dec2base, dec2bin, bin2dec, hex2dec, dec2hex} ## Author: Daniel Calvelo <dcalvelo@yahoo.com> ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/strings/bin2dec.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/bin2dec.m Mon Mar 06 21:26:54 2006 +0000 @@ -29,9 +29,8 @@ ## ## If @var{s} is a string matrix, returns a column vector of converted ## numbers, one per row of @var{s}. Invalid rows evaluate to NaN. +## @seealso{dec2hex, base2dec, dec2base, bin2dec, dec2bin} ## @end deftypefn -## -## @seealso{dec2hex, base2dec, dec2base, bin2dec, dec2bin} ## Author: Daniel Calvelo <dcalvelo@yahoo.com> ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/strings/dec2base.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/dec2base.m Mon Mar 06 21:26:54 2006 +0000 @@ -41,9 +41,8 @@ ## ## The optional third argument, @var{len}, specifies the minimum ## number of digits in the result. +## @seealso{base2dec, dec2bin, bin2dec, hex2dec, dec2hex} ## @end deftypefn -## -## @seealso{base2dec, dec2bin, bin2dec, hex2dec, dec2hex} ## Author: Daniel Calvelo <dcalvelo@yahoo.com> ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/strings/dec2bin.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/dec2bin.m Mon Mar 06 21:26:54 2006 +0000 @@ -32,9 +32,8 @@ ## ## The optional second argument, @var{len}, specifies the minimum ## number of digits in the result. +## @seealso{bin2dec, dec2base, base2dec, hex2dec, dec2hex} ## @end deftypefn -## -## @seealso{bin2dec, dec2base, base2dec, hex2dec, dec2hex} ## Author: Daniel Calvelo <dcalvelo@yahoo.com> ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/strings/dec2hex.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/dec2hex.m Mon Mar 06 21:26:54 2006 +0000 @@ -32,9 +32,8 @@ ## ## The optional second argument, @var{len}, specifies the minimum ## number of digits in the result. +## @seealso{hex2dec, dec2base, base2dec, bin2dec, dec2bin} ## @end deftypefn -## -## @seealso{hex2dec, dec2base, base2dec, bin2dec, dec2bin} ## Author: Daniel Calvelo <dcalvelo@yahoo.com> ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/strings/hex2dec.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/hex2dec.m Mon Mar 06 21:26:54 2006 +0000 @@ -31,9 +31,8 @@ ## ## If @var{s} is a string matrix, returns a column vector of converted ## numbers, one per row of @var{s}. Invalid rows evaluate to NaN. +## @seealso{dec2hex, base2dec, dec2base, bin2dec, dec2bin} ## @end deftypefn -## -## @seealso{dec2hex, base2dec, dec2base, bin2dec, dec2bin} ## Author: Daniel Calvelo <dcalvelo@yahoo.com> ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/strings/isletter.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/isletter.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} isletter (@var{s}) ## Returns true if @var{s} is a letter false otherwise. +## @seealso{isalpha} ## @end deftypefn -## -## @seealso{isalpha} ## Author: jwe
--- a/scripts/strings/lower.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/lower.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} lower (@var{s}) ## Transform all letters in the string @var{s} to lower case. +## @seealso{tolower} ## @end deftypefn -## -## @seealso{tolower} ## Author: jwe
--- a/scripts/strings/upper.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/strings/upper.m Mon Mar 06 21:26:54 2006 +0000 @@ -20,9 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} upper (@var{s}) ## Transform all letters in the string @var{s} to upper case. +## @seealso{toupper} ## @end deftypefn -## -## @seealso{toupper} ## Author: jwe
--- a/scripts/testfun/assert.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/testfun/assert.m Mon Mar 06 21:26:54 2006 +0000 @@ -39,9 +39,8 @@ ## Absolute error @code{abs(@var{observed} - @var{expected}) > abs(@var{tol})} ## will be used when tolerance is negative or when the expected value is zero. ## @end table -## +## @seealso{test} ## @end deftypefn -## @seealso{test} ## TODO: Output throttling: don't print out the entire 100x100 matrix, ## TODO: but instead give a summary; don't print out the whole list, just
--- a/scripts/testfun/demo.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/testfun/demo.m Mon Mar 06 21:26:54 2006 +0000 @@ -66,9 +66,8 @@ ## %! f(3) ## %! endif ## @end example -## +## @seealso{test, example} ## @end deftypefn -## @seealso{test, example} ## TODO: modify subplot so that gnuplot_has_multiplot == 0 causes it to ## TODO: use the current figure window but pause if not plotting in the
--- a/scripts/testfun/example.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/testfun/example.m Mon Mar 06 21:26:54 2006 +0000 @@ -28,8 +28,8 @@ ## various examples. ## ## See @code{demo} for a complete explanation. +## @seealso{demo, test} ## @end deftypefn -## @seealso{demo, test} ## PKG_ADD: mark_as_command example
--- a/scripts/testfun/test.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/testfun/test.m Mon Mar 06 21:26:54 2006 +0000 @@ -64,9 +64,8 @@ ## ## If the second argument is 'explain', then @var{name} is ignored and an ## explanation of the line markers used is written to the file @var{fid}. -## +## @seealso{error, assert, fail, demo, example} ## @end deftypefn -## @seealso{error, assert, fail, demo, example} ## TODO: * Consider using keyword fail rather then error? This allows us ## TODO: to make a functional form of error blocks, which means we
--- a/scripts/time/etime.m Sat Mar 04 22:21:01 2006 +0000 +++ b/scripts/time/etime.m Mon Mar 06 21:26:54 2006 +0000 @@ -31,9 +31,8 @@ ## @noindent ## will set the variable @code{elapsed_time} to the number of seconds since ## the variable @code{t0} was set. +## @seealso{tic, toc, clock, cputime} ## @end deftypefn -## -## @seealso{tic, toc, clock, and cputime} ## Author: jwe
--- a/src/ChangeLog Sat Mar 04 22:21:01 2006 +0000 +++ b/src/ChangeLog Mon Mar 06 21:26:54 2006 +0000 @@ -1,3 +1,20 @@ +2006-03-06 Keith Goodman <kwgoodman@gmail.com> + + * bitfcns.cc, data.cc, debug.cc, file-io.cc, help.cc, + load-save.cc, mappers.cc, ov-cell.cc, ov-fcn-inline.cc, + ov-struct.cc, ov-usr-fcn.cc, ov.cc, pr-output.cc, utils.cc, + variables.cc, DLD-FUNCTIONS/ccolamd.cc, DLD-FUNCTIONS/cellfun.cc, + DLD-FUNCTIONS/colamd.cc, DLD-FUNCTIONS/daspk.cc, + DLD-FUNCTIONS/dasrt.cc, DLD-FUNCTIONS/dassl.cc, + DLD-FUNCTIONS/fft.cc, DLD-FUNCTIONS/fft2.cc, + DLD-FUNCTIONS/fftn.cc, DLD-FUNCTIONS/fftw_wisdom.cc, + DLD-FUNCTIONS/gammainc.cc, DLD-FUNCTIONS/gcd.cc, + DLD-FUNCTIONS/luinc.cc, DLD-FUNCTIONS/odessa.cc, + DLD-FUNCTIONS/sparse.cc, DLD-FUNCTIONS/spchol.cc, + DLD-FUNCTIONS/splu.cc, DLD-FUNCTIONS/spqr.cc, + DLD-FUNCTIONS/sqrtm.cc: + Move @seealso inside @defXXX macro. Remove "and" from @seealso. + 2006-03-04 John W. Eaton <jwe@octave.org> * help.cc (additional_help_message): Don't print "\n" before message.
--- a/src/DLD-FUNCTIONS/ccolamd.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/ccolamd.cc Mon Mar 06 21:26:54 2006 +0000 @@ -131,9 +131,8 @@ and a grant from Sandia National Lab. See\n\ @url{http://www.cise.ufl.edu/research/sparse} for ccolamd, csymamd, amd,\n\ colamd, symamd, and other related orderings.\n\ -\n\ -@end deftypefn\n\ -@seealso{colamd, csymamd}") +@seealso{colamd, csymamd}\n\ +@end deftypefn") { #ifdef HAVE_CCOLAMD octave_value_list retval; @@ -384,9 +383,8 @@ and a grant from Sandia National Lab. See\n\ @url{http://www.cise.ufl.edu/research/sparse} for ccolamd, csymamd, amd,\n\ colamd, symamd, and other related orderings.\n\ -\n\ -@end deftypefn\n\ -@seealso{symamd, ccolamd}") +@seealso{symamd, ccolamd}\n\ +@end deftypefn") { #if HAVE_CCOLAMD octave_value_list retval;
--- a/src/DLD-FUNCTIONS/cellfun.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/cellfun.cc Mon Mar 06 21:26:54 2006 +0000 @@ -77,9 +77,8 @@ @result{} ans = @{\"foo\", \"bar\", \"foobar\"@}\n\ @end group\n\ @end example\n\ -\n\ -@end deftypefn\n\ -@seealso{isempty, islogical, isreal, length, ndims, numel, size, isclass}") +@seealso{isempty, islogical, isreal, length, ndims, numel, size, isclass}\n\ +@end deftypefn") { octave_value retval; @@ -252,8 +251,8 @@ Convert to matrix @var{m} into a cell array. If @var{d} is defined the\n\ value @var{c} is of dimension 1 in this dimension and the elements of\n\ @var{m} are placed in slices in @var{c}.\n\ -@end deftypefn\n\ -@seealso{mat2cell}") +@seealso{mat2cell}\n\ +@end deftypefn") { int nargin = args.length(); octave_value retval;
--- a/src/DLD-FUNCTIONS/colamd.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/colamd.cc Mon Mar 06 21:26:54 2006 +0000 @@ -263,8 +263,8 @@ developed in collaboration with John Gilbert, Xerox PARC, and Esmond\n\ Ng, Oak Ridge National Laboratory. (see\n\ @url{http://www.cise.ufl.edu/research/sparse/colamd})\n\ -@end deftypefn\n\ -@seealso{colperm, symamd}") +@seealso{colperm, symamd}\n\ +@end deftypefn") { octave_value_list retval; @@ -499,8 +499,8 @@ developed in collaboration with John Gilbert, Xerox PARC, and Esmond\n\ Ng, Oak Ridge National Laboratory. (see\n\ @url{http://www.cise.ufl.edu/research/sparse/colamd})\n\ -@end deftypefn\n\ -@seealso{colperm, colamd}") +@seealso{colperm, colamd}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/daspk.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/daspk.cc Mon Mar 06 21:26:54 2006 +0000 @@ -266,8 +266,8 @@ \n\ You can use the function @code{daspk_options} to set optional\n\ parameters for @code{daspk}.\n\ -@end deftypefn\n\ -@seealso{dassl}") +@seealso{dassl}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/dasrt.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/dasrt.cc Mon Mar 06 21:26:54 2006 +0000 @@ -339,8 +339,8 @@ \n\ You can use the function @code{dasrt_options} to set optional\n\ parameters for @code{dasrt}.\n\ -@end deftypefn\n\ -@seealso{daspk, dasrt, lsode, odessa}") +@seealso{daspk, dasrt, lsode, odessa}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/dassl.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/dassl.cc Mon Mar 06 21:26:54 2006 +0000 @@ -271,8 +271,8 @@ \n\ You can use the function @code{dassl_options} to set optional\n\ parameters for @code{dassl}.\n\ -@end deftypefn\n\ -@seealso{daspk, dasrt, lsode, odessa}") +@seealso{daspk, dasrt, lsode, odessa}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/fft.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/fft.cc Mon Mar 06 21:26:54 2006 +0000 @@ -166,8 +166,8 @@ \n\ If called with three arguments, @var{dim} is an integer specifying the\n\ dimension of the matrix along which the FFT is performed\n\ -@end deftypefn\n\ -@seealso {ifft, fft2, fftn, fftw_wisdom}") +@seealso{ifft, fft2, fftn, fftw_wisdom}\n\ +@end deftypefn") { return do_fft (args, "fft", 0); } @@ -192,8 +192,8 @@ \n\ If called with three agruments, @var{dim} is an integer specifying the\n\ dimension of the matrix along which the inverse FFT is performed\n\ -@end deftypefn\n\ -@seealso {fft, ifft2, ifftn, fftw_wisdom}") +@seealso{fft, ifft2, ifftn, fftw_wisdom}\n\ +@end deftypefn") { return do_fft (args, "ifft", 1); }
--- a/src/DLD-FUNCTIONS/fft2.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/fft2.cc Mon Mar 06 21:26:54 2006 +0000 @@ -149,8 +149,8 @@ \n\ If @var{a} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\ of @var{a} is treated seperately\n\ -@end deftypefn\n\ -@seealso {ifft2, fft, fftn fftw_wisdom}") +@seealso {ifft2, fft, fftn, fftw_wisdom}\n\ +@end deftypefn") { return do_fft2 (args, "fft2", 0); } @@ -168,8 +168,8 @@ \n\ If @var{a} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\ of @var{a} is treated seperately\n\ -@end deftypefn\n\ -@seealso {fft2, ifft, ifftn, fftw_wisdom}") +@seealso {fft2, ifft, ifftn, fftw_wisdom}\n\ +@end deftypefn") { return do_fft2 (args, "ifft2", 1); }
--- a/src/DLD-FUNCTIONS/fftn.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/fftn.cc Mon Mar 06 21:26:54 2006 +0000 @@ -130,8 +130,8 @@ truncated prior to performing the FFT. Otherwise if an element\n\ of @var{size} is larger than the corresponding dimension @var{a}\n\ is resized and padded with zeros.\n\ -@end deftypefn\n\ -@seealso {ifftn, fft, fft2, fftw_wisdom}") +@seealso {ifftn, fft, fft2, fftw_wisdom}\n\ +@end deftypefn") { return do_fftn (args, "fftn", 0); } @@ -147,8 +147,8 @@ truncated prior to performing the inverse FFT. Otherwise if an element\n\ of @var{size} is larger than the corresponding dimension @var{a}\n\ is resized and padded with zeros.\n\ -@end deftypefn\n\ -@seealso {fftn, ifft, ifft2, fftw_wisdom}") +@seealso {fftn, ifft, ifft2, fftw_wisdom}\n\ +@end deftypefn") { return do_fftn (args, "ifftn", 1); }
--- a/src/DLD-FUNCTIONS/fftw_wisdom.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/fftw_wisdom.cc Mon Mar 06 21:26:54 2006 +0000 @@ -82,8 +82,8 @@ Note that the program @code{fftw-wisdom} supplied with FFTW can equally\n\ be used to create a file containing wisdom that can be imported into\n\ Octave.\n\ -@end deftypefn\n\ -@seealso {fft, ifft, fft2, ifft2, fftn, ifftn}") +@seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\ +@end deftypefn") { octave_value retval;
--- a/src/DLD-FUNCTIONS/gammainc.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/gammainc.cc Mon Mar 06 21:26:54 2006 +0000 @@ -63,8 +63,8 @@ \n\ If neither @var{x} nor @var{a} is scalar, the sizes of @var{x} and\n\ @var{a} must agree, and @var{gammainc} is applied element-by-element.\n\ -@end deftypefn\n\ -@seealso{gamma and lgamma}") +@seealso{gamma, lgamma}\n\ +@end deftypefn") { octave_value retval;
--- a/src/DLD-FUNCTIONS/gcd.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/gcd.cc Mon Mar 06 21:26:54 2006 +0000 @@ -84,8 +84,8 @@ For backward compatiability with previous versions of this function, when\n\ all arguments are scalr, a single return argument @var{v1} containing\n\ all of the values of @var{v1}, @var{...} is acceptable.\n\ -@end deftypefn\n\ -@seealso{lcm, min, max, ceil, and floor}") +@seealso{lcm, min, max, ceil, floor}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/luinc.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/luinc.cc Mon Mar 06 21:26:54 2006 +0000 @@ -89,8 +89,8 @@ \n\ All other fields in @var{opts} are ignored. The outputs from @dfn{luinc}\n\ are the same as for @dfn{lu}.\n\ -@end deftypefn\n\ -@seealso{sparse, lu, cholinc}") +@seealso{sparse, lu, cholinc}\n\ +@end deftypefn") { int nargin = args.length (); octave_value_list retval;
--- a/src/DLD-FUNCTIONS/odessa.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/odessa.cc Mon Mar 06 21:26:54 2006 +0000 @@ -403,8 +403,8 @@ \n\ You can use the function @code{odessa_options} to set optional\n\ parameters for @code{odessa}.\n\ -@end deftypefn\n\ -@seealso{daspk, dassl, dasrt, lsode}") +@seealso{daspk, dassl, dasrt, lsode}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/sparse.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/sparse.cc Mon Mar 06 21:26:54 2006 +0000 @@ -620,8 +620,8 @@ @deftypefn {Loadable Function} {@var{y} =} spprod (@var{x},@var{dim})\n\ Product of elements along dimension @var{dim}. If @var{dim} is omitted,\n\ it defaults to 1 (column-wise products).\n\ -@end deftypefn\n\ -@seealso{spsum, spsumsq}") +@seealso{spsum, spsumsq}\n\ +@end deftypefn") { SPARSE_DIM_ARG_BODY (spprod, prod); } @@ -634,8 +634,8 @@ @deftypefn {Loadable Function} {@var{y} =} spcumprod (@var{x},@var{dim})\n\ Cumulative product of elements along dimension @var{dim}. If @var{dim}\n\ is omitted, it defaults to 1 (column-wise cumulative products).\n\ -@end deftypefn\n\ -@seealso{spcumsum}") +@seealso{spcumsum}\n\ +@end deftypefn") { SPARSE_DIM_ARG_BODY (spcumprod, cumprod); } @@ -648,8 +648,8 @@ @deftypefn {Loadable Function} {@var{y} =} spsum (@var{x},@var{dim})\n\ Sum of elements along dimension @var{dim}. If @var{dim} is omitted, it\n\ defaults to 1 (column-wise sum).\n\ -@end deftypefn\n\ -@seealso{spprod, spsumsq}") +@seealso{spprod, spsumsq}\n\ +@end deftypefn") { SPARSE_DIM_ARG_BODY (spsum, sum); } @@ -662,8 +662,8 @@ @deftypefn {Loadable Function} {@var{y} =} spcumsum (@var{x},@var{dim})\n\ Cumulative sum of elements along dimension @var{dim}. If @var{dim}\n\ is omitted, it defaults to 1 (column-wise cumulative sums).\n\ -@end deftypefn\n\ -@seealso{spcumprod}") +@seealso{spcumprod}\n\ +@end deftypefn") { SPARSE_DIM_ARG_BODY (spcumsum, cumsum); } @@ -682,8 +682,8 @@ @end example\n\ but it uses less memory and avoids calling @code{spconj} if @var{x} is\n\ real.\n\ -@end deftypefn\n\ -@seealso{spprod, spsum}") +@seealso{spprod, spsum}\n\ +@end deftypefn") { SPARSE_DIM_ARG_BODY (spsumsq, sumsq); } @@ -1240,9 +1240,8 @@ (2 , 3) -> 2\n\ (3 , 4) -> 3\n\ @end example\n\ -\n\ -@end deftypefn\n\ -@seealso{diag}") +@seealso{diag}\n\ +@end deftypefn") { octave_value retval;
--- a/src/DLD-FUNCTIONS/spchol.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/spchol.cc Mon Mar 06 21:26:54 2006 +0000 @@ -158,8 +158,8 @@ @end ifinfo\n\ \n\ Note that @code{splchol} factorizations is faster and use less memory.\n\ -@end deftypefn\n\ -@seealso{spcholinv, spchol2inv, splchol}") +@seealso{spcholinv, spchol2inv, splchol}\n\ +@end deftypefn") { return sparse_chol (args, nargout, "spchol", false); } @@ -208,8 +208,8 @@ Note that @code{splchol} factorizations is faster and use less memory\n\ than @code{spchol}. @code{splchol(@var{a})} is equivalent to\n\ @code{spchol(@var{a})'}.\n\ -@end deftypefn\n\ -@seealso{spcholinv, spchol2inv, splchol}") +@seealso{spcholinv, spchol2inv, splchol}\n\ +@end deftypefn") { return sparse_chol (args, nargout, "splchol", true); }
--- a/src/DLD-FUNCTIONS/splu.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/splu.cc Mon Mar 06 21:26:54 2006 +0000 @@ -68,8 +68,8 @@ With two or three output arguments, if a user-defined @var{Q} is given,\n\ then @code{@var{u} * @var{Q}'} is returned. The matrix is not required to\n\ be square.\n\ -@end deftypefn\n\ -@seealso{sparse, spinv, colamd, symamd}") +@seealso{sparse, spinv, colamd, symamd}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/spqr.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/spqr.cc Mon Mar 06 21:26:54 2006 +0000 @@ -70,9 +70,8 @@ [@var{c},@var{r}] = spqr (@var{a},@var{b})\n\ @var{x} = @var{r} \\ @var{c}\n\ @end example\n\ -\n\ -@end deftypefn\n\ -@seealso{spchol, qr}") +@seealso{spchol, qr}\n\ +@end deftypefn") { int nargin = args.length (); octave_value_list retval; @@ -246,8 +245,8 @@ The method used is described in: A. Pothen & C.-J. Fan. Computing the block\n\ triangular form of a sparse matrix. ACM Trans. Math. Software,\n\ 16(4):303-324, 1990.\n\ -@end deftypefn\n\ -@seealso{colamd,ccolamd}") +@seealso{colamd, ccolamd}\n\ +@end deftypefn") { int nargin = args.length(); octave_value_list retval;
--- a/src/DLD-FUNCTIONS/sqrtm.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/DLD-FUNCTIONS/sqrtm.cc Mon Mar 06 21:26:54 2006 +0000 @@ -115,8 +115,8 @@ Ref: Nicholas J. Higham. A new sqrtm for MATLAB. Numerical Analysis\n\ Report No. 336, Manchester Centre for Computational Mathematics,\n\ Manchester, England, January 1999.\n\ -@end deftypefn\n\ -@seealso{expm, logm, and funm}") +@seealso{expm, logm, funm}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/bitfcns.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/bitfcns.cc Mon Mar 06 21:26:54 2006 +0000 @@ -260,8 +260,8 @@ @deftypefn {Built-in Function} {} bitand (@var{x}, @var{y})\n\ Return the bitwise AND of nonnegative integers.\n\ @var{x}, @var{y} must be in range [0..bitmax]\n\ -@end deftypefn\n\ -@seealso{bitor, bitxor, bitset, bitget, bitcmp, bitshift, bitmax}") +@seealso{bitor, bitxor, bitset, bitget, bitcmp, bitshift, bitmax}\n\ +@end deftypefn") { BITOP (&, "bitand"); } @@ -271,8 +271,8 @@ @deftypefn {Built-in Function} {} bitor (@var{x}, @var{y})\n\ Return the bitwise OR of nonnegative integers.\n\ @var{x}, @var{y} must be in range [0..bitmax]\n\ -@end deftypefn\n\ -@seealso{bitor, bitxor, bitset, bitget, bitcmp, bitshift, bitmax}") +@seealso{bitor, bitxor, bitset, bitget, bitcmp, bitshift, bitmax}\n\ +@end deftypefn") { BITOP (|, "bitor"); } @@ -282,8 +282,8 @@ @deftypefn {Built-in Function} {} bitxor (@var{x}, @var{y})\n\ Return the bitwise XOR of nonnegative integers.\n\ @var{x}, @var{y} must be in range [0..bitmax]\n\ -@end deftypefn\n\ -@seealso{bitand, bitor, bitset, bitget, bitcmp, bitshift, bitmax}") +@seealso{bitand, bitor, bitset, bitget, bitcmp, bitshift, bitmax}\n\ +@end deftypefn") { BITOP (^, "bitxor"); } @@ -404,8 +404,8 @@ bitshift ([1, 10], 2, [3,4])\n\ @result{} 4 8\n\ @end example\n\ -@end deftypefn\n\ -@seealso{bitand, bitor, bitxor, bitset, bitget, bitcmp, bitmax}") +@seealso{bitand, bitor, bitxor, bitset, bitget, bitcmp, bitmax}\n\ +@end deftypefn") { octave_value retval; @@ -516,7 +516,7 @@ @end table\n\ \n\ The default for @var{type} is @code{uint32}.\n\ -@seealso{intmin,bitmax}\n\ +@seealso{intmin, bitmax}\n\ @end deftypefn") { octave_value retval; @@ -579,7 +579,7 @@ @end table\n\ \n\ The default for @var{type} is @code{uint32}.\n\ -@seealso{intmax,bitmax}\n\ +@seealso{intmax, bitmax}\n\ @end deftypefn") { octave_value retval;
--- a/src/data.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/data.cc Mon Mar 06 21:26:54 2006 +0000 @@ -778,8 +778,8 @@ @deftypefn {Built-in Function} {} horzcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\ Return the horizontal concatenation of N-d array objects, @var{array1},\n\ @var{array2}, @dots{}, @var{arrayN} along dimension 2.\n\ -@end deftypefn\n\ -@seealso{cat and vertcat}") +@seealso{cat, vertcat}\n\ +@end deftypefn") { octave_value_list args_tmp = args; @@ -797,8 +797,8 @@ @deftypefn {Built-in Function} {} vertcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\ Return the vertical concatenation of N-d array objects, @var{array1},\n\ @var{array2}, @dots{}, @var{arrayN} along dimension 1.\n\ -@end deftypefn\n\ -@seealso{cat and horzcat}") +@seealso{cat, horzcat}\n\ +@end deftypefn") { octave_value_list args_tmp = args; @@ -856,9 +856,8 @@ 0 0\n\ @end group\n\ @end example\n\ -\n\ -@end deftypefn\n\ -@seealso{horzcat and vertcat}") +@seealso{horzcat, vertcat}\n\ +@end deftypefn") { return do_cat (args, "cat"); } @@ -897,9 +896,8 @@ Return the generalized transpose for an N-d array object @var{a}.\n\ The permutation vector @var{perm} must contain the elements\n\ @code{1:ndims(a)} (in any order, but each element must appear just once).\n\ -\n\ -@end deftypefn\n\ -@seealso{ipermute}") +@seealso{ipermute}\n\ +@end deftypefn") { return do_permute (args, false, "permute"); } @@ -913,9 +911,8 @@ ipermute (permute (a, perm), perm)\n\ @end example\n\ returns the original array @var{a}.\n\ -\n\ -@end deftypefn\n\ -@seealso{permute}") +@seealso{permute}\n\ +@end deftypefn") { return do_permute (args, true, "ipermute"); }
--- a/src/debug.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/debug.cc Mon Mar 06 21:26:54 2006 +0000 @@ -94,9 +94,8 @@ @end table\n\ \n\ The rline returned is the real line that the breakpoint was set at.\n\ -\n\ -@end deftypefn\n\ -@seealso{dbclear, dbstatus, dbnext}") +@seealso{dbclear, dbstatus, dbnext}\n\ +@end deftypefn") { octave_value retval; @@ -163,8 +162,8 @@ @end table\n\ No checking is done to make sure that the line you requested is really\n\ a breakpoint. If you get the wrong line nothing will happen.\n\ -@end deftypefn\n\ -@seealso{dbstop, dbstatus, dbwhere}") +@seealso{dbstop, dbstatus, dbwhere}\n\ +@end deftypefn") { octave_value retval; @@ -225,8 +224,8 @@ String representing the function name. When already in debug\n\ mode this should be left out.\n\ @end table\n\ -@end deftypefn\n\ -@seealso{dbclear, dbwhere}") +@seealso{dbclear, dbwhere}\n\ +@end deftypefn") { octave_value retval; @@ -278,8 +277,8 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} dbwhere ()\n\ Show where we are in the code\n\ -@end deftypefn\n\ -@seealso{dbclear, dbstatus, dbstop}") +@seealso{dbclear, dbstatus, dbstop}\n\ +@end deftypefn\") { octave_value retval; @@ -356,8 +355,8 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} dbtype ()\n\ List script file with line numbers.\n\ -@end deftypefn\n\ -@seealso{dbclear, dbstatus, dbstop}") +@seealso{dbclear, dbstatus, dbstop}\n\ +@end deftypefn") { octave_value retval; octave_user_function *dbg_fcn;
--- a/src/file-io.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/file-io.cc Mon Mar 06 21:26:54 2006 +0000 @@ -192,8 +192,8 @@ @deftypefn {Built-in Function} {} fclose (@var{fid})\n\ Closes the specified file. If successful, @code{fclose} returns 0,\n\ otherwise, it returns -1.\n\ -@end deftypefn\n\ -@seealso{fopen, fseek, ftell}") +@seealso{fopen, fseek, ftell}\n\ +@end deftypefn") { octave_value retval = -1; @@ -242,8 +242,8 @@ \n\ @code{fflush} returns 0 on success and an OS dependent error value\n\ (@minus{}1 on unix) on error.\n\ -@end deftypefn\n\ -@seealso{fopen, fclose}") +@seealso{fopen, fclose}\n\ +@end deftypefn") { octave_value retval = -1; @@ -286,8 +286,8 @@ character.\n\ \n\ If there are no more characters to read, @code{fgetl} returns @minus{}1.\n\ -@end deftypefn\n\ -@seealso{fread, fscanf}") +@seealso{fread, fscanf}\n\ +@end deftypefn") { static std::string who = "fgetl"; @@ -335,8 +335,8 @@ character.\n\ \n\ If there are no more characters to read, @code{fgets} returns @minus{}1.\n\ -@end deftypefn\n\ -@seealso{fread, fscanf}") +@seealso{fread, fscanf}\n\ +@end deftypefn") { static std::string who = "fgets"; @@ -560,8 +560,8 @@ @noindent\n\ however, conversions are currently only supported for @samp{native}\n\ @samp{ieee-be}, and @samp{ieee-le} formats.\n\ -@end deftypefn\n\ -@seealso{fclose, fread, fseek}") +@seealso{fclose, fread, fseek}\n\ +@end deftypefn") { octave_value_list retval; @@ -702,8 +702,8 @@ by @code{ftell} (in which case @var{origin} must be @code{SEEK_SET}).\n\ \n\ Return 0 on success and -1 on error.\n\ -@end deftypefn\n\ -@seealso{ftell, fopen, fclose}") +@seealso{ftell, fopen, fclose}\n\ +@end deftypefn") { octave_value retval = -1; @@ -732,8 +732,8 @@ @deftypefn {Built-in Function} {} ftell (@var{fid})\n\ Return the position of the file pointer as the number of characters\n\ from the beginning of the file @var{fid}.\n\ -@end deftypefn\n\ -@seealso{fseek, fopen, fclose}") +@seealso{fseek, fopen, fclose}\n\ +@end deftypefn") { octave_value retval = -1; @@ -757,8 +757,8 @@ @deftypefn {Built-in Function} {} fprintf (@var{fid}, @var{template}, @dots{})\n\ This function is just like @code{printf}, except that the output is\n\ written to the stream @var{fid} instead of @code{stdout}.\n\ -@end deftypefn\n\ -@seealso{printf, sprintf, fread, fscanf, fopen, fclose}") +@seealso{printf, sprintf, fread, fscanf, fopen, fclose}\n\ +@end deftypefn") { static std::string who = "fprintf"; @@ -819,8 +819,8 @@ @var{template} to the stream @code{stdout}.\n\ \n\ Return the number of characters printed.\n\ -@end deftypefn\n\ -@seealso{fprintf, sprintf, scanf}") +@seealso{fprintf, sprintf, scanf}\n\ +@end deftypefn") { static std::string who = "printf"; @@ -913,8 +913,8 @@ suitably sized string as an argument, Octave's @code{sprintf} function\n\ returns the string, automatically sized to hold all of the items\n\ converted.\n\ -@end deftypefn\n\ -@seealso{printf, fprintf, sscanf}") +@seealso{printf, fprintf, sscanf}\n\ +@end deftypefn") { static std::string who = "sprintf"; @@ -1003,8 +1003,8 @@ single scalar return value. This form is more `C-like', and also\n\ compatible with previous versions of Octave. The number of successful\n\ conversions is returned in @var{count}\n\ -@end deftypefn\n\ -@seealso{scanf, sscanf, fread, fprintf}") +@seealso{scanf, sscanf, fread, fprintf}\n\ +@end deftypefn") { static std::string who = "fscanf"; @@ -1069,8 +1069,8 @@ This is like @code{fscanf}, except that the characters are taken from the\n\ string @var{string} instead of from a stream. Reaching the end of the\n\ string is treated as an end-of-file condition.\n\ -@end deftypefn\n\ -@seealso{fscanf, scanf, sprintf}") +@seealso{fscanf, scanf, sprintf}\n\ +@end deftypefn") { static std::string who = "sscanf"; @@ -1162,8 +1162,8 @@ \n\ It is currently not useful to call @code{scanf} in interactive\n\ programs.\n\ -@end deftypefn\n\ -@seealso{fscanf, sscanf, printf}") +@seealso{fscanf, sscanf, printf}\n\ +@end deftypefn") { int nargin = args.length (); @@ -1406,8 +1406,8 @@ \n\ The data read from the file is returned in @var{val}, and the number of\n\ values read is returned in @code{count}\n\ -@end deftypefn\n\ -@seealso{fwrite, fopen, fclose}") +@seealso{fwrite, fopen, fclose}\n\ +@end deftypefn") { octave_value_list retval; @@ -1518,8 +1518,8 @@ \n\ The behavior of @code{fwrite} is undefined if the values in @var{data}\n\ are too large to fit in the specified precision.\n\ -@end deftypefn\n\ -@seealso{fread, fopen, fclose}") +@seealso{fread, fopen, fclose}\n\ +@end deftypefn") { octave_value retval = -1; @@ -1560,8 +1560,8 @@ file and 0 otherwise. Note that it will only return 1 if the end of the\n\ file has already been encountered, not if the next read operation will\n\ result in an end-of-file condition.\n\ -@end deftypefn\n\ -@seealso{fread, fopen, fclose}") +@seealso{fread, fopen, fclose}\n\ +@end deftypefn") { octave_value retval = -1; @@ -1729,8 +1729,8 @@ directory for temporary files is used. Since the named file is not\n\ opened, by @code{tmpnam}, it is possible (though relatively unlikely)\n\ that it will not be available by the time your program attempts to open it.\n\ -@end deftypefn\n\ -@seealso{tmpfile, mkstemp, P_tmpdir}") +@seealso{tmpfile, mkstemp, P_tmpdir}\n\ +@end deftypefn") { octave_value retval; @@ -1772,8 +1772,8 @@ If successful, @var{fid} is a valid file ID and @var{msg} is an empty\n\ string. Otherwise, @var{fid} is -1 and @var{msg} contains a\n\ system-dependent error message.\n\ -@end deftypefn\n\ -@seealso{tmpnam, mkstemp, P_tmpdir}") +@seealso{tmpnam, mkstemp, P_tmpdir}\n\ +@end deftypefn") { octave_value_list retval; @@ -1832,8 +1832,8 @@ the file, and and @var{msg} is an empty string. Otherwise, @var{fid}\n\ is -1, @var{name} is empty, and @var{msg} contains a system-dependent\n\ error message.\n\ -@end deftypefn\n\ -@seealso{tmpfile, tmpnam, P_tmpdir}") +@seealso{tmpfile, tmpnam, P_tmpdir}\n\ +@end deftypefn") { octave_value_list retval;
--- a/src/help.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/help.cc Mon Mar 06 21:26:54 2006 +0000 @@ -1537,8 +1537,8 @@ find the first sentence, but the same can not be guaranteed for other\n\ functions. Therefore the use of the '-all' argument might be necessary\n\ to find related functions that are not part of octave.\n\ -@end deffn\n\ -@seealso{which, help}") +@seealso{which, help}\n\ +@end deffn") { octave_value_list retval; int nargin = args.length ();
--- a/src/load-save.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/load-save.cc Mon Mar 06 21:26:54 2006 +0000 @@ -1844,7 +1844,7 @@ If this variable is set to a nonzero value, Octave tries to save all\n\ current variables the the file \"octave-core\" if it crashes or receives a\n\ hangup, terminate or similar signal. The default value is 1.\n\ -@seealso{octave_core_file_limit, octave_core_file_name, and octave_core_file_options}\n\ +@seealso{octave_core_file_limit, octave_core_file_name, octave_core_file_options}\n\ @end defvr"); DEFVAR (default_save_options, "-text", default_save_options, @@ -1867,7 +1867,7 @@ the maximum size of the file. If a text file format is used, then the\n\ file could be much larger than the limit.\n\ The default value is -1 (unlimited)\n\ -@seealso{crash_dumps_octave_core, octave_core_file_name, and octave_core_file_options}\n\ +@seealso{crash_dumps_octave_core, octave_core_file_name, octave_core_file_options}\n\ @end defvr"); DEFVAR (octave_core_file_name, "octave-core", octave_core_file_name, @@ -1875,7 +1875,7 @@ @defvr {Built-in Variable} octave_core_file_name\n\ The name of the file used for saving data from the top-level workspace\n\ when Octave aborts. The default value is @code{\"octave-core\"}\n\ -@seealso{crash_dumps_octave_core, octave_core_file_name, and octave_core_file_options}\n\ +@seealso{crash_dumps_octave_core, octave_core_file_name, octave_core_file_options}\n\ @end defvr"); DEFVAR (octave_core_file_options, "-binary", octave_core_file_options, @@ -1886,7 +1886,7 @@ @code{octave_core_file_options} should follow the same format as the options\n\ that may be used with @code{save}. The default value is Octave's binary\n\ format.\n\ -@seealso{crash_dumps_octave_core, octave_core_file_name, and octave_core_file_limit}\n\ +@seealso{crash_dumps_octave_core, octave_core_file_name, octave_core_file_limit}\n\ @end defvr"); DEFVAR (save_header_format_string, default_save_header_format (),
--- a/src/mappers.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/mappers.cc Mon Mar 06 21:26:54 2006 +0000 @@ -279,8 +279,8 @@ @ifinfo\n\ @code{conj (@var{z})} = @var{x} - @var{i}@var{y}.\n\ @end ifinfo\n\ -@end deftypefn\n\ -@seealso{real and imag}"); +@seealso{real, imag}\n\ +@end deftypefn\n\"); DEFUN_MAPPER (cos, 0, 0, 0, cos, 0, std::cos, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\ @@ -315,8 +315,8 @@ t=0\n\ @end smallexample\n\ @end ifinfo\n\ -@end deftypefn\n\ -@seealso{erfc and erfinv}"); +@seealso{erfc, erfinv}\n\ +@end deftypefn"); DEFUN_MAPPER (erfc, 0, 0, 0, erfc, 0, 0, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\ @@ -330,9 +330,8 @@ @ifinfo\n\ @code{1 - erf (@var{z})}.\n\ @end ifinfo\n\ -@end deftypefn\n\ -\n\ -@seealso{erf and erfinv}"); +@seealso{erf, erfinv}\n\ +@end deftypefn"); DEFUN_MAPPER (exp, 0, 0, 0, exp, 0, std::exp, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\ @@ -390,17 +389,15 @@ t=0\n\ @end example\n\ @end ifinfo\n\ -@end deftypefn\n\ -\n\ -@seealso{gammai and lgamma}"); +@seealso{gammai, lgamma}\n\ +@end deftypefn"); DEFUN_MAPPER (imag, 0, 0, 0, imag, ximag, 0, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} imag (@var{z})\n\ Return the imaginary part of @var{z} as a real number.\n\ -@end deftypefn\n\ -\n\ -@seealso{real and conj}"); +@seealso{real, conj}\n\ +@end deftypefn"); DEFUN_MAPPER (isalnum, xisalnum, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\ @@ -525,38 +522,38 @@ @deftypefn {Mapping Function} {} lgamma (@var{x})\n\ @deftypefnx {Mapping Function} {} gammaln (@var{x})\n\ Return the natural logarithm of the gamma function.\n\ -@end deftypefn\n\ -@seealso{gamma and gammai}"); +@seealso{gamma, gammai}\n\ +@end deftypefn"); DEFUN_MAPPER (log, 0, 0, 0, log, 0, std::log, 0.0, octave_Inf, 0, 1, "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} log (@var{x})\n\ Compute the natural logarithm for each element of @var{x}. To compute the\n\ matrix logarithm, see @ref{Linear Algebra}.\n\ -@end deftypefn\n\ -@seealso{log2, log10, logspace, and exp}"); +@seealso{log2, log10, logspace, exp}\n\ +@end deftypefn"); DEFUN_MAPPER (log10, 0, 0, 0, log10, 0, std::log10, 0.0, octave_Inf, 0, 1, "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} log10 (@var{x})\n\ Compute the base-10 logarithm for each element of @var{x}.\n\ -@end deftypefn\n\ -@seealso{log, log2, logspace, and exp}"); +@seealso{log, log2, logspace, exp}\n\ +@end deftypefn"); DEFUN_MAPPER (real, 0, 0, 0, real, xreal, 0, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} real (@var{z})\n\ Return the real part of @var{z}.\n\ -@end deftypefn\n\ -@seealso{imag and conj}"); +@seealso{imag, conj}\n\ +@end deftypefn"); DEFUN_MAPPER (round, 0, 0, 0, xround, 0, xround, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} round (@var{x})\n\ Return the integer nearest to @var{x}. If @var{x} is complex, return\n\ @code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\ -@end deftypefn\n\ -@seealso{rem}"); +@seealso{rem}\n\ +@end deftypefn"); DEFUN_MAPPER (sign, 0, 0, 0, signum, 0, signum, 0.0, 0.0, 0, 0, "-*- texinfo -*-\n\
--- a/src/ov-cell.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/ov-cell.cc Mon Mar 06 21:26:54 2006 +0000 @@ -1075,8 +1075,8 @@ If @var{f} is the number of fields in the structure, the resulting\n\ cell array will have a dimension vector corresponding to\n\ @code{[@var{F} size(@var{S})]}.\n\ -@end deftypefn\n\ -@seealso{cell2struct, fieldnames}") +@seealso{cell2struct, fieldnames}\n\ +@end deftypefn") { octave_value retval;
--- a/src/ov-fcn-inline.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/ov-fcn-inline.cc Mon Mar 06 21:26:54 2006 +0000 @@ -584,8 +584,8 @@ \n\ If the second argument is an integer @var{n}, the arguments are\n\ @code{\"x\"}, @code{\"P1\"}, @dots{}, @code{\"P@var{N}\"}.\n\ -@end deftypefn\n\ -@seealso{argnames, formula, vectorize}") +@seealso{argnames, formula, vectorize}\n\ +@end deftypefn") { octave_value retval; @@ -737,8 +737,8 @@ Return a character string representing the inline function @var{fun}.\n\ Note that @code{char (@var{fun})} is equivalent to\n\ @code{formula (@var{fun})}.\n\ -@end deftypefn\n\ -@seealso{argnames, inline, vectorize}") +@seealso{argnames, inline, vectorize}\n\ +@end deftypefn") { octave_value retval; @@ -764,8 +764,8 @@ @deftypefn {Built-in Function} {} argnames (@var{fun})\n\ Return a cell array of character strings containing the names of\n\ the arguments of the inline function @var{fun}.\n\ -@end deftypefn\n\ -@seealso{argnames, inline, formula, vectorize}") +@seealso{argnames, inline, formula, vectorize}\n\ +@end deftypefn") { octave_value retval; @@ -801,8 +801,7 @@ Create a vectorized version of the inline function @var{fun}\n\ by replacing all occurrences of @code{*}, @code{/}, etc., with\n\ @code{.*}, @code{./}, etc.\n\ -@end deftypefn\n\ -@seealso{argnames, inline, formula, vectorize}") +@end deftypefn") { octave_value retval;
--- a/src/ov-struct.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/ov-struct.cc Mon Mar 06 21:26:54 2006 +0000 @@ -961,8 +961,8 @@ Remove field @var{f} from the structure @var{s}. If @var{f} is a\n\ cell array of character strings or a character array, remove the\n\ named fields.\n\ -@end deftypefn\n\ -@seealso{cellstr, iscellstr, and setfield") +@seealso{cellstr, iscellstr, setfield}\n\ +@end deftypefn") { octave_value retval;
--- a/src/ov-usr-fcn.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/ov-usr-fcn.cc Mon Mar 06 21:26:54 2006 +0000 @@ -600,8 +600,7 @@ Octave. If called with the optional argument @var{fcn_name}, return the\n\ maximum number of arguments the named function can accept, or -1 if the\n\ function accepts a variable number of arguments.\n\ -\n\ -@seealso{nargout, varargin, and varargout}\n\ +@seealso{nargout, varargin, varargout}\n\ @end deftypefn") { octave_value retval; @@ -674,8 +673,7 @@ @code{f}.\n\ \n\ At the top level, @code{nargout} is undefined.\n\ -\n\ -@seealso{nargin, varargin, and varargout}\n\ +@seealso{nargin, varargin, varargout}\n\ @end deftypefn") { octave_value retval;
--- a/src/ov.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/ov.cc Mon Mar 06 21:26:54 2006 +0000 @@ -2207,8 +2207,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} cast (@var{val}, @var{type})\n\ Convert @var{val} to the new data type @var{type}.\n\ -@end deftypefn\n\ -@seealso{class, typeinfo}") +@seealso{class, typeinfo}\n\ +@end deftypefn") { octave_value retval;
--- a/src/pr-output.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/pr-output.cc Mon Mar 06 21:26:54 2006 +0000 @@ -2540,8 +2540,8 @@ \n\ If an output value is requested, @code{disp} prints nothing and\n\ returns the formatted output in a string.\n\ -@end deftypefn\n\ -@seealso{fdisp}") +@seealso{fdisp}\n\ +@end deftypefn") { octave_value retval; @@ -2580,8 +2580,8 @@ \n\ @noindent\n\ Note that the output from @code{fdisp} always ends with a newline.\n\ -@end deftypefn\n\ -@seealso{disp}") +@seealso{disp}\n\ +@end deftypefn") { octave_value retval;
--- a/src/utils.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/utils.cc Mon Mar 06 21:26:54 2006 +0000 @@ -286,8 +286,8 @@ If the second optional argument @code{\"all\"} is supplied, return\n\ a cell array containing the list of all files that have the same\n\ name in the path. If no files are found, return an empty cell array.\n\ -@end deftypefn\n\ -@seealso{file_in_path, LOADPATH}") +@seealso{file_in_path, LOADPATH}\n\ +@end deftypefn") { octave_value retval;
--- a/src/variables.cc Sat Mar 04 22:21:01 2006 +0000 +++ b/src/variables.cc Mon Mar 06 21:26:54 2006 +0000 @@ -145,8 +145,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} mark_as_command (@var{name})\n\ Enter @var{name} into the list of commands.\n\ -@end deftypefn\n\ -@seealso{unmark_command, iscommand}") +@seealso{unmark_command, iscommand}\n\ +@end deftypefn") { octave_value_list retval; @@ -179,8 +179,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} unmark_command (@var{name})\n\ Remove @var{name} from the list of commands.\n\ -@end deftypefn\n\ -@seealso{mark_as_command, iscommand}") +@seealso{mark_as_command, iscommand}\n\ +@end deftypefn") { octave_value_list retval; @@ -238,8 +238,8 @@ Return true if @var{name} is a command style function. If @var{name}\n\ is omitted, return a list of identifiers which are marked as commands with\n\ mark_as_command.\n\ -@end deftypefn\n\ -@seealso{mark_as_command, unmark_command}") +@seealso{mark_as_command, unmark_command}\n\ +@end deftypefn") { octave_value retval; @@ -311,8 +311,8 @@ are handled as usual, you cannot pass a token starting with a comment\n\ character ('#' or '%') to your function, and the last token cannot be\n\ a continuation token ('\\' or '...').\n\ -@end deftypefn\n\ -@seealso{unmark_rawcommand, israwcommand, iscommand, mark_as_command}") +@seealso{unmark_rawcommand, israwcommand, iscommand, mark_as_command}\n\ +@end deftypefn") { octave_value_list retval; @@ -347,8 +347,8 @@ Remove @var{name} from the list of raw input commands.\n\ Note that this does not remove @var{name} from the list of command style\n\ functions.\n\ -@end deftypefn\n\ -@seealso{mark_as_rawcommand, israwcommand, iscommand, unmark_command}") +@seealso{mark_as_rawcommand, israwcommand, iscommand, unmark_command}\n\ +@end deftypefn") { octave_value_list retval; @@ -406,8 +406,8 @@ Return true if @var{name} is a raw input command function.\n\ If @var{name} is omitted, return a list of identifiers which are marked as\n\ raw input commands with mark_as_rawcommand.\n\ -@end deftypefn\n\ -@seealso{mark_as_rawcommand, unmark_rawcommand}") +@seealso{mark_as_rawcommand, unmark_rawcommand}\n\ +@end deftypefn") { octave_value retval; @@ -1830,8 +1830,8 @@ @deftypefn {Built-in Function} {} mlock (@var{name})\n\ Lock the named function into memory. If no function is named\n\ then lock in the current function.\n\ -@end deftypefn\n\ -@seealso{munlock, mislocked, and persistent}") +@seealso{munlock, mislocked, persistent}\n\ +@end deftypefn") { octave_value_list retval; @@ -1862,8 +1862,8 @@ @deftypefn {Built-in Function} {} munlock (@var{fcn})\n\ Unlock the named function. If no function is named\n\ then unlock the current function.\n\ -@end deftypefn\n\ -@seealso{mlock, mislocked, and persistent}") +@seealso{mlock, mislocked, persistent}\n\ +@end deftypefn") { octave_value_list retval; @@ -1895,8 +1895,8 @@ @deftypefn {Built-in Function} {} mislocked (@var{fcn})\n\ Return true if the named function is locked. If no function is named\n\ then return true if the current function is locked.\n\ -@end deftypefn\n\ -@seealso{mlock, munlock, and persistent}") +@seealso{mlock, munlock, persistent}\n\ +@end deftypefn") { octave_value retval;