Mercurial > octave-nkf
changeset 11532:34bb8d38f19f
Add undocumented function cbrt to documentation.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 14 Jan 2011 14:05:15 -0800 |
| parents | f976dd63129c |
| children | 06c80c90a246 |
| files | doc/ChangeLog doc/interpreter/arith.txi scripts/ChangeLog scripts/specfun/nthroot.m src/ChangeLog src/mappers.cc |
| diffstat | 6 files changed, 27 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog Fri Jan 14 15:54:30 2011 -0500 +++ b/doc/ChangeLog Fri Jan 14 14:05:15 2011 -0800 @@ -1,3 +1,7 @@ +2011-01-14 Rik <octave@nomad.inbox5.com> + + * interpreter/arith.txi: Add undocumented cbrt to documentation. + 2011-01-14 Rik <octave@nomad.inbox5.com> * interpreter/arith.txi: Add undocumented erfcx to documentation.
--- a/doc/interpreter/arith.txi Fri Jan 14 15:54:30 2011 -0500 +++ b/doc/interpreter/arith.txi Fri Jan 14 14:05:15 2011 -0800 @@ -52,25 +52,27 @@ @DOCSTRING(log) +@DOCSTRING(reallog) + @DOCSTRING(log1p) @DOCSTRING(log10) @DOCSTRING(log2) -@DOCSTRING(nextpow2) - -@DOCSTRING(nthroot) - @DOCSTRING(pow2) -@DOCSTRING(reallog) +@DOCSTRING(nextpow2) @DOCSTRING(realpow) +@DOCSTRING(sqrt) + @DOCSTRING(realsqrt) -@DOCSTRING(sqrt) +@DOCSTRING(cbrt) + +@DOCSTRING(nthroot) @node Complex Arithmetic @section Complex Arithmetic
--- a/scripts/ChangeLog Fri Jan 14 15:54:30 2011 -0500 +++ b/scripts/ChangeLog Fri Jan 14 14:05:15 2011 -0800 @@ -1,3 +1,7 @@ +2011-01-14 Rik <octave@nomad.inbox5.com> + + * specfun/nthroot.m: Add Seealso references to docstring. + 2011-01-14 Rik <octave@nomad.inbox5.com> * miscellaneous/module.mk: Remove texas_lotto.m from build system.
--- a/scripts/specfun/nthroot.m Fri Jan 14 15:54:30 2011 -0500 +++ b/scripts/specfun/nthroot.m Fri Jan 14 14:05:15 2011 -0800 @@ -37,7 +37,7 @@ ## ## @var{n} must be a scalar. If @var{n} is not an even integer and @var{X} has ## negative entries, an error is produced. -## +## @seealso{realsqrt, sqrt, cbrt} ## @end deftypefn function y = nthroot (x, n)
--- a/src/ChangeLog Fri Jan 14 15:54:30 2011 -0500 +++ b/src/ChangeLog Fri Jan 14 14:05:15 2011 -0800 @@ -1,3 +1,8 @@ +2011-01-14 Rik <octave@nomad.inbox5.com> + + * src/mappers.cc: Add Seealso links between sqrt, cbrt, nthroot + functions. + 2011-01-14 John W. Eaton <jwe@octave.org> * dirfns.cc (Ffnmatch): Use DEFUNX until gnulib's fnmatch is C++
--- 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;