Mercurial > hg > octave-lyh
view scripts/specfun/reallog.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | 3eb2094eefe5 |
children | c1fff751b5a8 |
line wrap: on
line source
## Copyright (C) 2008 David Bateman ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} reallog (@var{x}) ## Return the real natural logarithm of @var{x}. If any element results in the ## return value being complex @code{reallog} produces an error. ## @seealso{log, realsqrt, realpow} ## @end deftypefn function y = reallog (x) if (nargin != 1) print_usage (); elseif (iscomplex (x) || any (x(:) < 0)) error ("reallog: produced complex result"); else y = log (x); endif endfunction %!assert (log(1:5),reallog(1:5)) %!test %! x = rand (10,10); %! assert (log(x),reallog(x)) %!error (reallog(-1))