Mercurial > hg > octave-nkf
changeset 15028:397f0d80bd47
Added many *seealso* to the help messages
author | Doug Stewart <doug.dastew@gmail.com> |
---|---|
date | Thu, 26 Jul 2012 17:59:30 -0400 |
parents | ae42d5a67ed9 |
children | 7aa103a1c8ae |
files | src/data.cc |
diffstat | 1 files changed, 52 insertions(+), 34 deletions(-) [+] |
line wrap: on
line diff
--- a/src/data.cc +++ b/src/data.cc @@ -214,6 +214,7 @@ Compute atan (@var{y} / @var{x}) for corresponding elements of @var{y}\n\ and @var{x}. Signal an error if @var{y} and @var{x} do not match in size\n\ and orientation.\n\ +@seealso{tan, tand, tanh, atanh}\n\ @end deftypefn") { octave_value retval; @@ -2370,6 +2371,7 @@ Return the \"length\" of the object @var{a}. For matrix objects, the\n\ length is the number of rows or columns, whichever is greater (this\n\ odd definition is used for compatibility with @sc{matlab}).\n\ +@seealso{size}\n\ @end deftypefn") { octave_value retval; @@ -2395,6 +2397,7 @@ @result{} 3\n\ @end group\n\ @end example\n\ +@seealso{size}\n\ @end deftypefn") { octave_value retval; @@ -2488,7 +2491,7 @@ \n\ @noindent\n\ returns the number of columns in the given matrix.\n\ -@seealso{numel}\n\ +@seealso{numel, ndims, length, rows, columns}\n\ @end deftypefn") { octave_value_list retval; @@ -2551,7 +2554,7 @@ Return true if the dimensions of all arguments agree.\n\ Trailing singleton dimensions are ignored.\n\ Called with a single or no argument, size_equal returns true.\n\ -@seealso{size, numel}\n\ +@seealso{size, numel, ndims}\n\ @end deftypefn") { octave_value retval; @@ -2583,7 +2586,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{scalar} =} nnz (@var{a})\n\ Return the number of non zero elements in @var{a}.\n\ -@seealso{sparse}\n\ +@seealso{sparse, nzmax}\n\ @end deftypefn") { octave_value retval; @@ -2604,7 +2607,7 @@ for sparse objects. There are some cases of user created sparse objects\n\ where the value returned by @dfn{nzmax} will not be the same as @dfn{nnz},\n\ but in general they will give the same result.\n\ -@seealso{sparse, spalloc}\n\ +@seealso{sparse, spalloc, nnz}\n\ @end deftypefn") { octave_value retval; @@ -2882,7 +2885,7 @@ \n\ @noindent\n\ but it uses less memory and avoids calling @code{conj} if @var{x} is real.\n\ -@seealso{sum}\n\ +@seealso{sum, prod}\n\ @end deftypefn") { DATA_REDUCTION (sumsq); @@ -2963,7 +2966,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} iscomplex (@var{x})\n\ Return true if @var{x} is a complex-valued numeric object.\n\ -@seealso{isreal, isnumeric}\n\ +@seealso{isreal, isnumeric, islogical, ischar, isfloat, isa}\n\ @end deftypefn") { octave_value retval; @@ -3013,7 +3016,7 @@ @result{} [ 1 + 3i 2 + 4i ]\n\ @end group\n\ @end example\n\ -@seealso{real, imag, iscomplex}\n\ +@seealso{real, imag, iscomplex, abs, arg}\n\ @end deftypefn") { octave_value retval; @@ -3292,7 +3295,7 @@ Return true if @var{x} is a non-complex matrix or scalar.\n\ For compatibility with @sc{matlab}, this includes logical and character\n\ matrices.\n\ -@seealso{iscomplex, isnumeric}\n\ +@seealso{iscomplex, isnumeric, isa}\n\ @end deftypefn") { octave_value retval; @@ -3310,7 +3313,7 @@ @deftypefn {Built-in Function} {} isempty (@var{a})\n\ Return true if @var{a} is an empty matrix (any one of its dimensions is\n\ zero). Otherwise, return false.\n\ -@seealso{isnull}\n\ +@seealso{isnull, isa}\n\ @end deftypefn") { octave_value retval = false; @@ -3329,7 +3332,7 @@ Return true if @var{x} is a numeric object, i.e., an integer, real, or\n\ complex array. Logical and character arrays are not considered to be\n\ numeric.\n\ -@seealso{isinteger, isfloat, isreal, iscomplex, islogical, ischar, iscell, isstruct}\n\ +@seealso{isinteger, isfloat, isreal, iscomplex, islogical, ischar, iscell, isstruct, isa}\n\ @end deftypefn") { octave_value retval; @@ -3365,7 +3368,7 @@ Scalars (1x1 matrices) and vectors (@nospell{1xN} or @nospell{Nx1} matrices)\n\ are subsets of the more general N-dimensional matrix and @code{ismatrix}\n\ will return true for these objects as well.\n\ -@seealso{isscalar, isvector, iscell, isstruct, issparse}\n\ +@seealso{isscalar, isvector, iscell, isstruct, issparse, isa}\n\ @end deftypefn") { octave_value retval = false; @@ -3947,7 +3950,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ -@seealso{isinf}\n\ +@seealso{isinf, nan}\n\ @end deftypefn") { return fill_matrix (args, lo_ieee_inf_value (), @@ -4006,7 +4009,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ -@seealso{isnan}\n\ +@seealso{isnan, inf}\n\ @end deftypefn") { return fill_matrix (args, lo_ieee_nan_value (), @@ -4055,6 +4058,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ +@seealso{log, exp, pi, i, j}\n\ @end deftypefn") { #if defined (M_E) @@ -4095,6 +4099,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ +@seealso{realmax, realmin, intmax, bitmax}\n\ @end deftypefn") { int nargin = args.length (); @@ -4210,6 +4215,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ +@seealso{e, i, j}\n\ @end deftypefn") { #if defined (M_PI) @@ -4248,7 +4254,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ -@seealso{realmin, intmax, bitmax}\n\ +@seealso{realmin, intmax, bitmax, eps}\n\ @end deftypefn") { return fill_matrix (args, DBL_MAX, FLT_MAX, "realmax"); @@ -4281,7 +4287,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ -@seealso{realmax, intmin}\n\ +@seealso{realmax, intmin, eps}\n\ @end deftypefn") { return fill_matrix (args, DBL_MIN, FLT_MIN, "realmin"); @@ -4307,6 +4313,7 @@ @ifnottex\n\ @code{sqrt (-1)}.\n\ @end ifnottex\n\ +\n\ I, and its equivalents i, J, and j, are functions so any of the names may\n\ be reused for other purposes (such as i for a counter variable).\n\ \n\ @@ -4549,7 +4556,7 @@ Calling @code{eye} with no arguments is equivalent to calling it\n\ with an argument of 1. Any negative dimensions are treated as zero. \n\ These odd definitions are for compatibility with @sc{matlab}.\n\ -@seealso{speye}\n\ +@seealso{speye, ones, zeros}\n\ @end deftypefn") { octave_value retval; @@ -4679,6 +4686,7 @@ \n\ For compatibility with @sc{matlab}, return the second argument (@var{limit})\n\ if fewer than two values are requested.\n\ +@seealso{logspace}\n\ @end deftypefn") { octave_value retval; @@ -4786,7 +4794,7 @@ An object can be resized to more dimensions than it has;\n\ in such case the missing dimensions are assumed to be 1.\n\ Resizing an object to fewer dimensions is not possible.\n\ -@seealso{reshape, postpad}\n\ +@seealso{reshape, postpad, prepad, cat}\n\ @end deftypefn") { octave_value retval; @@ -4861,7 +4869,7 @@ A single dimension of the return matrix may be left unspecified and Octave\n\ will determine its size automatically. An empty matrix ([]) is used to flag\n\ the unspecified dimension.\n\ -@seealso{resize}\n\ +@seealso{resize, vec, postpad, cat, squeeze}\n\ @end deftypefn") { octave_value retval; @@ -4979,7 +4987,7 @@ @code{@var{x}(:)}. If @var{dim} is supplied, the dimensions of @var{v}\n\ are set to @var{dim} with all elements along the last dimension.\n\ This is equivalent to @code{shiftdim (@var{x}(:), 1-@var{dim})}.\n\ -@seealso{vech}\n\ +@seealso{vech, resize, cat}\n\ @end deftypefn") { octave_value retval; @@ -5042,6 +5050,7 @@ Remove singleton dimensions from @var{x} and return the result.\n\ Note that for compatibility with @sc{matlab}, all objects have\n\ a minimum of two dimensions and row vectors are left unchanged.\n\ +@seealso{reshape}\n\ @end deftypefn") { octave_value retval; @@ -5281,6 +5290,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} uplus (@var{x})\n\ This function and @w{@xcode{+ x}} are equivalent.\n\ +@seealso{uminus, plus, minus}\n\ @end deftypefn") { return unary_op_defun_body (octave_value::op_uplus, args); @@ -5290,6 +5300,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} uminus (@var{x})\n\ This function and @w{@xcode{- x}} are equivalent.\n\ +@seealso{uplus, minus}\n\ @end deftypefn") { return unary_op_defun_body (octave_value::op_uminus, args); @@ -5413,7 +5424,7 @@ @end example\n\ \n\ At least one argument is required.\n\ -@seealso{minus}\n\ +@seealso{minus, uplus}\n\ @end deftypefn") { return binary_assoc_op_defun_body (octave_value::op_add, @@ -5424,7 +5435,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} minus (@var{x}, @var{y})\n\ This function and @w{@xcode{x - y}} are equivalent.\n\ -@seealso{plus}\n\ +@seealso{plus, uminus}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_sub, args); @@ -5444,7 +5455,7 @@ @end example\n\ \n\ At least one argument is required.\n\ -@seealso{times}\n\ +@seealso{times, plus, minus, rdivide, mrdivide, mldivide, mpower}\n\ @end deftypefn") { return binary_assoc_op_defun_body (octave_value::op_mul, @@ -5456,7 +5467,7 @@ @deftypefn {Built-in Function} {} mrdivide (@var{x}, @var{y})\n\ Return the matrix right division of @var{x} and @var{y}.\n\ This function and @w{@xcode{x / y}} are equivalent.\n\ -@seealso{mldivide, rdivide}\n\ +@seealso{mldivide, rdivide, plus, minus}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_div, args); @@ -5467,7 +5478,7 @@ @deftypefn {Built-in Function} {} mpower (@var{x}, @var{y})\n\ Return the matrix power operation of @var{x} raised to the @var{y} power.\n\ This function and @w{@xcode{x ^ y}} are equivalent.\n\ -@seealso{power}\n\ +@seealso{power, times, plus, minus}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_pow, args); @@ -5478,7 +5489,7 @@ @deftypefn {Built-in Function} {} mldivide (@var{x}, @var{y})\n\ Return the matrix left division of @var{x} and @var{y}.\n\ This function and @w{@xcode{x @xbackslashchar{} y}} are equivalent.\n\ -@seealso{mrdivide, ldivide}\n\ +@seealso{mrdivide, ldivide, rdivide}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_ldiv, args); @@ -5488,6 +5499,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} lt (@var{x}, @var{y})\n\ This function is equivalent to @w{@code{x < y}}.\n\ +@seealso{le, eq, ge, gt, ne}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_lt, args); @@ -5497,6 +5509,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} le (@var{x}, @var{y})\n\ This function is equivalent to @w{@code{x <= y}}.\n\ +@seealso{eq, ge, gt, ne, lt}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_le, args); @@ -5507,7 +5520,7 @@ @deftypefn {Built-in Function} {} eq (@var{x}, @var{y})\n\ Return true if the two inputs are equal.\n\ This function is equivalent to @w{@code{x == y}}.\n\ -@seealso{ne, isequal}\n\ +@seealso{ne, isequal, le, ge, gt, ne, lt}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_eq, args); @@ -5517,6 +5530,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} ge (@var{x}, @var{y})\n\ This function is equivalent to @w{@code{x >= y}}.\n\ +@seealso{le, eq, gt, ne, lt}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_ge, args); @@ -5526,6 +5540,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} gt (@var{x}, @var{y})\n\ This function is equivalent to @w{@code{x > y}}.\n\ +@seealso{le, eq, ge, ne, lt}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_gt, args); @@ -5536,7 +5551,7 @@ @deftypefn {Built-in Function} {} ne (@var{x}, @var{y})\n\ Return true if the two inputs are not equal.\n\ This function is equivalent to @w{@code{x != y}}.\n\ -@seealso{eq, isequal}\n\ +@seealso{eq, isequal, le, ge, lt}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_ne, args); @@ -5556,7 +5571,7 @@ @end example\n\ \n\ At least one argument is required.\n\ -@seealso{mtimes}\n\ +@seealso{mtimes, rdivide}\n\ @end deftypefn") { return binary_assoc_op_defun_body (octave_value::op_el_mul, @@ -5568,7 +5583,7 @@ @deftypefn {Built-in Function} {} rdivide (@var{x}, @var{y})\n\ Return the element-by-element right division of @var{x} and @var{y}.\n\ This function and @w{@xcode{x ./ y}} are equivalent.\n\ -@seealso{ldivide, mrdivide}\n\ +@seealso{ldivide, mrdivide, times, plus}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_el_div, args); @@ -5595,7 +5610,7 @@ @deftypefn {Built-in Function} {} ldivide (@var{x}, @var{y})\n\ Return the element-by-element left division of @var{x} and @var{y}.\n\ This function and @w{@xcode{x .@xbackslashchar{} y}} are equivalent.\n\ -@seealso{rdivide, mldivide}\n\ +@seealso{rdivide, mldivide, times, plus}\n\ @end deftypefn") { return binary_op_defun_body (octave_value::op_el_ldiv, args); @@ -5686,6 +5701,7 @@ @code{toc} functions report the actual wall clock time that elapsed\n\ between the calls. This may include time spent processing other jobs or\n\ doing nothing at all.\n\ +@seealso{toc, cputime}\n\ @end deftypefn") { octave_value retval; @@ -5718,7 +5734,7 @@ @deftypefn {Built-in Function} {} toc ()\n\ @deftypefnx {Built-in Function} {} toc (@var{id})\n\ @deftypefnx {Built-in Function} {@var{val} =} toc (@dots{})\n\ -See tic.\n\ +@seealso{tic, cputime}\n\ @end deftypefn") { octave_value retval; @@ -5790,6 +5806,7 @@ Note that because Octave used some CPU time to start, it is reasonable\n\ to check to see if @code{cputime} works by checking to see if the total\n\ CPU time used is nonzero.\n\ +@seealso{tic, toc}\n\ @end deftypefn") { octave_value_list retval; @@ -5910,7 +5927,7 @@ \n\ The algorithm used in @code{sort} is optimized for the sorting of partially\n\ ordered lists.\n\ -@seealso{sortrows}\n\ +@seealso{sortrows, issorted}\n\ @end deftypefn") { octave_value_list retval; @@ -6800,7 +6817,7 @@ \n\ @var{mask} can also be arbitrary numeric type, in which case\n\ it is first converted to logical.\n\ -@seealso{logical}\n\ +@seealso{logical, diff}\n\ @end deftypefn") { int nargin = args.length (); @@ -7028,6 +7045,7 @@ @var{k}-th order differences are calculated along this dimension.\n\ In the case where @var{k} exceeds @code{size (@var{x}, @var{dim})}\n\ an empty matrix is returned.\n\ +@seealso{sort, merge}\n\ @end deftypefn") { int nargin = args.length (); @@ -7138,7 +7156,7 @@ endfor\n\ @end group\n\ @end example\n\ -@seealso{repmat}\n\ +@seealso{repmat, cat}\n\ @end deftypefn") { octave_value retval;