Mercurial > octave

annotate scripts/specfun/realsqrt.m @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2008-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ##
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## This file is part of Octave.
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## (at your option) any later version.
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ##
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ## 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
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
7621
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 ## 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
20 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
21 ## <https://www.gnu.org/licenses/>.
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
22
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20162
diff changeset
24 ## @deftypefn {} {} realsqrt (@var{x})
19102
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
25 ## Return the real-valued square root of each element of @var{x}.
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
26 ##
20162
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 ## If any element results in a complex return value @code{realsqrt} aborts and
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
28 ## issues an error.
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9051
diff changeset
29 ## @seealso{sqrt, realpow, reallog}
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ## @end deftypefn
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
31
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 function y = realsqrt (x)
19102
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
33
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 if (nargin != 1)
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 print_usage ();
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 elseif (iscomplex (x) || any (x(:) < 0))
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 error ("realsqrt: produced complex result");
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
38 else
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 y = sqrt (x);
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 endif
19102
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
41
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 endfunction
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
43
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
44
19102
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
45 %!assert (realsqrt (1:5), sqrt (1:5))
7621
4682dda22527 Add the reallog, realsqrt and realpow functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 %!test
19102
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
47 %! x = rand (10, 10);
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
48 %! assert (realsqrt (x), sqrt (x));
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
49
19102
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
50 %!error realsqrt ()
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
51 %!error realsqrt (1,2)
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
52 %!error <produced complex result> realsqrt (-1)