Mercurial > octave-nkf

annotate scripts/specfun/realsqrt.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 4682dda22527
children c1fff751b5a8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 ## Copyright (C) 2008 David Bateman
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Function File} {} realsqrt (@var{x})
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7621
diff changeset
21 ## Return the real sqrt of @var{x}. If any element results in the
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## return value being complex @code{realsqrt} produces an error.
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## @seealso{sqrt, reallog, realpow}
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## @end deftypefn
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
25
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 function y = realsqrt (x)
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 if (nargin != 1)
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 print_usage ();
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 elseif (iscomplex (x) || any (x(:) < 0))
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 error ("realsqrt: produced complex result");
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 else
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 y = sqrt (x);
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 endif
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 endfunction
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
35
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 %!assert (sqrt(1:5),realsqrt(1:5))
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 %!test
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
38 %! x = rand (10,10);
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 %! assert (sqrt(x),realsqrt(x))
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 %!error (realsqrt(-1))