Mercurial > hg > octave-nkf
changeset 5053:c08cb1098afc
[project @ 2004-10-19 23:10:54 by jwe]
line wrap: on
line diff
--- a/scripts/audio/lin2mu.m +++ b/scripts/audio/lin2mu.m @@ -25,6 +25,7 @@ ## If @var{n} is not specified it defaults to 0, 8 or 16 depending on ## the range values in @var{x}. ## @end deftypefn +## ## @seealso{mu2lin, loadaudio, saveaudio, playaudio, setaudio, and record} ## Author: Andreas Weingessel <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/audio/loadaudio.m +++ b/scripts/audio/loadaudio.m @@ -30,6 +30,7 @@ ## The argument @var{bps} can be either 8 (default) or 16, and specifies ## the number of bits per sample used in the audio file. ## @end deftypefn +## ## @seealso{lin2mu, mu2lin, saveaudio, playaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/audio/mu2lin.m +++ b/scripts/audio/mu2lin.m @@ -24,6 +24,7 @@ ## 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. ## @end deftypefn +## ## @seealso{lin2mu, loadaudio, saveaudio, playaudio, setaudio, and record} ## Author: Andreas Weingessel <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/audio/playaudio.m +++ b/scripts/audio/playaudio.m @@ -23,6 +23,7 @@ ## Plays the audio file @file{@var{name}.@var{ext}} or the audio data ## stored in the vector @var{x}. ## @end deftypefn +## ## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/audio/record.m +++ b/scripts/audio/record.m @@ -24,6 +24,7 @@ ## 8kHz. The program waits until the user types @key{RET} and then ## immediately starts to record. ## @end deftypefn +## ## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, playaudio, and setaudio} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/audio/saveaudio.m +++ b/scripts/audio/saveaudio.m @@ -25,6 +25,7 @@ ## in the audio file (see @code{loadaudio}); defaults are @file{lin} and ## 8, respectively. ## @end deftypefn +## ## @seealso{lin2mu, mu2lin, loadaudio, playaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/control/base/DEMOcontrol.m +++ b/scripts/control/base/DEMOcontrol.m @@ -38,6 +38,7 @@ ## 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}
--- a/scripts/control/base/__stepimp__.m +++ b/scripts/control/base/__stepimp__.m @@ -28,6 +28,7 @@ ## Used internally in @command{impulse}, @command{step}. Use @command{step} ## or @command{impulse} instead. ## @end deftypefn +## ## @seealso{step, impulse} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de>
--- a/scripts/control/base/are.m +++ b/scripts/control/base/are.m @@ -61,6 +61,7 @@ ## matrix. ## ## @end deftypefn +## ## @seealso{balance and dare} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/control/base/controldemo.m +++ b/scripts/control/base/controldemo.m @@ -20,6 +20,7 @@ ## @deftypefn {Function File} {} controldemo () ## Control Systems Toolbox demo. ## @end deftypefn +## ## @seealso{Demo programs: bddemo, frdemo, analdemo, moddmeo, rldemo} ## Author: David Clem
--- a/scripts/control/base/damp.m +++ b/scripts/control/base/damp.m @@ -25,6 +25,7 @@ ## If @var{p} is a matrix and @var{tsam} is specified, eigenvalues ## of @var{p} are assumed to be in @var{z}-domain. ## @end deftypefn +## ## @seealso{eig} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de>
--- a/scripts/control/base/dare.m +++ b/scripts/control/base/dare.m @@ -71,6 +71,7 @@ ## Systems, Vol 5, no 2 (1992), pp 165--194. ## ## @end deftypefn +## ## @seealso{balance and are} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/control/base/impulse.m +++ b/scripts/control/base/impulse.m @@ -46,6 +46,7 @@ ## Times of the impulse response. ## @end table ## @end deftypefn +## ## @seealso{step, __stepimp__} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de>
--- a/scripts/control/base/lqg.m +++ b/scripts/control/base/lqg.m @@ -61,6 +61,7 @@ ## Controller poles. ## @end table ## @end deftypefn +## ## @seealso{h2syn, lqe, and lqr} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/control/base/step.m +++ b/scripts/control/base/step.m @@ -48,6 +48,7 @@ ## ## When invoked with the output parameter @var{y} the plot is not displayed. ## @end deftypefn +## ## @seealso{impulse and __stepimp__} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de>
--- a/scripts/control/system/abcddim.m +++ b/scripts/control/system/abcddim.m @@ -59,6 +59,7 @@ ## Note: n = 0 (pure gain block) is returned without warning. ## ## @end deftypefn +## ## @seealso{is_abcd} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/control/system/is_abcd.m +++ b/scripts/control/system/is_abcd.m @@ -23,6 +23,7 @@ ## appropriate diagnostic message printed to the screen. The matrices ## @var{b}, @var{c}, or @var{d} may be omitted. ## @end deftypefn +## ## @seealso{abcddim} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de>
--- a/scripts/control/system/is_controllable.m +++ b/scripts/control/system/is_controllable.m @@ -53,6 +53,7 @@ ## has a single input; otherwise a block Arnoldi iteration is performed ## with @code{krylovb}. ## @end deftypefn +## ## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector ## is_observable, is_stabilizable, is_detectable, krylov, and krylovb}
--- a/scripts/control/system/is_detectable.m +++ b/scripts/control/system/is_detectable.m @@ -30,6 +30,7 @@ ## ## ## @end deftypefn +## ## @seealso{is_stabilizable, size, rows, columns, length, ismatrix, ## isscalar, and isvector}
--- a/scripts/control/system/is_observable.m +++ b/scripts/control/system/is_observable.m @@ -29,6 +29,7 @@ ## See @command{is_controllable} for detailed description of arguments ## and default values. ## @end deftypefn +## ## @seealso{size, rows, columns, length, ismatrix, isscalar, and isvector} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/control/system/is_stabilizable.m +++ b/scripts/control/system/is_stabilizable.m @@ -35,6 +35,7 @@ ## @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}
--- a/scripts/control/system/is_stable.m +++ b/scripts/control/system/is_stable.m @@ -37,6 +37,7 @@ ## @end table ## @end table ## @end deftypefn +## ## @seealso{size, rows, columns, length, ismatrix, isscalar, isvector ## is_observable, is_stabilizable, is_detectable, krylov, and krylovb}
--- a/scripts/control/system/jet707.m +++ b/scripts/control/system/jet707.m @@ -35,6 +35,7 @@ ## ## @strong{Reference}: R. Brockhaus: @cite{Flugregelung} (Flight Control), Springer, 1994. ## @end deftypefn +## ## @seealso{ord2} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de>
--- a/scripts/control/system/sys2fir.m +++ b/scripts/control/system/sys2fir.m @@ -22,6 +22,7 @@ ## Extract @acronym{FIR} data from system data structure; see @command{fir2sys} for ## parameter descriptions. ## @end deftypefn +## ## @seealso{fir2sys} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/control/system/sysdimensions.m +++ b/scripts/control/system/sysdimensions.m @@ -63,6 +63,7 @@ ## @math{yd(ii) = 0} if output @var{ii} is continous ## @end table ## @end deftypefn +## ## @seealso{sysgetsignals and sysgettsam} function [n, nz, m, p, yd] = sysdimensions (sys, opt)
--- a/scripts/control/system/sysupdate.m +++ b/scripts/control/system/sysupdate.m @@ -48,6 +48,7 @@ ## Conversion to @command{tf} or @command{zp} exits with an error if the system is ## mixed continuous/digital. ## @end deftypefn +## ## @seealso{tf, ss, zp, sysout, sys2ss, sys2tf, and sys2zp} ## Author: John Ingram <ingraje@eng.auburn.edu>
--- a/scripts/control/system/tfout.m +++ b/scripts/control/system/tfout.m @@ -21,6 +21,7 @@ ## Print formatted transfer function @math{n(s)/d(s)} to the screen. ## @var{x} defaults to the string @code{"s"} ## @end deftypefn +## ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, ## filter, polyderiv, polyinteg, and polyout}
--- a/scripts/control/system/ugain.m +++ b/scripts/control/system/ugain.m @@ -24,6 +24,7 @@ ## Watch out if you are forming sampled systems since @command{ugain} ## does not contain a sampling period. ## @end deftypefn +## ## @seealso{hinfdemo and jet707} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de>
--- a/scripts/control/system/zpout.m +++ b/scripts/control/system/zpout.m @@ -21,6 +21,7 @@ ## print formatted zero-pole form to the screen. ## @var{x} defaults to the string @code{"s"} ## @end deftypefn +## ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, ## filter, polyderiv, polyinteg, and polyout}
--- a/scripts/elfun/lcm.m +++ b/scripts/elfun/lcm.m @@ -32,9 +32,10 @@ ## @example ## lcm ([a1, ..., ak]). ## @end example +## +## All elements must be the same size or scalar. ## @end deftypefn ## -## All elements must be the same size or scalar. ## @seealso{gcd, min, max, ceil, and floor} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/finance/irr.m +++ b/scripts/finance/irr.m @@ -24,6 +24,7 @@ ## @code{npv (r, p) = i}. If the second argument is omitted, a value of ## 0 is used. ## @end deftypefn +## ## @seealso{npv, pv, and rate} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/finance/nper.m +++ b/scripts/finance/nper.m @@ -32,6 +32,7 @@ ## Note that the rate @var{r} is specified as a fraction (i.e., 0.05, ## not 5 percent). ## @end deftypefn +## ## @seealso{pv, pmt, rate, and npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/finance/npv.m +++ b/scripts/finance/npv.m @@ -31,6 +31,7 @@ ## Note that the rate @var{r} is specified as a fraction (i.e., 0.05, ## not 5 percent). ## @end deftypefn +## ## @seealso{irr and pv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/finance/pmt.m +++ b/scripts/finance/pmt.m @@ -29,6 +29,7 @@ ## payments are made at the end (@var{"e"}, default) or at the beginning ## (@var{"b"}) of each period. ## @end deftypefn +## ## @seealso{pv, nper, and rate} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/finance/pv.m +++ b/scripts/finance/pv.m @@ -32,6 +32,7 @@ ## Note that the rate @var{r} is specified as a fraction (i.e., 0.05, ## not 5 percent). ## @end deftypefn +## ## @seealso{pmt, nper, rate, and npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/finance/rate.m +++ b/scripts/finance/rate.m @@ -29,6 +29,7 @@ ## whether payments are made at the end (@code{"e"}, default) or at the ## beginning (@code{"b"}) of each period. ## @end deftypefn +## ## @seealso{pv, pmt, nper, and npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/general/bitcmp.m +++ b/scripts/general/bitcmp.m @@ -27,9 +27,9 @@ ## dec2bin(bitcmp(11)) ## @result{} 11111111111111111111111111110100 ## @end example +## @end deftypefn ## ## @seealso{bitand,bitor,bitxor,bitset,bitget,bitcmp,bitshift,bitmax} -## @end deftypefn ## Liberally based of the version by Kai Habel from octave-forge
--- a/scripts/general/bitget.m +++ b/scripts/general/bitget.m @@ -23,8 +23,9 @@ ## bitget (100, 8:-1:1) ## @result{} 0 1 1 0 0 1 0 0 ## @end example +## @end deftypefn +## ## @seealso{bitand, bitor, bitxor, bitset, bitcmp, bitshift, bitmax} -## @end deftypefn ## Liberally based of the version by Kai Habel from octave-forge
--- a/scripts/general/bitset.m +++ b/scripts/general/bitset.m @@ -25,9 +25,9 @@ ## dec2bin (bitset (10, 1)) ## @result{} 1011 ## @end example +## @end deftypefn ## ## @seealso{bitand, bitor, bitxor, bitget, bitcmp, bitshift, bitmax} -## @end deftypefn ## Liberally based of the version by Kai Habel from octave-forge
--- a/scripts/general/cart2pol.m +++ b/scripts/general/cart2pol.m @@ -25,6 +25,7 @@ ## @var{theta} describes the angle relative to the x - axis. ## @var{r} is the distance to the z - axis (0, 0, z). ## @end deftypefn +## ## @seealso{pol2cart, cart2sph, sph2cart} ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/general/cart2sph.m +++ b/scripts/general/cart2sph.m @@ -25,6 +25,7 @@ ## @var{phi} is the angle relative to the xy - plane. ## @var{r} is the distance to the origin (0, 0, 0). ## @end deftypefn +## ## @seealso{pol2cart, cart2pol, sph2cart} ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/general/circshift.m +++ b/scripts/general/circshift.m @@ -44,6 +44,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso {permute, ipermute, shiftdim} function y = circshift (x, n)
--- a/scripts/general/columns.m +++ b/scripts/general/columns.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} columns (@var{a}) ## Return the number of columns of @var{a}. ## @end deftypefn +## ## @seealso{size, rows, length, isscalar, isvector, and ismatrix} ## Author: jwe
--- a/scripts/general/flipdim.m +++ b/scripts/general/flipdim.m @@ -30,6 +30,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso{fliplr, flipud, rot90 and rotdim} ## Author: David Bateman
--- a/scripts/general/fliplr.m +++ b/scripts/general/fliplr.m @@ -29,11 +29,11 @@ ## 4 3 ## @end group ## @end example +## +## Note that @code{fliplr} only workw with 2-D arrays. To flip N-d arrays +## use @code{flipdim} instead. ## @end deftypefn ## -## Due to the difficult of define which axis about which to flip the -## matrix @code{fliplr} only work with 2-D arrays. To flip N-D arrays -## use @code{flipdim} instead. ## @seealso{flipud, flipdim, rot90 and rotdim} ## Author: jwe
--- a/scripts/general/flipud.m +++ b/scripts/general/flipud.m @@ -34,6 +34,7 @@ ## matrix @code{flipud} only work with 2-d arrays. To flip N-d arrays ## use @code{flipdim} instead. ## @end deftypefn +## ## @seealso{fliplr, flipdim, rot90 and rotdim} ## Author: jwe
--- a/scripts/general/ind2sub.m +++ b/scripts/general/ind2sub.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {[@var{s1}, @var{s2}, @dots{}, @var{sN}] =} ind2sub (@var{dims}, @var{ind}) ## Convert a linear index into subscripts. ## @end deftypefn +## ## @seealso{sub2ind} ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/general/int2str.m +++ b/scripts/general/int2str.m @@ -25,6 +25,7 @@ ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). ## @end deftypefn +## ## @seealso{sprintf and num2str} ## Author: jwe
--- a/scripts/general/isdefinite.m +++ b/scripts/general/isdefinite.m @@ -24,6 +24,7 @@ ## positive semidefinite. Otherwise, return -1. If @var{tol} ## is omitted, use a tolerance equal to 100 times the machine precision. ## @end deftypefn +## ## @seealso{issymmetric} ## Author: Gabriele Pannocchia <g.pannocchia@ing.unipi.it>
--- a/scripts/general/isscalar.m +++ b/scripts/general/isscalar.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} isscalar (@var{a}) ## Return 1 if @var{a} is a scalar. Otherwise, return 0. ## @end deftypefn +## ## @seealso{size, rows, columns, length, isscalar, and ismatrix} ## Author: jwe
--- a/scripts/general/issquare.m +++ b/scripts/general/issquare.m @@ -22,6 +22,7 @@ ## If @var{x} is a square matrix, then return the dimension of @var{x}. ## Otherwise, return 0. ## @end deftypefn +## ## @seealso{size, rows, columns, length, ismatrix, isscalar, and isvector} ## Author: A. S. Hodel <scotte@eng.auburn.edu>
--- a/scripts/general/issymmetric.m +++ b/scripts/general/issymmetric.m @@ -23,6 +23,7 @@ ## then return the dimension of @var{x}. Otherwise, return 0. If ## @var{tol} is omitted, use a tolerance equal to the machine precision. ## @end deftypefn +## ## @seealso{size, rows, columns, length, ismatrix, isscalar, ## issquare, and isvector}
--- a/scripts/general/isvector.m +++ b/scripts/general/isvector.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} isvector (@var{a}) ## Return 1 if @var{a} is a vector. Otherwise, return 0. ## @end deftypefn +## ## @seealso{size, rows, columns, length, isscalar, and ismatrix} ## Author: jwe
--- a/scripts/general/logspace.m +++ b/scripts/general/logspace.m @@ -59,6 +59,7 @@ ## @end ifinfo ## in order to be compatible with the corresponding @sc{Matlab} function. ## @end deftypefn +## ## @seealso{linspace} ## Author: jwe
--- a/scripts/general/mod.m +++ b/scripts/general/mod.m @@ -32,6 +32,7 @@ ## An error message is printed if the dimensions of the arguments do not ## agree, or if either of the arguments is complex. ## @end deftypefn +## ## @seealso{rem, round} ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/general/nextpow2.m +++ b/scripts/general/nextpow2.m @@ -31,6 +31,7 @@ ## ## If @var{x} is a vector, return @code{nextpow2 (length (@var{x}))}. ## @end deftypefn +## ## @seealso{pow2} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/general/num2str.m +++ b/scripts/general/num2str.m @@ -25,6 +25,7 @@ ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). ## @end deftypefn +## ## @seealso{sprintf and int2str} ## Author: jwe
--- a/scripts/general/perror.m +++ b/scripts/general/perror.m @@ -24,6 +24,7 @@ ## useful error messages for those functions that return numeric error ## codes. ## @end deftypefn +## ## @seealso{strerror} ## Author: jwe
--- a/scripts/general/pol2cart.m +++ b/scripts/general/pol2cart.m @@ -25,6 +25,7 @@ ## @var{theta} describes the angle relative to the x - axis. ## @var{r} is the distance to the z - axis (0, 0, z). ## @end deftypefn +## ## @seealso{cart2pol, cart2sph, sph2cart} ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/general/rem.m +++ b/scripts/general/rem.m @@ -29,6 +29,7 @@ ## An error message is printed if the dimensions of the arguments do not ## agree, or if either of the arguments is complex. ## @end deftypefn +## ## @seealso{mod, round} ## Author: jwe
--- a/scripts/general/rot90.m +++ b/scripts/general/rot90.m @@ -51,6 +51,7 @@ ## matrix @code{rot90} only work with 2-D arrays. To rotate N-d arrays ## use @code{rotdim} instead. ## @end deftypefn +## ## @seealso{rotdim, flipud, fliplr and flipdim} ## Author: jwe
--- a/scripts/general/rotdim.m +++ b/scripts/general/rotdim.m @@ -52,6 +52,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso{rot90, flipud, fliplr and flipdim} function y = rotdim (x, k, plane)
--- a/scripts/general/rows.m +++ b/scripts/general/rows.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} rows (@var{a}) ## Return the number of rows of @var{a}. ## @end deftypefn +## ## @seealso{size, columns, length, isscalar, isvector, and ismatrix} ## Author: jwe
--- a/scripts/general/shiftdim.m +++ b/scripts/general/shiftdim.m @@ -46,6 +46,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso {reshape, permute, ipermute, circshift, squeeze} function [y, ns] = shiftdim (x, n)
--- a/scripts/general/sph2cart.m +++ b/scripts/general/sph2cart.m @@ -25,6 +25,7 @@ ## @var{phi} is the angle relative to the xy-plane. ## @var{r} is the distance to the origin (0, 0, 0). ## @end deftypefn +## ## @seealso{pol2cart, cart2pol, cart2sph} ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/general/sub2ind.m +++ b/scripts/general/sub2ind.m @@ -22,6 +22,7 @@ ## @deftypefnx {Function File} {@var{ind} =} sub2ind (@var{dims}, @var{s1}, @var{s2}, @dots{}, @var{sN}) ## Convert subscripts into a linear index. ## @end deftypefn +## ## @seealso{ind2sub} ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
--- a/scripts/general/tril.m +++ b/scripts/general/tril.m @@ -60,6 +60,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso{triu and diag} ## Author: jwe
--- a/scripts/image/hsv2rgb.m +++ b/scripts/image/hsv2rgb.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} @var{rgb_map} = hsv2rgb (@var{hsv_map}) ## Transform a colormap from the hsv space to the rgb space. ## @end deftypefn +## ## @seealso{rgb2hsv} ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/image/image.m +++ b/scripts/image/image.m @@ -31,6 +31,7 @@ ## The axis values corresponding to the matrix elements are specified in ## @var{x} and @var{y}. At present they are ignored. ## @end deftypefn +## ## @seealso{imshow, imagesc, and colormap} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/image/imagesc.m +++ b/scripts/image/imagesc.m @@ -35,6 +35,7 @@ ## values for the respective axes, or as values for each row and column ## of the matrix @var{A}. At present they are ignored. ## @end deftypefn +## ## @seealso{image and imshow} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/image/ind2gray.m +++ b/scripts/image/ind2gray.m @@ -23,6 +23,7 @@ ## If @var{map} is omitted, the current colormap is used to determine the ## intensities. ## @end deftypefn +## ## @seealso{gray2ind, rgb2ntsc, image, and colormap} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/image/ind2rgb.m +++ b/scripts/image/ind2rgb.m @@ -22,6 +22,7 @@ ## Convert an indexed image to red, green, and blue color components. ## If @var{map} is omitted, the current colormap is used for the conversion. ## @end deftypefn +## ## @seealso{rgb2ind, image, imshow, ind2gray, and gray2ind} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/image/loadimage.m +++ b/scripts/image/loadimage.m @@ -22,6 +22,7 @@ ## 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. ## @end deftypefn +## ## @seealso{saveimage, load, and save} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/image/rgb2hsv.m +++ b/scripts/image/rgb2hsv.m @@ -28,6 +28,7 @@ ## Hue describes the dominant wavelegth. ## Saturation is the amount of Hue mixed into the color. ## @end deftypefn +## ## @seealso{hsv2rgb} ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/image/rgb2ind.m +++ b/scripts/image/rgb2ind.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {[@var{x}, @var{map}] =} rgb2ind (@var{r}, @var{g}, @var{b}) ## Convert and RGB image to an Octave indexed image. ## @end deftypefn +## ## @seealso{ind2rgb and rgb2ntsc} ## Bugs: The color map may have duplicate entries.
--- a/scripts/image/saveimage.m +++ b/scripts/image/saveimage.m @@ -43,6 +43,8 @@ ## are equal) the gray scale ppm and PostScript image formats are used, ## otherwise the full color formats are used. ## @end deftypefn +## +## @seealso{loadimage, save, load, and colormap} ## The conversion to PostScript is based on pbmtolps.c, which was ## written by @@ -52,7 +54,6 @@ ## University of British Columbia ## ## and is part of the portable bitmap utilities, -## @seealso{loadimage, save, load, and colormap} ## Author: Tony Richardson <arichard@stark.cc.oh.us> ## Created: July 1994
--- a/scripts/io/beep.m +++ b/scripts/io/beep.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} puts (@var{string}) ## Produce a beep from the speaker (or visual bell). ## @end deftypefn +## ## @seealso{puts, fputs, printf and fprintf} ## Author: jwe
--- a/scripts/linear-algebra/cond.m +++ b/scripts/linear-algebra/cond.m @@ -23,6 +23,7 @@ ## defined as @code{norm (a) * norm (inv (a))}, and is computed via a ## singular value decomposition. ## @end deftypefn +## ## @seealso{norm, svd, and rank} ## Author: jwe
--- a/scripts/linear-algebra/norm.m +++ b/scripts/linear-algebra/norm.m @@ -53,6 +53,7 @@ ## p-norm of @var{a}, @code{(sum (abs (@var{a}) .^ @var{p})) ^ (1/@var{p})}. ## @end table ## @end deftypefn +## ## @seealso{cond and svd} ## Author: jwe
--- a/scripts/miscellaneous/comma.m +++ b/scripts/miscellaneous/comma.m @@ -21,4 +21,5 @@ ## @deffn {Operator} , ## Array index, function argument, or command separator. ## @end deffn +## ## @seealso{semicolon}
--- a/scripts/miscellaneous/dir.m +++ b/scripts/miscellaneous/dir.m @@ -40,6 +40,7 @@ ## named file. ## @var{filename}. ## @end deftypefn +## ## @seealso{stat} ## Author: jwe
--- a/scripts/miscellaneous/etime.m +++ b/scripts/miscellaneous/etime.m @@ -32,6 +32,7 @@ ## will set the variable @code{elapsed_time} to the number of seconds since ## the variable @code{t0} was set. ## @end deftypefn +## ## @seealso{tic, toc, clock, and cputime} ## Author: jwe
--- a/scripts/miscellaneous/menu.m +++ b/scripts/miscellaneous/menu.m @@ -26,6 +26,7 @@ ## in, but it may be confusing to present more than will fit easily on one ## screen. ## @end deftypefn +## ## @seealso{disp, printf, and input} ## Author: jwe
--- a/scripts/miscellaneous/semicolon.m +++ b/scripts/miscellaneous/semicolon.m @@ -21,4 +21,5 @@ ## @deffn {Operator} ; ## Array row or command separator. ## @end deffn +## ## @seealso{comma}
--- a/scripts/miscellaneous/texas_lotto.m +++ b/scripts/miscellaneous/texas_lotto.m @@ -22,6 +22,7 @@ ## Pick 6 unique numbers between 1 and 50 that are guaranteed to win ## the Texas Lotto. ## @end deftypefn +## ## @seealso{rand} ## Author: jwe
--- a/scripts/miscellaneous/unix.m +++ b/scripts/miscellaneous/unix.m @@ -26,6 +26,7 @@ ## @var{text}. If the optional second argument @code{"-echo"} is given, ## then also send the output from the command to the standard output. ## @end deftypefn +## ## @seealso{isunix, ispc, system} ## Author: octave-forge ???
--- a/scripts/plot/__errcomm__.m +++ b/scripts/plot/__errcomm__.m @@ -23,6 +23,7 @@ ## semilogyerr, semilogxerr). ## ## @end deftypefn +## ## @seealso{errorbar, semilogxerr, semilogyerr, loglogerr, __pltopt__} ## Created: 20.02.2001
--- a/scripts/plot/__errplot__.m +++ b/scripts/plot/__errplot__.m @@ -26,6 +26,7 @@ ## @end example ## ## @end deftypefn +## ## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ ## bar, stairs, errorbar, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/__pltopt1__.m +++ b/scripts/plot/__pltopt1__.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} __pltopt1__ (@var{caller}, @var{opt}) ## Really decode plot option strings. ## @end deftypefn +## ## @seealso{__pltopt__} ## Author: Rick Niles <niles@axp745.gsfc.nasa.gov>
--- a/scripts/plot/__pltopt__.m +++ b/scripts/plot/__pltopt__.m @@ -104,6 +104,7 @@ ## 6 brown yellow dot short dash "*" "o" ## @end example ## @end deftypefn +## ## @seealso{__pltopt1__} ## Author: jwe
--- a/scripts/plot/bar.m +++ b/scripts/plot/bar.m @@ -42,6 +42,7 @@ ## @noindent ## are equivalent. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/contour.m +++ b/scripts/plot/contour.m @@ -24,6 +24,7 @@ ## @var{z}. Someone needs to improve @code{gnuplot}'s contour routines ## before this will be very useful. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/errorbar.m +++ b/scripts/plot/errorbar.m @@ -103,6 +103,7 @@ ## from @var{y}-@var{ly} to @var{y}+@var{uy}. ## ## @end deftypefn +## ## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__, ## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/grid.m +++ b/scripts/plot/grid.m @@ -23,6 +23,7 @@ ## The argument may be either @code{"on"} or @code{"off"}. If it is ## omitted, @code{"on"} is assumed. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/hist.m +++ b/scripts/plot/hist.m @@ -39,6 +39,7 @@ ## With two output arguments, produce the values @var{nn} and @var{xx} such ## that @code{bar (@var{xx}, @var{nn})} will plot the histogram. ## @end deftypefn +## ## @seealso{bar} ## Author: jwe
--- a/scripts/plot/loglog.m +++ b/scripts/plot/loglog.m @@ -23,6 +23,7 @@ ## description of @code{plot} for a description of the arguments that ## @code{loglog} will accept. ## @end deftypefn +## ## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, ## gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/loglogerr.m +++ b/scripts/plot/loglogerr.m @@ -34,6 +34,7 @@ ## additional information. ## ## @end deftypefn +## ## @seealso{errorbar, semilogxerr, semilogyerr, polar, mesh, contour, ## __pltopt__, bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/mesh.m +++ b/scripts/plot/mesh.m @@ -26,6 +26,7 @@ ## correspond to different @var{x} values and rows of @var{z} correspond ## to different @var{y} values. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, meshgrid, meshdom, ## contour, bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/meshgrid.m +++ b/scripts/plot/meshgrid.m @@ -24,6 +24,7 @@ ## to the @var{x} and @var{y} coordinates of a mesh. The rows of @var{xx} are copies of @var{x}, ## and the columns of @var{yy} are copies of @var{y}. ## @end deftypefn +## ## @seealso{sombrero, plot, semilogx, semilogy, loglog, polar, mesh, meshdom, contour, ## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/plot.m +++ b/scripts/plot/plot.m @@ -163,6 +163,7 @@ ## This will plot the cosine and sine functions and label them accordingly ## in the key. ## @end deftypefn +## ## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ ## bar, stairs, errorbar, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/polar.m +++ b/scripts/plot/polar.m @@ -24,6 +24,7 @@ ## ## The optional third argument specifies the line type. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, mesh, contour, bar, ## stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/semilogx.m +++ b/scripts/plot/semilogx.m @@ -23,6 +23,7 @@ ## the description of @code{plot} for a description of the arguments ## that @code{semilogx} will accept. ## @end deftypefn +## ## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, ## gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/semilogxerr.m +++ b/scripts/plot/semilogxerr.m @@ -34,6 +34,7 @@ ## additional information. ## ## @end deftypefn +## ## @seealso{errorbar, loglogerr semilogyerr, polar, mesh, contour, __pltopt__, ## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/semilogy.m +++ b/scripts/plot/semilogy.m @@ -23,6 +23,7 @@ ## the description of @code{plot} for a description of the arguments ## that @code{semilogy} will accept. ## @end deftypefn +## ## @seealso{plot, semilogx, loglog, polar, mesh, contour, bar, stairs, ## gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/semilogyerr.m +++ b/scripts/plot/semilogyerr.m @@ -34,6 +34,7 @@ ## additional information. ## ## @end deftypefn +## ## @seealso{errorbar, loglogerr semilogxerr, polar, mesh, contour, __pltopt__, ## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/shg.m +++ b/scripts/plot/shg.m @@ -24,6 +24,7 @@ ## replot without any arguments. ## ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, stairs, gplot, gsplot, replot, xlabel, and ylabel}
--- a/scripts/plot/stairs.m +++ b/scripts/plot/stairs.m @@ -42,6 +42,7 @@ ## @noindent ## are equivalent. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, gplot, gsplot, replot, xlabel, ylabel, and title}
--- a/scripts/plot/title.m +++ b/scripts/plot/title.m @@ -22,6 +22,7 @@ ## Specify a title for a plot. If you already have a plot displayed, use ## the command @code{replot} to redisplay it with the new title. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, stairs, gplot, gsplot, replot, xlabel, and ylabel}
--- a/scripts/plot/xlabel.m +++ b/scripts/plot/xlabel.m @@ -25,6 +25,7 @@ ## displayed, use the command @code{replot} to redisplay it with the new ## labels. ## @end deftypefn +## ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, stairs, gplot, gsplot, replot, ylabel, and title}
--- a/scripts/polynomial/compan.m +++ b/scripts/polynomial/compan.m @@ -52,6 +52,7 @@ ## The eigenvalues of the companion matrix are equal to the roots of the ## polynomial. ## @end deftypefn +## ## @seealso{poly, roots, residue, conv, deconv, polyval, polyderiv, and ## polyinteg}
--- a/scripts/polynomial/conv.m +++ b/scripts/polynomial/conv.m @@ -26,6 +26,7 @@ ## If @var{a} and @var{b} are polynomial coefficient vectors, @code{conv} ## returns the coefficients of the product polynomial. ## @end deftypefn +## ## @seealso{deconv, poly, roots, residue, polyval, polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/polynomial/deconv.m +++ b/scripts/polynomial/deconv.m @@ -28,6 +28,7 @@ ## contain the coefficients of the polynomial quotient and @var{r} will be ## a remander polynomial of lowest order. ## @end deftypefn +## ## @seealso{conv, poly, roots, residue, polyval, polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/polynomial/polyderiv.m +++ b/scripts/polynomial/polyderiv.m @@ -22,6 +22,7 @@ ## Return the coefficients of the derivative of the polynomial whose ## coefficients are given by vector @var{c}. ## @end deftypefn +## ## @seealso{poly, polyinteg, polyreduce, roots, conv, deconv, residue, ## filter, polyval, and polyvalm}
--- a/scripts/polynomial/polyinteg.m +++ b/scripts/polynomial/polyinteg.m @@ -24,6 +24,7 @@ ## ## The constant of integration is set to zero. ## @end deftypefn +## ## @seealso{poly, polyderiv, polyreduce, roots, conv, deconv, residue, ## filter, polyval, and polyvalm}
--- a/scripts/polynomial/polyout.m +++ b/scripts/polynomial/polyout.m @@ -33,6 +33,7 @@ ## @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}
--- a/scripts/polynomial/polyreduce.m +++ b/scripts/polynomial/polyreduce.m @@ -22,6 +22,7 @@ ## Reduces a polynomial coefficient vector to a minimum number of terms by ## stripping off any leading zeros. ## @end deftypefn +## ## @seealso{poly, roots, conv, deconv, residue, filter, polyval, ## polyvalm, polyderiv, and polyinteg}
--- a/scripts/polynomial/polyval.m +++ b/scripts/polynomial/polyval.m @@ -27,6 +27,7 @@ ## If @var{x} is a vector or matrix, the polynomial is evaluated at each of ## the elements of @var{x}. ## @end deftypefn +## ## @seealso{polyvalm, poly, roots, conv, deconv, residue, filter, ## polyderiv, and polyinteg}
--- a/scripts/polynomial/polyvalm.m +++ b/scripts/polynomial/polyvalm.m @@ -27,6 +27,7 @@ ## ## The argument @var{x} must be a square matrix. ## @end deftypefn +## ## @seealso{polyval, poly, roots, conv, deconv, residue, filter, ## polyderiv, and polyinteg}
--- a/scripts/polynomial/residue.m +++ b/scripts/polynomial/residue.m @@ -100,6 +100,7 @@ ## @end example ## @end ifinfo ## @end deftypefn +## ## @seealso{poly, roots, conv, deconv, polyval, polyderiv, and polyinteg} ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/set/complement.m +++ b/scripts/set/complement.m @@ -29,6 +29,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso{create_set, union, and intersection} ## Author: jwe
--- a/scripts/set/create_set.m +++ b/scripts/set/create_set.m @@ -29,6 +29,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso{union, intersection, and complement} ## Author: jwe
--- a/scripts/set/intersection.m +++ b/scripts/set/intersection.m @@ -29,6 +29,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso{create_set, union, and complement} ## Author: jwe
--- a/scripts/set/union.m +++ b/scripts/set/union.m @@ -29,6 +29,7 @@ ## @end group ## @end example ## @end deftypefn +## ## @seealso{create_set, intersection, and complement} ## Author: jwe
--- a/scripts/specfun/erfinv.m +++ b/scripts/specfun/erfinv.m @@ -21,6 +21,7 @@ ## @deftypefn {Mapping Function} {} erfinv (@var{z}) ## Computes the inverse of the error function. ## @end deftypefn +## ## @seealso{erf and erfc} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
--- a/scripts/specfun/log2.m +++ b/scripts/specfun/log2.m @@ -31,6 +31,7 @@ ## 1/2 <= abs(f) < 1 and x = f * 2^e. ## @end ifinfo ## @end deftypefn +## ## @seealso{log, log10, logspace, and exp} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/specfun/pow2.m +++ b/scripts/specfun/pow2.m @@ -39,6 +39,7 @@ ## f .* (2 .^ e). ## @end ifinfo ## @end deftypefn +## ## @seealso{nextpow2} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
--- a/scripts/special-matrix/hankel.m +++ b/scripts/special-matrix/hankel.m @@ -44,6 +44,7 @@ ## @end example ## @end ifinfo ## @end deftypefn +## ## @seealso{vander, sylvester_matrix, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/hilb.m +++ b/scripts/special-matrix/hilb.m @@ -43,6 +43,7 @@ ## @end example ## @end ifinfo ## @end deftypefn +## ## @seealso{hankel, vander, sylvester_matrix, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/invhilb.m +++ b/scripts/special-matrix/invhilb.m @@ -63,6 +63,7 @@ ## finite precision of your computer's floating point arithmetic. ## ## @end deftypefn +## ## @seealso{hankel, vander, sylvester_matrix, hilb, and toeplitz} ## Author: Dirk Laurie <dirk@siegfried.wisk.sun.ac.za>
--- a/scripts/special-matrix/sylvester_matrix.m +++ b/scripts/special-matrix/sylvester_matrix.m @@ -29,6 +29,7 @@ ## n = 2^k. ## @end ifinfo ## @end deftypefn +## ## @seealso{hankel, vander, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/toeplitz.m +++ b/scripts/special-matrix/toeplitz.m @@ -52,6 +52,7 @@ ## @end example ## @end ifinfo ## @end deftypefn +## ## @seealso{hankel, vander, sylvester_matrix, hilb, and invhib} ## Author: jwe
--- a/scripts/special-matrix/vander.m +++ b/scripts/special-matrix/vander.m @@ -46,6 +46,7 @@ ## @end example ## @end ifinfo ## @end deftypefn +## ## @seealso{hankel, sylvester_matrix, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/statistics/base/median.m +++ b/scripts/statistics/base/median.m @@ -43,6 +43,7 @@ ## If @var{x} is a matrix, compute the median value for each ## column and return them in a row vector. ## @end deftypefn +## ## @seealso{std and mean} ## Author: jwe
--- a/scripts/statistics/base/std.m +++ b/scripts/statistics/base/std.m @@ -56,6 +56,7 @@ ## The third argument @var{dim} determines the dimension along which the standard ## deviation is calculated. ## @end deftypefn +## ## @seealso{mean and median} ## Author: jwe
--- a/scripts/strings/base2dec.m +++ b/scripts/strings/base2dec.m @@ -42,6 +42,7 @@ ## @end example ## ## @end deftypefn +## ## @seealso{dec2base, dec2bin, bin2dec, hex2dec, dec2hex} ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
--- a/scripts/strings/isletter.m +++ b/scripts/strings/isletter.m @@ -21,6 +21,7 @@ ## @deftypefn {Function File} {} isletter (@var{s}) ## Returns true if @var{s} is a letter false otherwise. ## @end deftypefn +## ## @seealso{isalpha} ## Author: jwe