Mercurial > octave-nkf
diff src/mappers.cc @ 11532:34bb8d38f19f
Add undocumented function cbrt to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Fri, 14 Jan 2011 14:05:15 -0800 |
parents | f98f925d8e5c |
children | 7d6d8c1e471f |
line wrap: on
line diff
--- a/src/mappers.cc Fri Jan 14 15:54:30 2011 -0500 +++ b/src/mappers.cc Fri Jan 14 14:05:15 2011 -0800 @@ -354,8 +354,10 @@ DEFUN (cbrt, args, , "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} cbrt (@var{x})\n\ -Return the real cube root of @var{x}. Unlike @code{@var{x}^(1/3)},\n\ -the result will be negative if @var{x} is negative.\n\ +Compute the real cube root of each element of @var{x}.\n\ +Unlike @code{@var{x}^(1/3)}, the result will be negative if @var{x} is\n\ +negative.\n\ +@seealso{nthroot}\n\ @end deftypefn") { octave_value retval; @@ -1652,7 +1654,7 @@ Compute the square root of each element of @var{x}. If @var{x} is negative,\n\ a complex result is returned. To compute the matrix square root, see\n\ @ref{Linear Algebra}.\n\ -@seealso{realsqrt}\n\ +@seealso{realsqrt, nthroot}\n\ @end deftypefn") { octave_value retval;