octave: libinterp/corefcn/mappers.cc annotate

annotate libinterp/corefcn/mappers.cc @ 27956:2310164737b3 stable

fix many spelling errors (bug #57613)

author	John W. Eaton <jwe@octave.org>
date	Fri, 17 Jan 2020 13:15:27 -0600
parents	00f796120a6d
children	c20b7290c778

rev	line source
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	2
26376 00f796120a6d maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 25415 diff changeset	3 Copyright (C) 1993-2019 John W. Eaton
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11431 diff changeset	4 Copyright (C) 2009-2010 VZLU Prague
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	5
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	7
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24533 diff changeset	8 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22498 diff changeset	9 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: 24533 diff changeset	10 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22498 diff changeset	11 (at your option) any later version.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	12
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22498 diff changeset	13 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22498 diff changeset	14 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22498 diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22498 diff changeset	16 GNU General Public License for more details.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	17
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	18 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6969 diff changeset	19 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: 24533 diff changeset	20 <https://www.gnu.org/licenses/>.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	21
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	22 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	23
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	24 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	25 # include "config.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	26 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	27
2089 4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe] jwe parents: 1996 diff changeset	28 #include <cctype>
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	29
4524 fd95dc5e6f28 [project @ 2003-10-02 03:14:48 by jwe] jwe parents: 4268 diff changeset	30 #include "lo-ieee.h"
3156 a494f93e60ff [project @ 1998-02-20 07:47:48 by jwe] jwe parents: 3010 diff changeset	31 #include "lo-specfun.h"
2889 8aa189b811d0 [project @ 1997-04-28 01:35:18 by jwe] jwe parents: 2847 diff changeset	32 #include "lo-mappers.h"
8aa189b811d0 [project @ 1997-04-28 01:35:18 by jwe] jwe parents: 2847 diff changeset	33
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1343 diff changeset	34 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1343 diff changeset	35 #include "error.h"
2955 dfffbf305468 [project @ 1997-05-09 15:15:18 by jwe] jwe parents: 2909 diff changeset	36 #include "variables.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	37
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	38 DEFUN (abs, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	39 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	40 @deftypefn {} {} abs (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	41 Compute the magnitude of @var{z}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	42
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	43 The magnitude is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	44 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	45 $\|z\| = \sqrt{x^2 + y^2}$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	46 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	47 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	48 \|@var{z}\| = @code{sqrt (x^2 + y^2)}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	49 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	50
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	51 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	52
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	53 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	54 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	55 abs (3 + 4i)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	56 @result{} 5
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	57 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	58 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	59 @seealso{arg}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	60 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	61 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	62 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	63 print_usage ();
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 331 diff changeset	64
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	65 return ovl (args(0).abs ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	66 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	67
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	68 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	69 %!assert (abs (1), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	70 %!assert (abs (-3.5), 3.5)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	71 %!assert (abs (3+4i), 5)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	72 %!assert (abs (3-4i), 5)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	73 %!assert (abs ([1.1, 3i; 3+4i, -3-4i]), [1.1, 3; 5, 5])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	74
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	75 %!assert (abs (single (1)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	76 %!assert (abs (single (-3.5)), single (3.5))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	77 %!assert (abs (single (3+4i)), single (5))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	78 %!assert (abs (single (3-4i)), single (5))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	79 %!assert (abs (single ([1.1, 3i; 3+4i, -3-4i])), single ([1.1, 3; 5, 5]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	80
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	81 %!error abs ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	82 %!error abs (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	83 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	84
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	85 DEFUN (acos, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	86 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	87 @deftypefn {} {} acos (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	88 Compute the inverse cosine in radians for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	89 @seealso{cos, acosd}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	90 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	91 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	92 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	93 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	94
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	95 return ovl (args(0).acos ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	96 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	97
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	98 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	99 %!shared rt2, rt3
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	100 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	101 %! rt3 = sqrt (3);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	102
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	103 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	104 %! x = [1, rt3/2, rt2/2, 1/2, 0, -1/2, -rt2/2, -rt3/2, -1];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	105 %! v = [0, pi/6, pi/4, pi/3, pi/2, 2pi/3, 3pi/4, 5*pi/6, pi];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	106 %! assert (acos (x), v, sqrt (eps));
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	107
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	108 %!test
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	109 %! x = single ([1, rt3/2, rt2/2, 1/2, 0, -1/2, -rt2/2, -rt3/2, -1]);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	110 %! v = single ([0, pi/6, pi/4, pi/3, pi/2, 2pi/3, 3pi/4, 5*pi/6, pi]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	111 %! assert (acos (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	112
19242 ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	113 ## Test values on either side of branch cut
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	114 %!test
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	115 %! rval = 0;
24529 ed9a04087328 test: Use new constant for acos(2) in BIST tests of acos. Rik <rik@octave.org> parents: 23995 diff changeset	116 %! ival = 1.31695789692481671;
19242 ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	117 %! obs = acos ([2, 2-ieps, 2+ieps]);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	118 %! exp = [rval + ivali, rval + ivali, rval - ival*i];
24532 a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	119 %! assert (obs, exp, 3*eps);
19242 ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	120 %! rval = pi;
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	121 %! obs = acos ([-2, -2-ieps, -2+ieps]);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	122 %! exp = [rval - ivali, rval + ivali, rval - ival*i];
24533 ad7b19bfcce4 test: Relax tolerance on acos BIST tests to support Macs (bug #52627). Rik <rik@octave.org> parents: 24532 diff changeset	123 %! assert (obs, exp, 5*eps);
24532 a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	124 %! assert (acos ([2 0]), [ivali, pi/2], 3eps);
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	125 %! assert (acos ([2 0i]), [ivali, pi/2], 3eps);
19242 ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	126
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	127 ## Test large magnitude arguments (bug #45507)
23995 d511f7e15652 Change xtests for bug #45507 to regular tests and mark as fixed. Rik <rik@octave.org> parents: 23573 diff changeset	128 ## Test fails with older versions of libm, solution is to upgrade.
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	129 %!testif ; ! ismac () && ! ispc () <*45507>
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	130 %! x = [1, -1, i, -i] .* 1e150;
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	131 %! v = [0, pi, pi/2, pi/2];
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	132 %! assert (real (acos (x)), v);
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	133
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	134 %!xtest <52627>
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	135 %! ## Same test code as above, but intended only for test statistics on Mac and
b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	136 %! ## Windows. Their trig/hyperbolic functions have huge tolerances.
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	137 %! if (! ismac ()), return; endif
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	138 %! x = [1, -1, i, -i] .* 1e150;
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	139 %! v = [0, pi, pi/2, pi/2];
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	140 %! assert (real (acos (x)), v);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	141
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	142 %!error acos ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	143 %!error acos (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	144 */
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	145
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	146 DEFUN (acosh, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	147 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	148 @deftypefn {} {} acosh (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	149 Compute the inverse hyperbolic cosine for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	150 @seealso{cosh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	151 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	152 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	153 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	154 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	155
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	156 return ovl (args(0).acosh ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	157 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	158
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	159 /*
24532 a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	160 %!testif ; ! ismac ()
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	161 %! x = [1, 0, -1, 0];
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	162 %! v = [0, pi/2i, pii, pi/2*i];
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	163 %! assert (acosh (x), v, sqrt (eps));
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	164
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	165 %!xtest <52627>
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	166 %! ## Same test code as above, but intended only for test statistics on Mac.
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	167 %! ## Mac trig/hyperbolic functions have huge tolerances.
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	168 %! if (! ismac ()), return; endif
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	169 %! x = [1, 0, -1, 0];
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	170 %! v = [0, pi/2i, pii, pi/2*i];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	171 %! assert (acosh (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	172
22498 4d9c371d2cca test: Mark acosh BIST tests with bug number 49091. Rik <rik@octave.org> parents: 22489 diff changeset	173 ## FIXME: std::acosh on Windows platforms, returns a result that differs
4d9c371d2cca test: Mark acosh BIST tests with bug number 49091. Rik <rik@octave.org> parents: 22489 diff changeset	174 ## by 1 in the last significant digit. This is ~30*eps which is quite large.
4d9c371d2cca test: Mark acosh BIST tests with bug number 49091. Rik <rik@octave.org> parents: 22489 diff changeset	175 ## The decision now (9/15/2016) is to mark the test with a bug number so
4d9c371d2cca test: Mark acosh BIST tests with bug number 49091. Rik <rik@octave.org> parents: 22489 diff changeset	176 ## it is understood why it is failing, and wait for MinGw to improve their
4d9c371d2cca test: Mark acosh BIST tests with bug number 49091. Rik <rik@octave.org> parents: 22489 diff changeset	177 ## std library.
4d9c371d2cca test: Mark acosh BIST tests with bug number 49091. Rik <rik@octave.org> parents: 22489 diff changeset	178 %!test <49091>
19730 554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	179 %! re = 2.99822295029797;
554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	180 %! im = pi/2;
554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	181 %! assert (acosh (-10i), re - i*im);
554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	182
24532 a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	183 %!testif ; ! ismac ()
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	184 %! x = single ([1, 0, -1, 0]);
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	185 %! v = single ([0, pi/2i, pii, pi/2*i]);
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	186 %! assert (acosh (x), v, sqrt (eps ("single")));
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	187
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	188 %!xtest <52627>
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	189 %! ## Same test code as above, but intended only for test statistics on Mac.
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	190 %! ## Mac trig/hyperbolic functions have huge tolerances.
a6753fc10731 Mark certain hyperbolic BIST tests as Mac-only failures (bug #52627). Rik <rik@octave.org> parents: 24529 diff changeset	191 %! if (! ismac ()), return; endif
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	192 %! x = single ([1, 0, -1, 0]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	193 %! v = single ([0, pi/2i, pii, pi/2*i]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	194 %! assert (acosh (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	195
22498 4d9c371d2cca test: Mark acosh BIST tests with bug number 49091. Rik <rik@octave.org> parents: 22489 diff changeset	196 %!test <49091>
19730 554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	197 %! re = single (2.99822295029797);
554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	198 %! im = single (pi/2);
554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	199 %! assert (acosh (single (10i)), re + iim, 5eps ("single"));
554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	200 %! assert (acosh (single (-10i)), re - iim, 5eps ("single"));
554aaaf99644 Fix return phase of acosh to match Matlab (bug #44286). Rik <rik@octave.org> parents: 19697 diff changeset	201
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	202 ## Test large magnitude arguments (bug #45507)
23995 d511f7e15652 Change xtests for bug #45507 to regular tests and mark as fixed. Rik <rik@octave.org> parents: 23573 diff changeset	203 ## Test fails with older versions of libm, solution is to upgrade.
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	204 %!testif ; ! ismac () && ! ispc () <*45507>
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	205 %! x = [1, -1, i, -i] .* 1e150;
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	206 %! v = [0, pi, pi/2, -pi/2];
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	207 %! assert (imag (acosh (x)), v);
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	208
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	209 %!xtest <52627>
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	210 %! ## Same test code as above, but intended only for test statistics on Mac and
b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	211 %! ## Windows. Their trig/hyperbolic functions have huge tolerances.
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	212 %! if (! ismac ()), return; endif
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	213 %! x = [1, -1, i, -i] .* 1e150;
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	214 %! v = [0, pi, pi/2, -pi/2];
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	215 %! assert (imag (acosh (x)), v);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	216
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	217 %!error acosh ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	218 %!error acosh (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	219 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	220
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	221 DEFUN (angle, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	222 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	223 @deftypefn {} {} angle (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	224 See @code{arg}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	225 @seealso{arg}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	226 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	227 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	228 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	229 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	230
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	231 return ovl (args(0).arg ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	232 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	233
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	234 DEFUN (arg, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	235 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	236 @deftypefn {} {} arg (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	237 @deftypefnx {} {} angle (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	238 Compute the argument, i.e., angle of @var{z}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	239
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	240 This is defined as,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	241 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	242 $\theta = atan2 (y, x),$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	243 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	244 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	245 @var{theta} = @code{atan2 (@var{y}, @var{x})},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	246 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	247 in radians.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	248
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	249 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	250
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	251 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	252 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	253 arg (3 + 4i)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	254 @result{} 0.92730
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	255 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	256 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	257 @seealso{abs}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	258 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	259 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	260 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	261 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	262
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	263 return ovl (args(0).arg ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	264 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	265
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	266 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	267 %!assert (arg (1), 0)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	268 %!assert (arg (i), pi/2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	269 %!assert (arg (-1), pi)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	270 %!assert (arg (-i), -pi/2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	271 %!assert (arg ([1, i; -1, -i]), [0, pi/2; pi, -pi/2])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	272
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	273 %!assert (arg (single (1)), single (0))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	274 %!assert (arg (single (i)), single (pi/2))
13093 1a21c4c5eeeb Fix tolerance for mappers.cc test on MacOS. Ben Abbott <bpabbott@mac.com> parents: 12894 diff changeset	275 %!test
1a21c4c5eeeb Fix tolerance for mappers.cc test on MacOS. Ben Abbott <bpabbott@mac.com> parents: 12894 diff changeset	276 %! if (ismac ())
1a21c4c5eeeb Fix tolerance for mappers.cc test on MacOS. Ben Abbott <bpabbott@mac.com> parents: 12894 diff changeset	277 %! ## Avoid failing for a MacOS feature
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	278 %! assert (arg (single (-1)), single (pi), 2*eps (single (1)));
13093 1a21c4c5eeeb Fix tolerance for mappers.cc test on MacOS. Ben Abbott <bpabbott@mac.com> parents: 12894 diff changeset	279 %! else
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	280 %! assert (arg (single (-1)), single (pi));
13093 1a21c4c5eeeb Fix tolerance for mappers.cc test on MacOS. Ben Abbott <bpabbott@mac.com> parents: 12894 diff changeset	281 %! endif
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	282 %!assert (arg (single (-i)), single (-pi/2))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	283 %!assert (arg (single ([1, i; -1, -i])), single ([0, pi/2; pi, -pi/2]), 2e1*eps ("single"))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	284
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	285 %!error arg ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	286 %!error arg (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	287 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	288
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	289 DEFUN (asin, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	290 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	291 @deftypefn {} {} asin (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	292 Compute the inverse sine in radians for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	293 @seealso{sin, asind}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	294 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	295 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	296 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	297 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	298
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	299 return ovl (args(0).asin ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	300 }
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 331 diff changeset	301
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	302 /*
19242 ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	303 %!shared rt2, rt3
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	304 %! rt2 = sqrt (2);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	305 %! rt3 = sqrt (3);
19242 ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	306
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	307 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	308 %! x = [0, 1/2, rt2/2, rt3/2, 1, rt3/2, rt2/2, 1/2, 0];
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	309 %! v = [0, pi/6, pi/4, pi/3, pi/2, pi/3, pi/4, pi/6, 0];
19242 ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	310 %! assert (asin (x), v, sqrt (eps));
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	311
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	312 %!test
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	313 %! x = single ([0, 1/2, rt2/2, rt3/2, 1, rt3/2, rt2/2, 1/2, 0]);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	314 %! v = single ([0, pi/6, pi/4, pi/3, pi/2, pi/3, pi/4, pi/6, 0]);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	315 %! assert (asin (x), v, sqrt (eps ("single")));
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	316
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	317 ## Test values on either side of branch cut
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	318 %!test
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	319 %! rval = pi/2;
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	320 %! ival = 1.31695789692481635;
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	321 %! obs = asin ([2, 2-ieps, 2+ieps]);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	322 %! exp = [rval - ivali, rval - ivali, rval + ival*i];
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	323 %! assert (obs, exp, 2*eps);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	324 %! obs = asin ([-2, -2-ieps, -2+ieps]);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	325 %! exp = [-rval + ivali, -rval - ivali, -rval + ival*i];
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	326 %! assert (obs, exp, 2*eps);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	327 %! assert (asin ([2 0]), [rval - ivali, 0], 2eps);
ba7e42dea4b2 Fix returned phase of asin, acos outside principal branch (bug #43349). Rik <rik@octave.org> parents: 19151 diff changeset	328 %! assert (asin ([2 0i]), [rval - ivali, 0], 2eps);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	329
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	330 ## Test large magnitude arguments (bug #45507)
23995 d511f7e15652 Change xtests for bug #45507 to regular tests and mark as fixed. Rik <rik@octave.org> parents: 23573 diff changeset	331 ## Test fails with older versions of libm, solution is to upgrade.
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	332 %!testif ; ! ismac () && ! ispc () <*45507>
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	333 %! x = [1, -1, i, -i] .* 1e150;
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	334 %! v = [pi/2, -pi/2, 0, -0];
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	335 %! assert (real (asin (x)), v);
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	336
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	337 %!xtest <52627>
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	338 %! ## Same test code as above, but intended only for test statistics on Mac and
b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	339 %! ## Windows. Their trig/hyperbolic functions have huge tolerances.
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	340 %! if (! ismac ()), return; endif
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	341 %! x = [1, -1, i, -i] .* 1e150;
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	342 %! v = [pi/2, -pi/2, 0, -0];
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	343 %! assert (real (asin (x)), v);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	344
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	345 %!error asin ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	346 %!error asin (1, 2)
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	347 */
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	348
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	349 DEFUN (asinh, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	350 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	351 @deftypefn {} {} asinh (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	352 Compute the inverse hyperbolic sine for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	353 @seealso{sinh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	354 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	355 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	356 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	357 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	358
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	359 return ovl (args(0).asinh ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	360 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	361
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	362 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	363 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	364 %! v = [0, pi/2i, 0, -pi/2i];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	365 %! x = [0, i, 0, -i];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	366 %! assert (asinh (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	367
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	368 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	369 %! v = single ([0, pi/2i, 0, -pi/2i]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	370 %! x = single ([0, i, 0, -i]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	371 %! assert (asinh (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	372
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	373 ## Test large magnitude arguments (bug #45507)
23995 d511f7e15652 Change xtests for bug #45507 to regular tests and mark as fixed. Rik <rik@octave.org> parents: 23573 diff changeset	374 ## Test fails with older versions of libm, solution is to upgrade.
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	375 %!testif ; ! ismac () && ! ispc () <*45507>
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	376 %! x = [1, -1, i, -i] .* 1e150;
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	377 %! v = [0, 0, pi/2, -pi/2];
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	378 %! assert (imag (asinh (x)), v);
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	379
0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	380 %!xtest <52627>
25076 b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	381 %! ## Same test code as above, but intended only for test statistics on Mac and
b9c62b62f9eb test: Mark certain bugs as xtest when run on Windows platforms (bug #53490). Markus Mützel <markus.muetzel@gmx.de> parents: 25054 diff changeset	382 %! ## Windows. Their trig/hyperbolic functions have huge tolerances.
24555 0645853d12d6 test: Mark certain bugs as xtest when run on Mac platforms (bug #52627). Rik <rik@octave.org> parents: 24534 diff changeset	383 %! if (! ismac ()), return; endif
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	384 %! x = [1, -1, i, -i] .* 1e150;
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	385 %! v = [0, 0, pi/2, -pi/2];
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	386 %! assert (imag (asinh (x)), v);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	387
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	388 %!error asinh ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	389 %!error asinh (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	390 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	391
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	392 DEFUN (atan, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	393 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	394 @deftypefn {} {} atan (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	395 Compute the inverse tangent in radians for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	396 @seealso{tan, atand}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	397 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	398 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	399 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	400 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	401
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	402 return ovl (args(0).atan ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	403 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	404
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	405 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	406 %!shared rt2, rt3
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	407 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	408 %! rt3 = sqrt (3);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	409
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	410 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	411 %! v = [0, pi/6, pi/4, pi/3, -pi/3, -pi/4, -pi/6, 0];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	412 %! x = [0, rt3/3, 1, rt3, -rt3, -1, -rt3/3, 0];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	413 %! assert (atan (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	414
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	415 %!test
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	416 %! v = single ([0, pi/6, pi/4, pi/3, -pi/3, -pi/4, -pi/6, 0]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	417 %! x = single ([0, rt3/3, 1, rt3, -rt3, -1, -rt3/3, 0]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	418 %! assert (atan (x), v, sqrt (eps ("single")));
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	419
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	420 ## Test large magnitude arguments (bug #44310, bug #45507)
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	421 %!test <*44310>
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	422 %! x = [1, -1, i, -i] .* 1e150;
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	423 %! v = [pi/2, -pi/2, pi/2, -pi/2];
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	424 %! assert (real (atan (x)), v);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	425 %! assert (imag (atan (x)), [0, 0, 0, 0], eps);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	426
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	427 %!error atan ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	428 %!error atan (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	429 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	430
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	431 DEFUN (atanh, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	432 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	433 @deftypefn {} {} atanh (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	434 Compute the inverse hyperbolic tangent for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	435 @seealso{tanh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	436 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	437 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	438 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	439 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	440
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	441 return ovl (args(0).atanh ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	442 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	443
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	444 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	445 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	446 %! v = [0, 0];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	447 %! x = [0, 0];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	448 %! assert (atanh (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	449
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	450 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	451 %! v = single ([0, 0]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	452 %! x = single ([0, 0]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	453 %! assert (atanh (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	454
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	455 ## Test large magnitude arguments (bug #44310, bug #45507)
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	456 %!test <*44310>
21945 e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	457 %! x = [1, -1, i, -i] .* 1e150;
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	458 %! v = [pi/2, pi/2, pi/2, -pi/2];
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	459 %! assert (imag (atanh (x)), v);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	460 %! assert (real (atanh (x)), [0, 0, 0, 0], eps);
e9765b62d4e8 Use C++11 standard complex trig functions when available (bug #44310, bug #45507) Mike Miller <mtmiller@octave.org> parents: 21724 diff changeset	461
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	462 %!error atanh ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	463 %!error atanh (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	464 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	465
10414 2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	466 DEFUN (cbrt, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	467 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	468 @deftypefn {} {} cbrt (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	469 Compute the real cube root of each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	470
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	471 Unlike @code{@var{x}^(1/3)}, the result will be negative if @var{x} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	472 negative.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	473 @seealso{nthroot}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	474 @end deftypefn */)
10414 2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	475 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	476 if (args.length () != 1)
10414 2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	477 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	478
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	479 return ovl (args(0).cbrt ());
10414 2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	480 }
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	481
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	482 /*
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	483 %!assert (cbrt (64), 4)
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	484 %!assert (cbrt (-125), -5)
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	485 %!assert (cbrt (0), 0)
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	486 %!assert (cbrt (Inf), Inf)
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	487 %!assert (cbrt (-Inf), -Inf)
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	488 %!assert (cbrt (NaN), NaN)
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	489 %!assert (cbrt (2^300), 2^100)
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	490 %!assert (cbrt (1252^300), 52^100)
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	491
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	492 %!error cbrt ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	493 %!error cbrt (1, 2)
10414 2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	494 */
2a8b1db1e2ca implement built-in cbrt Jaroslav Hajek <highegg@gmail.com> parents: 10391 diff changeset	495
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	496 DEFUN (ceil, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	497 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	498 @deftypefn {} {} ceil (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	499 Return the smallest integer not less than @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	500
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	501 This is equivalent to rounding towards positive infinity.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	502
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	503 If @var{x} is complex, return
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	504 @code{ceil (real (@var{x})) + ceil (imag (@var{x})) * I}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	505
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	506 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	507 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	508 ceil ([-2.7, 2.7])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	509 @result{} -2 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	510 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	511 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	512 @seealso{floor, round, fix}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	513 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	514 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	515 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	516 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	517
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	518 return ovl (args(0).ceil ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	519 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	520
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	521 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	522 ## double precision
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	523 %!assert (ceil ([2, 1.1, -1.1, -1]), [2, 2, -1, -1])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	524
27956 2310164737b3 fix many spelling errors (bug #57613) John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	525 ## complex double precision
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	526 %!assert (ceil ([2+2i, 1.1+1.1i, -1.1-1.1i, -1-i]), [2+2i, 2+2i, -1-i, -1-i])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	527
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	528 ## single precision
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	529 %!assert (ceil (single ([2, 1.1, -1.1, -1])), single ([2, 2, -1, -1]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	530
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	531 ## complex single precision
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	532 %!assert (ceil (single ([2+2i, 1.1+1.1i, -1.1-1.1i, -1-i])), single ([2+2i, 2+2i, -1-i, -1-i]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	533
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	534 %!error ceil ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	535 %!error ceil (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	536 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	537
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	538 DEFUN (conj, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	539 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	540 @deftypefn {} {} conj (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	541 Return the complex conjugate of @var{z}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	542
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	543 The complex conjugate is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	544 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	545 $\bar{z} = x - iy$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	546 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	547 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	548 @code{conj (@var{z})} = @var{x} - @var{i}@var{y}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	549 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	550 @seealso{real, imag}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	551 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	552 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	553 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	554 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	555
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	556 return ovl (args(0).conj ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	557 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	558
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	559 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	560 %!assert (conj (1), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	561 %!assert (conj (i), -i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	562 %!assert (conj (1+i), 1-i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	563 %!assert (conj (1-i), 1+i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	564 %!assert (conj ([-1, -i; -1+i, -1-i]), [-1, i; -1-i, -1+i])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	565
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	566 %!assert (conj (single (1)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	567 %!assert (conj (single (i)), single (-i))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	568 %!assert (conj (single (1+i)), single (1-i))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	569 %!assert (conj (single (1-i)), single (1+i))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	570 %!assert (conj (single ([-1, -i; -1+i, -1-i])), single ([-1, i; -1-i, -1+i]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	571
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	572 %!error conj ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	573 %!error conj (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	574 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	575
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	576 DEFUN (cos, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	577 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	578 @deftypefn {} {} cos (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	579 Compute the cosine for each element of @var{x} in radians.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	580 @seealso{acos, cosd, cosh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	581 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	582 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	583 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	584 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	585
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	586 return ovl (args(0).cos ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	587 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	588
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	589 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	590 %!shared rt2, rt3
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	591 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	592 %! rt3 = sqrt (3);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	593
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	594 %!test
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	595 %! x = [0, pi/6, pi/4, pi/3, pi/2, 2pi/3, 3pi/4, 5*pi/6, pi];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	596 %! v = [1, rt3/2, rt2/2, 1/2, 0, -1/2, -rt2/2, -rt3/2, -1];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	597 %! assert (cos (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	598
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	599 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	600 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	601 %! rt3 = sqrt (3);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	602 %! x = single ([0, pi/6, pi/4, pi/3, pi/2, 2pi/3, 3pi/4, 5*pi/6, pi]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	603 %! v = single ([1, rt3/2, rt2/2, 1/2, 0, -1/2, -rt2/2, -rt3/2, -1]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	604 %! assert (cos (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	605
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	606 %!error cos ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	607 %!error cos (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	608 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	609
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	610 DEFUN (cosh, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	611 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	612 @deftypefn {} {} cosh (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	613 Compute the hyperbolic cosine for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	614 @seealso{acosh, sinh, tanh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	615 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	616 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	617 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	618 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	619
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	620 return ovl (args(0).cosh ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	621 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	622
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	623 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	624 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	625 %! x = [0, pi/2i, pii, 3pi/2i];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	626 %! v = [1, 0, -1, 0];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	627 %! assert (cosh (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	628
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	629 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	630 %! x = single ([0, pi/2i, pii, 3pi/2i]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	631 %! v = single ([1, 0, -1, 0]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	632 %! assert (cosh (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	633
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	634 %!error cosh ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	635 %!error cosh (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	636 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	637
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	638 DEFUN (erf, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	639 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	640 @deftypefn {} {} erf (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	641 Compute the error function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	642
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	643 The error function is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	644 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	645 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	646 {\rm erf} (z) = {2 \over \sqrt{\pi}}\int_0^z e^{-t^2} dt
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	647 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	648 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	649 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	650
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	651 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	652 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	653 z
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	654 2 /
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	655 erf (z) = --------- * \| e^(-t^2) dt
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	656 sqrt (pi) /
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	657 t=0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	658 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	659 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	660
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	661 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	662 @seealso{erfc, erfcx, erfi, dawson, erfinv, erfcinv}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	663 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	664 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	665 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	666 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	667
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	668 return ovl (args(0).erf ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	669 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	670
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	671 /*
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	672 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	673 %! a = -1isqrt (-1/(6.41876.4187));
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	674 %! assert (erf (a), erf (real (a)));
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	675
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	676 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	677 %! x = [0,.5,1];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	678 %! v = [0, .520499877813047, .842700792949715];
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	679 %! assert (erf (x), v, 1.e-10);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	680 %! assert (erf (-x), -v, 1.e-10);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	681 %! assert (erfc (x), 1-v, 1.e-10);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	682 %! assert (erfinv (v), x, 1.e-10);
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	683
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	684 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	685 %! a = -1isqrt (single (-1/(6.41876.4187)));
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	686 %! assert (erf (a), erf (real (a)));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	687
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	688 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	689 %! x = single ([0,.5,1]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	690 %! v = single ([0, .520499877813047, .842700792949715]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	691 %! assert (erf (x), v, 1.e-6);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	692 %! assert (erf (-x), -v, 1.e-6);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	693 %! assert (erfc (x), 1-v, 1.e-6);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	694 %! assert (erfinv (v), x, 1.e-6);
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	695
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	696 %!test
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	697 %! x = [1+2i,-1+2i,1e-6+2e-6i,0+2i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	698 %! v = [-0.53664356577857-5.04914370344703i, 0.536643565778565-5.04914370344703i, 0.112837916709965e-5+0.225675833419178e-5i, 18.5648024145755526i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	699 %! assert (erf (x), v, -1.e-10);
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	700 %! assert (erf (-x), -v, -1.e-10);
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	701 %! assert (erfc (x), 1-v, -1.e-10);
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	702
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	703 %!error erf ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	704 %!error erf (1, 2)
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	705 */
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	706
9835 1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	707 DEFUN (erfinv, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	708 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	709 @deftypefn {} {} erfinv (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	710 Compute the inverse error function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	711
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	712 The inverse error function is defined such that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	713
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	714 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	715 erf (@var{y}) == @var{x}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	716 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	717 @seealso{erf, erfc, erfcx, erfi, dawson, erfcinv}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	718 @end deftypefn */)
9835 1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	719 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	720 if (args.length () != 1)
9835 1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	721 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	722
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	723 return ovl (args(0).erfinv ());
9835 1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	724 }
1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	725
1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	726 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	727 ## middle region
10049 44e889c67abe mappers.cc: Change test tolerance from 1e-16 to eps. Ben Abbott <bpabbott@mac.com> parents: 9835 diff changeset	728 %!assert (erf (erfinv ([-0.9 -0.3 0 0.4 0.8])), [-0.9 -0.3 0 0.4 0.8], eps)
14771 10ed11922f19 maint: code cleanup for new erfcinv function. Rik <octave@nomad.inbox5.com> parents: 14770 diff changeset	729 %!assert (erf (erfinv (single ([-0.9 -0.3 0 0.4 0.8]))), single ([-0.9 -0.3 0 0.4 0.8]), eps ("single"))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	730 ## tail region
10049 44e889c67abe mappers.cc: Change test tolerance from 1e-16 to eps. Ben Abbott <bpabbott@mac.com> parents: 9835 diff changeset	731 %!assert (erf (erfinv ([-0.999 -0.99 0.9999 0.99999])), [-0.999 -0.99 0.9999 0.99999], eps)
14771 10ed11922f19 maint: code cleanup for new erfcinv function. Rik <octave@nomad.inbox5.com> parents: 14770 diff changeset	732 %!assert (erf (erfinv (single ([-0.999 -0.99 0.9999 0.99999]))), single ([-0.999 -0.99 0.9999 0.99999]), eps ("single"))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	733 ## backward - loss of accuracy
9835 1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	734 %!assert (erfinv (erf ([-3 -1 -0.4 0.7 1.3 2.8])), [-3 -1 -0.4 0.7 1.3 2.8], -1e-12)
1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	735 %!assert (erfinv (erf (single ([-3 -1 -0.4 0.7 1.3 2.8]))), single ([-3 -1 -0.4 0.7 1.3 2.8]), -1e-4)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	736 ## exceptional
9835 1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	737 %!assert (erfinv ([-1, 1, 1.1, -2.1]), [-Inf, Inf, NaN, NaN])
1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	738 %!error erfinv (1+2i)
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	739
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	740 %!error erfinv ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	741 %!error erfinv (1, 2)
9835 1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	742 */
1bb1ed717d2f implement built-in erfinv Jaroslav Hajek <highegg@gmail.com> parents: 9813 diff changeset	743
14770 cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	744 DEFUN (erfcinv, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	745 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	746 @deftypefn {} {} erfcinv (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	747 Compute the inverse complementary error function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	748
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	749 The inverse complementary error function is defined such that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	750
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	751 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	752 erfc (@var{y}) == @var{x}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	753 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	754 @seealso{erfc, erf, erfcx, erfi, dawson, erfinv}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	755 @end deftypefn */)
14770 cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	756 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	757 if (args.length () != 1)
14770 cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	758 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	759
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	760 return ovl (args(0).erfcinv ());
14770 cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	761 }
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	762
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	763 /*
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	764 ## middle region
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	765 %!assert (erfc (erfcinv ([1.9 1.3 1 0.6 0.2])), [1.9 1.3 1 0.6 0.2], eps)
14771 10ed11922f19 maint: code cleanup for new erfcinv function. Rik <octave@nomad.inbox5.com> parents: 14770 diff changeset	766 %!assert (erfc (erfcinv (single ([1.9 1.3 1 0.6 0.2]))), single ([1.9 1.3 1 0.6 0.2]), eps ("single"))
14770 cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	767 ## tail region
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	768 %!assert (erfc (erfcinv ([0.001 0.01 1.9999 1.99999])), [0.001 0.01 1.9999 1.99999], eps)
14771 10ed11922f19 maint: code cleanup for new erfcinv function. Rik <octave@nomad.inbox5.com> parents: 14770 diff changeset	769 %!assert (erfc (erfcinv (single ([0.001 0.01 1.9999 1.99999]))), single ([0.001 0.01 1.9999 1.99999]), eps ("single"))
14770 cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	770 ## backward - loss of accuracy
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	771 %!assert (erfcinv (erfc ([-3 -1 -0.4 0.7 1.3 2.8])), [-3 -1 -0.4 0.7 1.3 2.8], -1e-12)
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	772 %!assert (erfcinv (erfc (single ([-3 -1 -0.4 0.7 1.3 2.8]))), single ([-3 -1 -0.4 0.7 1.3 2.8]), -1e-4)
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	773 ## exceptional
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	774 %!assert (erfcinv ([2, 0, -0.1, 2.1]), [-Inf, Inf, NaN, NaN])
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	775 %!error erfcinv (1+2i)
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	776
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	777 %!error erfcinv ()
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	778 %!error erfcinv (1, 2)
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	779 */
cb85e836d035 New function: erfcinv (bug #36607) Axel Mathéi <axel.mathei@gmail.com> parents: 14437 diff changeset	780
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	781 DEFUN (erfc, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	782 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	783 @deftypefn {} {} erfc (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	784 Compute the complementary error function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	785
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	786 The complementary error function is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	787 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	788 $1 - {\rm erf} (z)$.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	789 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	790 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	791 @w{@code{1 - erf (@var{z})}}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	792 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	793 @seealso{erfcinv, erfcx, erfi, dawson, erf, erfinv}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	794 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	795 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	796 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	797 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	798
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	799 return ovl (args(0).erfc ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	800 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	801
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	802 /*
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	803 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	804 %! a = -1isqrt (-1/(6.41876.4187));
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	805 %! assert (erfc (a), erfc (real (a)));
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	806
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	807 %!error erfc ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	808 %!error erfc (1, 2)
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	809 */
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	810
10391 59e34bcdff13 implement built-in erfcx Jaroslav Hajek <highegg@gmail.com> parents: 10160 diff changeset	811 DEFUN (erfcx, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	812 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	813 @deftypefn {} {} erfcx (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	814 Compute the scaled complementary error function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	815
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	816 The scaled complementary error function is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	817 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	818 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	819 e^{z^2} {\rm erfc} (z) \equiv e^{z^2} (1 - {\rm erf} (z))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	820 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	821 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	822 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	823
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	824 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	825 exp (z^2) * erfc (z)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	826 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	827
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	828 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	829 @seealso{erfc, erf, erfi, dawson, erfinv, erfcinv}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	830 @end deftypefn */)
10391 59e34bcdff13 implement built-in erfcx Jaroslav Hajek <highegg@gmail.com> parents: 10160 diff changeset	831 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	832 if (args.length () != 1)
10391 59e34bcdff13 implement built-in erfcx Jaroslav Hajek <highegg@gmail.com> parents: 10160 diff changeset	833 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	834
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	835 return ovl (args(0).erfcx ());
10391 59e34bcdff13 implement built-in erfcx Jaroslav Hajek <highegg@gmail.com> parents: 10160 diff changeset	836 }
59e34bcdff13 implement built-in erfcx Jaroslav Hajek <highegg@gmail.com> parents: 10160 diff changeset	837
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	838 /*
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	839
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	840 %!test
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	841 %! x = [1+2i,-1+2i,1e-6+2e-6i,0+2i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	842 %! assert (erfcx (x), exp (x.^2) .* erfc(x), -1.e-10);
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	843
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	844 %!test
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	845 %! x = [100, 100+20i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	846 %! v = [0.0056416137829894329, 0.0054246791754558-0.00108483153786434i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	847 %! assert (erfcx (x), v, -1.e-10);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	848
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	849 %!error erfcx ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	850 %!error erfcx (1, 2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	851 */
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	852
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	853 DEFUN (erfi, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	854 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	855 @deftypefn {} {} erfi (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	856 Compute the imaginary error function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	857
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	858 The imaginary error function is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	859 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	860 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	861 -i {\rm erf} (iz)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	862 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	863 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	864 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	865
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	866 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	867 -i * erf (i*z)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	868 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	869
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	870 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	871 @seealso{erfc, erf, erfcx, dawson, erfinv, erfcinv}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	872 @end deftypefn */)
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	873 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	874 if (args.length () != 1)
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	875 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	876
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	877 return ovl (args(0).erfi ());
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	878 }
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	879
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	880 /*
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	881
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	882 %!test
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	883 %! x = [-0.1, 0.1, 1, 1+2i,-1+2i,1e-6+2e-6i,0+2i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	884 %! assert (erfi (x), -i * erf(i*x), -1.e-10);
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	885
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	886 %!error erfi ()
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	887 %!error erfi (1, 2)
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	888 */
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	889
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	890 DEFUN (dawson, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	891 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	892 @deftypefn {} {} dawson (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	893 Compute the Dawson (scaled imaginary error) function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	894
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	895 The Dawson function is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	896 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	897 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	898 {\sqrt{\pi} \over 2} e^{-z^2} {\rm erfi} (z) \equiv -i {\sqrt{\pi} \over 2} e^{-z^2} {\rm erf} (iz)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	899 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	900 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	901 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	902
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	903 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	904 (sqrt (pi) / 2) * exp (-z^2) * erfi (z)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	905 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	906
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	907 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	908 @seealso{erfc, erf, erfcx, erfi, erfinv, erfcinv}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	909 @end deftypefn */)
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	910 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	911 if (args.length () != 1)
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	912 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	913
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	914 return ovl (args(0).dawson ());
15696 2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	915 }
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	916
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	917 /*
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	918
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	919 %!test
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	920 %! x = [0.1, 1, 1+2i,-1+2i,1e-4+2e-4i,0+2i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	921 %! v = [0.099335992397852861, 0.53807950691, -13.38892731648-11.828715104i, 13.38892731648-11.828715104i, 0.0001000000073333+0.000200000001333i, 48.160012114291i];
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	922 %! assert (dawson (x), v, -1.e-10);
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	923 %! assert (dawson (-x), -v, -1.e-10);
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	924
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	925 %!error dawson ()
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	926 %!error dawson (1, 2)
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	927 */
2fac72a256ce Add complex erf,erfc,erfcx,erfi,dawson routines from Faddeeva package. Steven G. Johnson <stevenj@alum.mit.edu> parents: 15500 diff changeset	928
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	929 DEFUN (exp, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	930 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	931 @deftypefn {} {} exp (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	932 Compute
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	933 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	934 $e^{x}$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	935 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	936 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	937 @code{e^x}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	938 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	939 for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	940
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	941 To compute the matrix exponential, see @ref{Linear Algebra}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	942 @seealso{log}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	943 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	944 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	945 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	946 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	947
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	948 return ovl (args(0).exp ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	949 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	950
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	951 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	952 %!assert (exp ([0, 1, -1, -1000]), [1, e, 1/e, 0], sqrt (eps))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	953 %!assert (exp (1+i), e * (cos (1) + sin (1) * i), sqrt (eps))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	954 %!assert (exp (single ([0, 1, -1, -1000])), single ([1, e, 1/e, 0]), sqrt (eps ("single")))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	955 %!assert (exp (single (1+i)), single (e * (cos (1) + sin (1) * i)), sqrt (eps ("single")))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	956
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	957 %!assert (exp ([Inf, -Inf, NaN]), [Inf 0 NaN])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	958 %!assert (exp (single ([Inf, -Inf, NaN])), single ([Inf 0 NaN]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	959
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	960 %!error exp ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	961 %!error exp (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	962 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	963
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	964 DEFUN (expm1, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	965 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	966 @deftypefn {} {} expm1 (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	967 Compute
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	968 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	969 $ e^{x} - 1 $
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	970 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	971 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	972 @code{exp (@var{x}) - 1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	973 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	974 accurately in the neighborhood of zero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	975 @seealso{exp}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	976 @end deftypefn */)
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	977 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	978 if (args.length () != 1)
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	979 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	980
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	981 return ovl (args(0).expm1 ());
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	982 }
2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	983
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	984 /*
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	985 %!assert (expm1 (2eps), 2eps, 1e-29)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	986
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	987 %!assert (expm1 ([Inf, -Inf, NaN]), [Inf -1 NaN])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	988 %!assert (expm1 (single ([Inf, -Inf, NaN])), single ([Inf -1 NaN]))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	989
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	990 %!error expm1 ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	991 %!error expm1 (1, 2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	992 */
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	993
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11327 diff changeset	994 DEFUN (isfinite, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	995 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	996 @deftypefn {} {} isfinite (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	997 Return a logical array which is true where the elements of @var{x} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	998 finite values and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	999
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1000 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1001
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1002 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1003 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1004 isfinite ([13, Inf, NA, NaN])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1005 @result{} [ 1, 0, 0, 0 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1006 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1007 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1008 @seealso{isinf, isnan, isna}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1009 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1010 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1011 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1012 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1013
21013 7f4c6d594e3d Finish renaming mapper function finite to isfinite. Rik <rik@octave.org> parents: 20955 diff changeset	1014 return ovl (args(0).isfinite ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1015 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1016
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1017 /*
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1018 %!assert (! isfinite (Inf))
77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1019 %!assert (! isfinite (NaN))
19117 a4c226a963c5 Deprecate finite in favor of isfinite. Rik <rik@octave.org> parents: 18812 diff changeset	1020 %!assert (isfinite (rand (1,10)))
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1021
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1022 %!assert (! isfinite (single (Inf)))
77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1023 %!assert (! isfinite (single (NaN)))
19117 a4c226a963c5 Deprecate finite in favor of isfinite. Rik <rik@octave.org> parents: 18812 diff changeset	1024 %!assert (isfinite (single (rand (1,10))))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1025
19117 a4c226a963c5 Deprecate finite in favor of isfinite. Rik <rik@octave.org> parents: 18812 diff changeset	1026 %!error isfinite ()
a4c226a963c5 Deprecate finite in favor of isfinite. Rik <rik@octave.org> parents: 18812 diff changeset	1027 %!error isfinite (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1028 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1029
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1030 DEFUN (fix, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1031 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1032 @deftypefn {} {} fix (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1033 Truncate fractional portion of @var{x} and return the integer portion.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1034
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1035 This is equivalent to rounding towards zero. If @var{x} is complex, return
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1036 @code{fix (real (@var{x})) + fix (imag (@var{x})) * I}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1037
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1038 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1039 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1040 fix ([-2.7, 2.7])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1041 @result{} -2 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1042 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1043 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1044 @seealso{ceil, floor, round}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1045 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1046 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1047 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1048 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1049
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1050 return ovl (args(0).fix ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1051 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1052
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1053 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1054 %!assert (fix ([1.1, 1, -1.1, -1]), [1, 1, -1, -1])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1055 %!assert (fix ([1.1+1.1i, 1+i, -1.1-1.1i, -1-i]), [1+i, 1+i, -1-i, -1-i])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1056 %!assert (fix (single ([1.1, 1, -1.1, -1])), single ([1, 1, -1, -1]))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1057 %!assert (fix (single ([1.1+1.1i, 1+i, -1.1-1.1i, -1-i])), single ([1+i, 1+i, -1-i, -1-i]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1058
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1059 %!error fix ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1060 %!error fix (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1061 */
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1062
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1063 DEFUN (floor, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1064 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1065 @deftypefn {} {} floor (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1066 Return the largest integer not greater than @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1067
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1068 This is equivalent to rounding towards negative infinity. If @var{x} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1069 complex, return @code{floor (real (@var{x})) + floor (imag (@var{x})) * I}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1070
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1071 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1072 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1073 floor ([-2.7, 2.7])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1074 @result{} -3 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1075 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1076 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1077 @seealso{ceil, round, fix}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1078 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1079 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1080 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1081 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1082
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1083 return ovl (args(0).floor ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1084 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1085
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1086 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1087 %!assert (floor ([2, 1.1, -1.1, -1]), [2, 1, -2, -1])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1088 %!assert (floor ([2+2i, 1.1+1.1i, -1.1-1.1i, -1-i]), [2+2i, 1+i, -2-2i, -1-i])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1089 %!assert (floor (single ([2, 1.1, -1.1, -1])), single ([2, 1, -2, -1]))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1090 %!assert (floor (single ([2+2i, 1.1+1.1i, -1.1-1.1i, -1-i])), single ([2+2i, 1+i, -2-2i, -1-i]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1091
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1092 %!error floor ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1093 %!error floor (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1094 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1095
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1096 DEFUN (gamma, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1097 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1098 @deftypefn {} {} gamma (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1099 Compute the Gamma function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1100
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1101 The Gamma function is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1102 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1103 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1104 \Gamma (z) = \int_0^\infty t^{z-1} e^{-t} dt.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1105 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1106 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1107 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1108
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1109 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1110 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1111 infinity
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1112 /
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1113 gamma (z) = \| t^(z-1) exp (-t) dt.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1114 /
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1115 t=0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1116 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1117 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1118
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1119 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1120
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1121 Programming Note: The gamma function can grow quite large even for small
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1122 input values. In many cases it may be preferable to use the natural
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1123 logarithm of the gamma function (@code{gammaln}) in calculations to minimize
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1124 loss of precision. The final result is then
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1125 @code{exp (@var{result_using_gammaln}).}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1126 @seealso{gammainc, gammaln, factorial}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1127 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1128 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1129 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1130 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1131
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1132 return ovl (args(0).gamma ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1133 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1134
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1135 /*
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1136 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1137 %! a = -1isqrt (-1/(6.41876.4187));
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1138 %! assert (gamma (a), gamma (real (a)));
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1139
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1140 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1141 %! x = [.5, 1, 1.5, 2, 3, 4, 5];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1142 %! v = [sqrt(pi), 1, .5*sqrt(pi), 1, 2, 6, 24];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1143 %! assert (gamma (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1144
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1145 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1146 %! a = single (-1isqrt (-1/(6.41876.4187)));
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1147 %! assert (gamma (a), gamma (real (a)));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1148
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1149 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1150 %! x = single ([.5, 1, 1.5, 2, 3, 4, 5]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1151 %! v = single ([sqrt(pi), 1, .5*sqrt(pi), 1, 2, 6, 24]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1152 %! assert (gamma (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1153
10903 9f0f1a89c704 Add new %!tests for negative integer arguments to gamma, lgamma. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	1154 %!test
17708 f10b7a578e2c Correct return values of gamma() (see Numerical, item 3 on Projects page). Craig Hudson <c_hudson_phd@hotmail.com> parents: 16816 diff changeset	1155 %! ## Test exceptional values
f10b7a578e2c Correct return values of gamma() (see Numerical, item 3 on Projects page). Craig Hudson <c_hudson_phd@hotmail.com> parents: 16816 diff changeset	1156 %! x = [-Inf, -1, -0, 0, 1, Inf, NaN];
19357 c6437824681c improve Matlab compatibility for gamma function (bug #43551) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	1157 %! v = [Inf, Inf, -Inf, Inf, 1, Inf, NaN];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1158 %! assert (gamma (x), v);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1159 %! assert (gamma (single (x)), single (v));
10903 9f0f1a89c704 Add new %!tests for negative integer arguments to gamma, lgamma. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	1160
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1161 %!error gamma ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1162 %!error gamma (1, 2)
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1163 */
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1164
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1165 DEFUN (imag, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1166 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1167 @deftypefn {} {} imag (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1168 Return the imaginary part of @var{z} as a real number.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1169 @seealso{real, conj}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1170 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1171 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1172 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1173 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1174
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1175 return ovl (args(0).imag ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1176 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1177
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1178 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1179 %!assert (imag (1), 0)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1180 %!assert (imag (i), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1181 %!assert (imag (1+i), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1182 %!assert (imag ([i, 1; 1, i]), full (eye (2)))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1183
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1184 %!assert (imag (single (1)), single (0))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1185 %!assert (imag (single (i)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1186 %!assert (imag (single (1+i)), single (1))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1187 %!assert (imag (single ([i, 1; 1, i])), full (eye (2,"single")))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1188
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1189 %!error imag ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1190 %!error imag (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1191 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1192
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1193 DEFUNX ("isalnum", Fisalnum, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1194 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1195 @deftypefn {} {} isalnum (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1196 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1197 letters or digits and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1198
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1199 This is equivalent to (@code{isalpha (@var{s}) \| isdigit (@var{s})}).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1200 @seealso{isalpha, isdigit, ispunct, isspace, iscntrl}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1201 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1202 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1203 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1204 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1205
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1206 return ovl (args(0).xisalnum ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1207 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1208
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1209 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1210 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1211 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1212 %! result = false (1, 128);
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1213 %! result(double ("A":"Z") + 1) = true;
f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1214 %! result(double ("0":"9") + 1) = true;
f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1215 %! result(double ("a":"z") + 1) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1216 %! assert (isalnum (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1217 %!assert (isalnum(["Ä8Aa?"; "(Uß ;"]), logical ([1 1 1 1 1 0; 0 1 1 1 0 0]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1218
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1219 %!error isalnum ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1220 %!error isalnum (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1221 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1222
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1223 DEFUNX ("isalpha", Fisalpha, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1224 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1225 @deftypefn {} {} isalpha (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1226 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1227 letters and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1228
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1229 This is equivalent to (@code{islower (@var{s}) \| isupper (@var{s})}).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1230 @seealso{isdigit, ispunct, isspace, iscntrl, isalnum, islower, isupper}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1231 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1232 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1233 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1234 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1235
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1236 return ovl (args(0).xisalpha ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1237 }
2089 4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe] jwe parents: 1996 diff changeset	1238
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1239 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1240 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1241 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1242 %! result = false (1, 128);
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1243 %! result(double ("A":"Z") + 1) = true;
f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1244 %! result(double ("a":"z") + 1) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1245 %! assert (isalpha (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1246 %!assert (isalpha("Ä8Aa(Uß ;"), logical ([1 1 0 1 1 0 1 1 1 0 0]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1247
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1248 %!error isalpha ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1249 %!error isalpha (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1250 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1251
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1252 DEFUNX ("isascii", Fisascii, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1253 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1254 @deftypefn {} {} isascii (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1255 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1256 ASCII characters (in the range 0 to 127 decimal) and false where they are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1257 not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1258 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1259 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1260 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1261 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1262
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1263 return ovl (args(0).xisascii ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1264 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1265
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1266 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1267 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1268 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1269 %! result = true (1, 128);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1270 %! assert (isascii (charset), result);
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1271
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1272 %!error isascii ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1273 %!error isascii (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1274 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1275
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1276 DEFUNX ("iscntrl", Fiscntrl, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1277 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1278 @deftypefn {} {} iscntrl (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1279 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1280 control characters and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1281 @seealso{ispunct, isspace, isalpha, isdigit}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1282 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1283 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1284 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1285 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1286
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1287 return ovl (args(0).xiscntrl ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1288 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1289
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1290 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1291 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1292 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1293 %! result = false (1, 128);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1294 %! result(1:32) = true;
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1295 %! result(128) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1296 %! assert (iscntrl (charset), result);
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1297
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1298 %!error iscntrl ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1299 %!error iscntrl (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1300 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1301
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1302 DEFUNX ("isdigit", Fisdigit, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1303 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1304 @deftypefn {} {} isdigit (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1305 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1306 decimal digits (0-9) and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1307 @seealso{isxdigit, isalpha, isletter, ispunct, isspace, iscntrl}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1308 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1309 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1310 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1311 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1312
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1313 return ovl (args(0).xisdigit ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1314 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1315
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1316 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1317 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1318 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1319 %! result = false (1, 128);
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1320 %! result(double ("0":"9") + 1) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1321 %! assert (isdigit (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1322 %!assert (isdigit("Ä8Aa(Uß ;"), logical ([0 0 1 0 0 0 0 0 0 0 0]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1323
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1324 %!error isdigit ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1325 %!error isdigit (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1326 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1327
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1328 DEFUN (isinf, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1329 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1330 @deftypefn {} {} isinf (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1331 Return a logical array which is true where the elements of @var{x} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1332 infinite and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1333
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1334 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1335
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1336 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1337 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1338 isinf ([13, Inf, NA, NaN])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1339 @result{} [ 0, 1, 0, 0 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1340 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1341 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1342 @seealso{isfinite, isnan, isna}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1343 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1344 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1345 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1346 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1347
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1348 return ovl (args(0).isinf ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1349 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1350
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1351 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1352 %!assert (isinf (Inf))
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1353 %!assert (! isinf (NaN))
77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1354 %!assert (! isinf (NA))
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14817 diff changeset	1355 %!assert (isinf (rand (1,10)), false (1,10))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1356 %!assert (isinf ([NaN -Inf -1 0 1 Inf NA]), [false, true, false, false, false, true, false])
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1357
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1358 %!assert (isinf (single (Inf)))
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1359 %!assert (! isinf (single (NaN)))
77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1360 %!assert (! isinf (single (NA)))
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14817 diff changeset	1361 %!assert (isinf (single (rand (1,10))), false (1,10))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1362 %!assert (isinf (single ([NaN -Inf -1 0 1 Inf NA])), [false, true, false, false, false, true, false])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1363
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1364 %!error isinf ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1365 %!error isinf (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1366 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1367
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1368 DEFUNX ("isgraph", Fisgraph, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1369 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1370 @deftypefn {} {} isgraph (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1371 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1372 printable characters (but not the space character) and false where they are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1373 not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1374 @seealso{isprint}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1375 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1376 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1377 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1378 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1379
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1380 return ovl (args(0).xisgraph ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1381 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1382
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1383 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1384 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1385 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1386 %! result = false (1, 128);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1387 %! result(34:127) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1388 %! assert (isgraph (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1389 %!assert (isgraph("Ä8Aa(Uß ;"), logical ([1 1 1 1 1 1 1 1 1 0 1]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1390
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1391 %!error isgraph ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1392 %!error isgraph (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1393 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1394
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1395 DEFUNX ("islower", Fislower, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1396 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1397 @deftypefn {} {} islower (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1398 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1399 lowercase letters and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1400 @seealso{isupper, isalpha, isletter, isalnum}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1401 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1402 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1403 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1404 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1405
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1406 return ovl (args(0).xislower ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1407 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1408
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1409 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1410 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1411 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1412 %! result = false (1, 128);
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1413 %! result(double ("a":"z") + 1) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1414 %! assert (islower (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1415 %!assert (islower("Ä8Aa(Uß ;"), logical ([0 0 0 0 1 0 0 1 1 0 0]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1416
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1417 %!error islower ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1418 %!error islower (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1419 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1420
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1421 DEFUN (isna, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1422 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1423 @deftypefn {} {} isna (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1424 Return a logical array which is true where the elements of @var{x} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1425 NA (missing) values and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1426
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1427 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1428
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1429 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1430 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1431 isna ([13, Inf, NA, NaN])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1432 @result{} [ 0, 0, 1, 0 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1433 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1434 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1435 @seealso{isnan, isinf, isfinite}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1436 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1437 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1438 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1439 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1440
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1441 return ovl (args(0).isna ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1442 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1443
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1444 /*
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1445 %!assert (! isna (Inf))
77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1446 %!assert (! isna (NaN))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1447 %!assert (isna (NA))
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14817 diff changeset	1448 %!assert (isna (rand (1,10)), false (1,10))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1449 %!assert (isna ([NaN -Inf -1 0 1 Inf NA]), [false, false, false, false, false, false, true])
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1450
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1451 %!assert (! isna (single (Inf)))
77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1452 %!assert (! isna (single (NaN)))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1453 %!assert (isna (single (NA)))
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14817 diff changeset	1454 %!assert (isna (single (rand (1,10))), false (1,10))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1455 %!assert (isna (single ([NaN -Inf -1 0 1 Inf NA])), [false, false, false, false, false, false, true])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1456
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1457 %!error isna ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1458 %!error isna (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1459 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1460
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1461 DEFUN (isnan, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1462 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1463 @deftypefn {} {} isnan (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1464 Return a logical array which is true where the elements of @var{x} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1465 NaN values and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1466
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1467 NA values are also considered NaN values. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1468
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1469 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1470 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1471 isnan ([13, Inf, NA, NaN])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1472 @result{} [ 0, 0, 1, 1 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1473 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1474 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1475 @seealso{isna, isinf, isfinite}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1476 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1477 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1478 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1479 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1480
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1481 return ovl (args(0).isnan ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1482 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1483
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1484 /*
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1485 %!assert (! isnan (Inf))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1486 %!assert (isnan (NaN))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1487 %!assert (isnan (NA))
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14817 diff changeset	1488 %!assert (isnan (rand (1,10)), false (1,10))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1489 %!assert (isnan ([NaN -Inf -1 0 1 Inf NA]), [true, false, false, false, false, false, true])
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1490
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	1491 %!assert (! isnan (single (Inf)))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1492 %!assert (isnan (single (NaN)))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1493 %!assert (isnan (single (NA)))
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14817 diff changeset	1494 %!assert (isnan (single (rand (1,10))), false (1,10))
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1495 %!assert (isnan (single ([NaN -Inf -1 0 1 Inf NA])), [true, false, false, false, false, false, true])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1496
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1497 %!error isnan ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1498 %!error isnan (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1499 */
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7667 diff changeset	1500
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1501 DEFUNX ("isprint", Fisprint, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1502 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1503 @deftypefn {} {} isprint (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1504 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1505 printable characters (including the space character) and false where they
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1506 are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1507 @seealso{isgraph}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1508 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1509 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1510 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1511 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1512
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1513 return ovl (args(0).xisprint ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1514 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1515
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1516 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1517 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1518 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1519 %! result = false (1, 128);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1520 %! result(33:127) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1521 %! assert (isprint (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1522 %!assert (isprint("Ä8Aa(Uß ;"), logical ([1 1 1 1 1 1 1 1 1 1 1]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1523
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1524 %!error isprint ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1525 %!error isprint (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1526 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1527
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1528 DEFUNX ("ispunct", Fispunct, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1529 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1530 @deftypefn {} {} ispunct (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1531 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1532 punctuation characters and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1533 @seealso{isalpha, isdigit, isspace, iscntrl}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1534 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1535 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1536 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1537 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1538
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1539 return ovl (args(0).xispunct ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1540 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1541
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1542 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1543 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1544 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1545 %! result = false (1, 128);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1546 %! result(34:48) = true;
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1547 %! result(59:65) = true;
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1548 %! result(92:97) = true;
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1549 %! result(124:127) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1550 %! assert (ispunct (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1551 %!assert (ispunct("Ä8Aa(Uß ;"), logical ([0 0 0 0 0 1 0 0 0 0 1]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1552
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1553 %!error ispunct ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1554 %!error ispunct (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1555 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1556
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1557 DEFUNX ("isspace", Fisspace, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1558 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1559 @deftypefn {} {} isspace (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1560 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1561 whitespace characters (space, formfeed, newline, carriage return, tab, and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1562 vertical tab) and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1563 @seealso{iscntrl, ispunct, isalpha, isdigit}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1564 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1565 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1566 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1567 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1568
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1569 return ovl (args(0).xisspace ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1570 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1571
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1572 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1573 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1574 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1575 %! result = false (1, 128);
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1576 %! result(double (" \f\n\r\t\v") + 1) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1577 %! assert (isspace (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1578 %!assert (isspace("Ä8Aa(Uß ;"), logical ([0 0 0 0 0 0 0 0 0 1 0]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1579
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1580 %!error isspace ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1581 %!error isspace (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1582 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1583
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1584 DEFUNX ("isupper", Fisupper, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1585 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1586 @deftypefn {} {} isupper (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1587 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1588 uppercase letters and false where they are not.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1589 @seealso{islower, isalpha, isletter, isalnum}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1590 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1591 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1592 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1593 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1594
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1595 return ovl (args(0).xisupper ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1596 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1597
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1598 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1599 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1600 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1601 %! result = false (1, 128);
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1602 %! result(double ("A":"Z") + 1) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1603 %! assert (isupper (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1604 %!assert (isupper("Ä8Aa(Uß ;"), logical ([1 1 0 1 0 0 1 0 0 0 0]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1605
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1606 %!error isupper ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1607 %!error isupper (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1608 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1609
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	1610 DEFUNX ("isxdigit", Fisxdigit, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1611 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1612 @deftypefn {} {} isxdigit (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1613 Return a logical array which is true where the elements of @var{s} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1614 hexadecimal digits (0-9 and @nospell{a-fA-F}).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1615 @seealso{isdigit}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1616 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1617 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1618 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1619 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1620
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1621 return ovl (args(0).xisxdigit ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1622 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1623
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1624 /*
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1625 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	1626 %! charset = char (0:127);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1627 %! result = false (1, 128);
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1628 %! result(double ("A":"F") + 1) = true;
f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1629 %! result(double ("0":"9") + 1) = true;
f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	1630 %! result(double ("a":"f") + 1) = true;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1631 %! assert (isxdigit (charset), result);
25415 d4bc8590b5cf Make "is" string functions Unicode aware. Markus Mützel <markus.muetzel@gmx.de>* parents: 25413 diff changeset	1632 %!assert (isxdigit("Ä8Aa(Uß ;"), logical ([0 0 1 1 1 0 0 0 0 0 0]));
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1633
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1634 %!error isxdigit ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1635 %!error isxdigit (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1636 */
98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1637
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1638 DEFUN (lgamma, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1639 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1640 @deftypefn {} {} gammaln (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1641 @deftypefnx {} {} lgamma (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1642 Return the natural logarithm of the gamma function of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1643 @seealso{gamma, gammainc}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1644 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1645 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1646 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1647 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1648
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1649 return ovl (args(0).lgamma ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1650 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1651
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1652 /*
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1653 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1654 %! a = -1isqrt (-1/(6.41876.4187));
19275 653ed3a6ba83 Use gammaln in preference to lgamma in core Octave code. Rik <rik@octave.org> parents: 19242 diff changeset	1655 %! assert (gammaln (a), gammaln (real (a)));
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1656
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1657 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1658 %! x = [.5, 1, 1.5, 2, 3, 4, 5];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1659 %! v = [sqrt(pi), 1, .5*sqrt(pi), 1, 2, 6, 24];
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21301 diff changeset	1660 %! assert (gammaln (x), log (v), sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1661
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1662 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1663 %! a = single (-1isqrt (-1/(6.41876.4187)));
19275 653ed3a6ba83 Use gammaln in preference to lgamma in core Octave code. Rik <rik@octave.org> parents: 19242 diff changeset	1664 %! assert (gammaln (a), gammaln (real (a)));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1665
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1666 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1667 %! x = single ([.5, 1, 1.5, 2, 3, 4, 5]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1668 %! v = single ([sqrt(pi), 1, .5*sqrt(pi), 1, 2, 6, 24]);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21301 diff changeset	1669 %! assert (gammaln (x), log (v), sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1670
10903 9f0f1a89c704 Add new %!tests for negative integer arguments to gamma, lgamma. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	1671 %!test
9f0f1a89c704 Add new %!tests for negative integer arguments to gamma, lgamma. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	1672 %! x = [-1, 0, 1, Inf];
9f0f1a89c704 Add new %!tests for negative integer arguments to gamma, lgamma. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	1673 %! v = [Inf, Inf, 0, Inf];
19275 653ed3a6ba83 Use gammaln in preference to lgamma in core Octave code. Rik <rik@octave.org> parents: 19242 diff changeset	1674 %! assert (gammaln (x), v);
653ed3a6ba83 Use gammaln in preference to lgamma in core Octave code. Rik <rik@octave.org> parents: 19242 diff changeset	1675 %! assert (gammaln (single (x)), single (v));
10903 9f0f1a89c704 Add new %!tests for negative integer arguments to gamma, lgamma. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	1676
19275 653ed3a6ba83 Use gammaln in preference to lgamma in core Octave code. Rik <rik@octave.org> parents: 19242 diff changeset	1677 %!error gammaln ()
653ed3a6ba83 Use gammaln in preference to lgamma in core Octave code. Rik <rik@octave.org> parents: 19242 diff changeset	1678 %!error gammaln (1,2)
7667 fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1679 */
fb3a6c53c2b2 Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function David Bateman <dbateman@free.fr> parents: 7638 diff changeset	1680
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1681 DEFUN (log, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1682 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1683 @deftypefn {} {} log (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1684 Compute the natural logarithm,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1685 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1686 $\ln{(x)},$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1687 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1688 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1689 @code{ln (@var{x})},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1690 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1691 for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1692
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1693 To compute the matrix logarithm, see @ref{Linear Algebra}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1694 @seealso{exp, log1p, log2, log10, logspace}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1695 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1696 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1697 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1698 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1699
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1700 return ovl (args(0).log ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1701 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1702
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1703 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1704 %!assert (log ([1, e, e^2]), [0, 1, 2], sqrt (eps))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1705 %!assert (log ([-0.5, -1.5, -2.5]), log ([0.5, 1.5, 2.5]) + pi*1i, sqrt (eps))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1706
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1707 %!assert (log (single ([1, e, e^2])), single ([0, 1, 2]), sqrt (eps ("single")))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1708 %!assert (log (single ([-0.5, -1.5, -2.5])), single (log ([0.5, 1.5, 2.5]) + pi1i), 4eps ("single"))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1709
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1710 %!error log ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1711 %!error log (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	1712 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1713
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1714 DEFUN (log10, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1715 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1716 @deftypefn {} {} log10 (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1717 Compute the base-10 logarithm of each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1718 @seealso{log, log2, logspace, exp}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1719 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1720 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1721 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1722 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1723
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1724 return ovl (args(0).log10 ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1725 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1726
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1727 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1728 %!assert (log10 ([0.01, 0.1, 1, 10, 100]), [-2, -1, 0, 1, 2], sqrt (eps))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1729 %!assert (log10 (single ([0.01, 0.1, 1, 10, 100])), single ([-2, -1, 0, 1, 2]), sqrt (eps ("single")))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1730
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1731 %!error log10 ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1732 %!error log10 (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1733 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1734
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	1735 DEFUN (log1p, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1736 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1737 @deftypefn {} {} log1p (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1738 Compute
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1739 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1740 $\ln{(1 + x)}$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1741 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1742 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1743 @code{log (1 + @var{x})}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1744 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1745 accurately in the neighborhood of zero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1746 @seealso{log, exp, expm1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1747 @end deftypefn */)
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	1748 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1749 if (args.length () != 1)
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	1750 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1751
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1752 return ovl (args(0).log1p ());
7638 2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	1753 }
2df457529cfa implement expm1 and log1p functions Jaroslav Hajek <highegg@gmail.com> parents: 7636 diff changeset	1754
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1755 /*
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1756 %!assert (log1p ([0, 2eps, -2eps]), [0, 2eps, -2eps], 1e-29)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1757 %!assert (log1p (single ([0, 2eps, -2eps])), single ([0, 2eps, -2eps]), 1e-29)
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1758
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1759 %!error log1p ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1760 %!error log1p (1, 2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1761 */
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1762
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1763 DEFUN (real, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1764 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1765 @deftypefn {} {} real (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1766 Return the real part of @var{z}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1767 @seealso{imag, conj}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1768 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1769 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1770 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1771 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1772
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1773 return ovl (args(0).real ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1774 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1775
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1776 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1777 %!assert (real (1), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1778 %!assert (real (i), 0)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1779 %!assert (real (1+i), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1780 %!assert (real ([1, i; i, 1]), full (eye (2)))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1781
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1782 %!assert (real (single (1)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1783 %!assert (real (single (i)), single (0))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1784 %!assert (real (single (1+i)), single (1))
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1785 %!assert (real (single ([1, i; i, 1])), full (eye (2, "single")))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1786
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1787 %!error real ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1788 %!error real (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1789 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1790
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1791 DEFUN (round, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1792 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1793 @deftypefn {} {} round (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1794 Return the integer nearest to @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1795
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1796 If @var{x} is complex, return
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1797 @code{round (real (@var{x})) + round (imag (@var{x})) * I}. If there
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1798 are two nearest integers, return the one further away from zero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1799
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1800 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1801 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1802 round ([-2.7, 2.7])
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1803 @result{} -3 3
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1804 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1805 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1806 @seealso{ceil, floor, fix, roundb}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1807 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1808 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1809 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1810 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1811
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1812 return ovl (args(0).round ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1813 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1814
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1815 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1816 %!assert (round (1), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1817 %!assert (round (1.1), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1818 %!assert (round (5.5), 6)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1819 %!assert (round (i), i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1820 %!assert (round (2.5+3.5i), 3+4i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1821 %!assert (round (-2.6), -3)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1822 %!assert (round ([1.1, -2.4; -3.7, 7.1]), [1, -2; -4, 7])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1823
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1824 %!assert (round (single (1)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1825 %!assert (round (single (1.1)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1826 %!assert (round (single (5.5)), single (6))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1827 %!assert (round (single (i)), single (i))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1828 %!assert (round (single (2.5+3.5i)), single (3+4i))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1829 %!assert (round (single (-2.6)), single (-3))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1830 %!assert (round (single ([1.1, -2.4; -3.7, 7.1])), single ([1, -2; -4, 7]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1831
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1832 %!error round ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1833 %!error round (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1834 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1835
7636 99c410f7f0b0 implement mapper function for banker's rounding Jaroslav Hajek <highegg@gmail.com> parents: 7601 diff changeset	1836 DEFUN (roundb, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1837 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1838 @deftypefn {} {} roundb (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1839 Return the integer nearest to @var{x}. If there are two nearest
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1840 integers, return the even one (banker's rounding).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1841
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1842 If @var{x} is complex,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1843 return @code{roundb (real (@var{x})) + roundb (imag (@var{x})) * I}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1844 @seealso{round}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1845 @end deftypefn */)
7636 99c410f7f0b0 implement mapper function for banker's rounding Jaroslav Hajek <highegg@gmail.com> parents: 7601 diff changeset	1846 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1847 if (args.length () != 1)
7636 99c410f7f0b0 implement mapper function for banker's rounding Jaroslav Hajek <highegg@gmail.com> parents: 7601 diff changeset	1848 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1849
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1850 return ovl (args(0).roundb ());
7636 99c410f7f0b0 implement mapper function for banker's rounding Jaroslav Hajek <highegg@gmail.com> parents: 7601 diff changeset	1851 }
99c410f7f0b0 implement mapper function for banker's rounding Jaroslav Hajek <highegg@gmail.com> parents: 7601 diff changeset	1852
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1853 /*
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1854 %!assert (roundb (1), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1855 %!assert (roundb (1.1), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1856 %!assert (roundb (1.5), 2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1857 %!assert (roundb (4.5), 4)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1858 %!assert (roundb (i), i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1859 %!assert (roundb (2.5+3.5i), 2+4i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1860 %!assert (roundb (-2.6), -3)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1861 %!assert (roundb ([1.1, -2.4; -3.7, 7.1]), [1, -2; -4, 7])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1862
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1863 %!assert (roundb (single (1)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1864 %!assert (roundb (single (1.1)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1865 %!assert (roundb (single (1.5)), single (2))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1866 %!assert (roundb (single (4.5)), single (4))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1867 %!assert (roundb (single (i)), single (i))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1868 %!assert (roundb (single (2.5+3.5i)), single (2+4i))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1869 %!assert (roundb (single (-2.6)), single (-3))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1870 %!assert (roundb (single ([1.1, -2.4; -3.7, 7.1])), single ([1, -2; -4, 7]))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1871
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1872 %!error roundb ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1873 %!error roundb (1, 2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1874 */
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1875
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1876 DEFUN (sign, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1877 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1878 @deftypefn {} {} sign (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1879 Compute the @dfn{signum} function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1880
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1881 This is defined as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1882 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1883 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1884 {\rm sign} (@var{x}) = \cases{1,&$x>0$;\cr 0,&$x=0$;\cr -1,&$x<0$.\cr}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1885 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1886 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1887 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1888
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1889 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1890 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1891 -1, x < 0;
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1892 sign (x) = 0, x = 0;
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1893 1, x > 0.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1894 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1895 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1896
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1897 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1898
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1899 For complex arguments, @code{sign} returns @code{x ./ abs (@var{x})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1900
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1901 Note that @code{sign (-0.0)} is 0. Although IEEE 754 floating point
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1902 allows zero to be signed, 0.0 and -0.0 compare equal. If you must test
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1903 whether zero is signed, use the @code{signbit} function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1904 @seealso{signbit}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1905 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1906 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1907 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1908 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1909
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1910 return ovl (args(0).signum ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1911 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1912
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1913 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1914 %!assert (sign (-2) , -1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1915 %!assert (sign (0), 0)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1916 %!assert (sign (3), 1)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1917 %!assert (sign ([1, -pi; e, 0]), [1, -1; 1, 0])
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1918
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1919 %!assert (sign (single (-2)) , single (-1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1920 %!assert (sign (single (0)), single (0))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1921 %!assert (sign (single (3)), single (1))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1922 %!assert (sign (single ([1, -pi; e, 0])), single ([1, -1; 1, 0]))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1923
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1924 %!error sign ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1925 %!error sign (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1926 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1927
15487 ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1928 DEFUNX ("signbit", Fsignbit, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1929 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1930 @deftypefn {} {} signbit (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1931 Return logical true if the value of @var{x} has its sign bit set and false
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1932 otherwise.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1933
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1934 This behavior is consistent with the other logical functions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1935 See @ref{Logical Values}. The behavior differs from the C language function
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1936 which returns nonzero if the sign bit is set.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1937
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1938 This is not the same as @code{x < 0.0}, because IEEE 754 floating point
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1939 allows zero to be signed. The comparison @code{-0.0 < 0.0} is false,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1940 but @code{signbit (-0.0)} will return a nonzero value.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1941 @seealso{sign}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1942 @end deftypefn */)
15487 ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1943 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1944 if (args.length () != 1)
15487 ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1945 print_usage ();
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1946
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1947 octave_value tmp = args(0).xsignbit ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1948
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1949 return ovl (tmp != 0);
15487 ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1950 }
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1951
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1952 /*
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1953 %!assert (signbit (1) == 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1954 %!assert (signbit (-2) != 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1955 %!assert (signbit (0) == 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1956 %!assert (signbit (-0) != 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1957
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1958 %!assert (signbit (single (1)) == 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1959 %!assert (signbit (single (-2)) != 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1960 %!assert (signbit (single (0)) == 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1961 %!assert (signbit (single (-0)) != 0)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1962
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1963 %!error sign ()
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1964 %!error sign (1, 2)
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1965 */
ecf5be238b4a provide signbit mapper for real values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	1966
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1967 DEFUN (sin, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1968 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1969 @deftypefn {} {} sin (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1970 Compute the sine for each element of @var{x} in radians.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1971 @seealso{asin, sind, sinh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	1972 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1973 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	1974 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1975 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	1976
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	1977 return ovl (args(0).sin ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1978 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1979
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1980 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1981 %!shared rt2, rt3
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1982 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1983 %! rt3 = sqrt (3);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1984
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1985 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1986 %! x = [0, pi/6, pi/4, pi/3, pi/2, 2pi/3, 3pi/4, 5*pi/6, pi];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1987 %! v = [0, 1/2, rt2/2, rt3/2, 1, rt3/2, rt2/2, 1/2, 0];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1988 %! assert (sin (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1989
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1990 %!test
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1991 %! x = single ([0, pi/6, pi/4, pi/3, pi/2, 2pi/3, 3pi/4, 5*pi/6, pi]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1992 %! v = single ([0, 1/2, rt2/2, rt3/2, 1, rt3/2, rt2/2, 1/2, 0]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	1993 %! assert (sin (x), v, sqrt (eps ("single")));
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1994
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1995 %!error sin ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	1996 %!error sin (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1997 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	1998
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	1999 DEFUN (sinh, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2000 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2001 @deftypefn {} {} sinh (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2002 Compute the hyperbolic sine for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2003 @seealso{asinh, cosh, tanh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2004 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2005 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	2006 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2007 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	2008
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	2009 return ovl (args(0).sinh ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2010 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2011
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2012 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2013 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2014 %! x = [0, pi/2i, pii, 3pi/2i];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2015 %! v = [0, i, 0, -i];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2016 %! assert (sinh (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2017
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2018 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2019 %! x = single ([0, pi/2i, pii, 3pi/2i]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2020 %! v = single ([0, i, 0, -i]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2021 %! assert (sinh (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2022
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2023 %!error sinh ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2024 %!error sinh (1, 2)
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	2025 */
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2026
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2027 DEFUN (sqrt, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2028 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2029 @deftypefn {} {} sqrt (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2030 Compute the square root of each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2031
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2032 If @var{x} is negative, a complex result is returned.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2033
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2034 To compute the matrix square root, see @ref{Linear Algebra}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2035 @seealso{realsqrt, nthroot}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2036 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2037 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	2038 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2039 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	2040
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	2041 return ovl (args(0).sqrt ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2042 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2043
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2044 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2045 %!assert (sqrt (4), 2)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2046 %!assert (sqrt (-1), i)
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2047 %!assert (sqrt (1+i), exp (0.5 * log (1+i)), sqrt (eps))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2048 %!assert (sqrt ([4, -4; i, 1-i]), [2, 2i; exp(0.5 * log (i)), exp(0.5 * log (1-i))], sqrt (eps))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2049
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2050 %!assert (sqrt (single (4)), single (2))
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2051 %!assert (sqrt (single (-1)), single (i))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2052 %!assert (sqrt (single (1+i)), single (exp (0.5 * log (1+i))), sqrt (eps ("single")))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2053 %!assert (sqrt (single ([4, -4; i, 1-i])), single ([2, 2i; exp(0.5 * log (i)), exp(0.5 * log (1-i))]), sqrt (eps ("single")))
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2054
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2055 %!error sqrt ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2056 %!error sqrt (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2057 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2058
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2059 DEFUN (tan, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2060 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2061 @deftypefn {} {} tan (@var{z})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2062 Compute the tangent for each element of @var{x} in radians.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2063 @seealso{atan, tand, tanh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2064 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2065 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	2066 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2067 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	2068
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	2069 return ovl (args(0).tan ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2070 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2071
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2072 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2073 %!shared rt2, rt3
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2074 %! rt2 = sqrt (2);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2075 %! rt3 = sqrt (3);
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2076
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2077 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2078 %! x = [0, pi/6, pi/4, pi/3, 2pi/3, 3pi/4, 5*pi/6, pi];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2079 %! v = [0, rt3/3, 1, rt3, -rt3, -1, -rt3/3, 0];
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2080 %! assert (tan (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2081
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2082 %!test
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2083 %! x = single ([0, pi/6, pi/4, pi/3, 2pi/3, 3pi/4, 5*pi/6, pi]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2084 %! v = single ([0, rt3/3, 1, rt3, -rt3, -1, -rt3/3, 0]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2085 %! assert (tan (x), v, sqrt (eps ("single")));
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2086
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2087 %!error tan ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2088 %!error tan (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2089 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2090
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2091 DEFUN (tanh, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2092 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2093 @deftypefn {} {} tanh (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2094 Compute hyperbolic tangent for each element of @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2095 @seealso{atanh, sinh, cosh}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2096 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2097 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	2098 if (args.length () != 1)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2099 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	2100
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	2101 return ovl (args(0).tanh ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2102 }
1562 1cff14ab83a4 [project @ 1995-10-12 11:02:40 by jwe] jwe parents: 1384 diff changeset	2103
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2104 /*
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2105 %!test
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2106 %! x = [0, pi*i];
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2107 %! v = [0, 0];
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2108 %! assert (tanh (x), v, sqrt (eps));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2109
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2110 %!test
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2111 %! x = single ([0, pi*i]);
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2112 %! v = single ([0, 0]);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2113 %! assert (tanh (x), v, sqrt (eps ("single")));
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2114
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2115 %!error tanh ()
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2116 %!error tanh (1, 2)
7815 a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2117 */
a41df65f3f00 Add some single precision test code and fix resulting bugs David Bateman <dbateman@free.fr> parents: 7814 diff changeset	2118
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	2119 DEFUNX ("tolower", Ftolower, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2120 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2121 @deftypefn {} {} tolower (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2122 @deftypefnx {} {} lower (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2123 Return a copy of the string or cell string @var{s}, with each uppercase
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2124 character replaced by the corresponding lowercase one; non-alphabetic
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2125 characters are left unchanged.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2126
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2127 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2128
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2129 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2130 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2131 tolower ("MiXeD cAsE 123")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2132 @result{} "mixed case 123"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2133 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2134 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2135 @seealso{toupper}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2136 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2137 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	2138 if (args.length () != 1)
12892 67bf9b30f3f9 Error when given non-string input to tolower, toupper, toascii (Bug #33537). Rik <octave@nomad.inbox5.com> parents: 12683 diff changeset	2139 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	2140
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	2141 return ovl (args(0).xtolower ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2142 }
8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2143
8387 1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2144 DEFALIAS (lower, tolower);
1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2145
1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2146 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2147 %!assert (tolower ("OCTAVE"), "octave")
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	2148 %!assert (tolower ("123OCTave! _&"), "123octave! _&")
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2149 %!assert (tolower ({"ABC", "DEF", {"GHI", {"JKL"}}}), {"abc", "def", {"ghi", {"jkl"}}})
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2150 %!assert (tolower (["ABC"; "DEF"]), ["abc"; "def"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2151 %!assert (tolower ({["ABC"; "DEF"]}), {["abc";"def"]})
25413 39cf8145405f Make "tolower" and "toupper" Unicode aware (bug #53873). Markus Mützel <markus.muetzel@gmx.de> parents: 25076 diff changeset	2152 %!assert (tolower (["ABCÄÖÜSS"; "abcäöüß"]), ["abcäöüss"; "abcäöüß"])
39cf8145405f Make "tolower" and "toupper" Unicode aware (bug #53873). Markus Mützel <markus.muetzel@gmx.de> parents: 25076 diff changeset	2153 %!assert (tolower (repmat ("ÄÖÜ", 2, 1, 3)), repmat ("äöü", 2, 1, 3))
18196 1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2154 %!assert (tolower (68), 68)
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2155 %!assert (tolower ({[68, 68; 68, 68]}), {[68, 68; 68, 68]})
24587 6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2156 %!assert (tolower (68i), 68i)
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2157 %!assert (tolower ({[68i, 68; 68, 68i]}), {[68i, 68; 68, 68i]})
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2158 %!assert (tolower (single (68i)), single (68i))
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2159 %!assert (tolower ({single([68i, 68; 68, 68i])}), {single([68i, 68; 68, 68i])})
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2160
18196 1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2161 %!test
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2162 %! classes = {@char, @double, @single, ...
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2163 %! @int8, @int16, @int32, @int64, ...
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2164 %! @uint8, @uint16, @uint32, @uint64};
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2165 %! for i = 1:numel (classes)
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2166 %! cls = classes{i};
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2167 %! assert (class (tolower (cls (97))), class (cls (97)));
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2168 %! assert (class (tolower (cls ([98, 99]))), class (cls ([98, 99])));
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2169 %! endfor
8387 1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2170 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2171 %! a(3,3,3,3) = "D";
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2172 %! assert (tolower (a)(3,3,3,3), "d");
8387 1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2173
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	2174 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	2175 %! charset = char (0:127);
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	2176 %! result = charset;
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	2177 %! result (double ("A":"Z") + 1) = result (double ("a":"z") + 1);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2178 %! assert (tolower (charset), result);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2179
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2180 %!error <Invalid call to tolower> lower ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2181 %!error <Invalid call to tolower> tolower ()
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2182 %!error tolower (1, 2)
8387 1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2183 */
1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2184
7528 26d8a92644de try to avoid ctype macro problems John W. Eaton <jwe@octave.org> parents: 7503 diff changeset	2185 DEFUNX ("toupper", Ftoupper, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2186 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2187 @deftypefn {} {} toupper (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2188 @deftypefnx {} {} upper (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2189 Return a copy of the string or cell string @var{s}, with each lowercase
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2190 character replaced by the corresponding uppercase one; non-alphabetic
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2191 characters are left unchanged.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2192
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2193 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2194
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2195 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2196 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2197 toupper ("MiXeD cAsE 123")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2198 @result{} "MIXED CASE 123"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2199 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2200 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2201 @seealso{tolower}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21945 diff changeset	2202 @end deftypefn */)
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2203 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20183 diff changeset	2204 if (args.length () != 1)
12892 67bf9b30f3f9 Error when given non-string input to tolower, toupper, toascii (Bug #33537). Rik <octave@nomad.inbox5.com> parents: 12683 diff changeset	2205 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	2206
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	2207 return ovl (args(0).xtoupper ());
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2208 }
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 3249 diff changeset	2209
8387 1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2210 DEFALIAS (upper, toupper);
1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2211
1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2212 /*
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2213 %!assert (toupper ("octave"), "OCTAVE")
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20939 diff changeset	2214 %!assert (toupper ("123OCTave! _&"), "123OCTAVE! _&")
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2215 %!assert (toupper ({"abc", "def", {"ghi", {"jkl"}}}), {"ABC", "DEF", {"GHI", {"JKL"}}})
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2216 %!assert (toupper (["abc"; "def"]), ["ABC"; "DEF"])
09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2217 %!assert (toupper ({["abc"; "def"]}), {["ABC";"DEF"]})
25413 39cf8145405f Make "tolower" and "toupper" Unicode aware (bug #53873). Markus Mützel <markus.muetzel@gmx.de> parents: 25076 diff changeset	2218 %!assert (toupper (["ABCÄÖÜSS"; "abcäöüß"]), ["ABCÄÖÜSS"; "ABCÄÖÜSS"])
39cf8145405f Make "tolower" and "toupper" Unicode aware (bug #53873). Markus Mützel <markus.muetzel@gmx.de> parents: 25076 diff changeset	2219 %!assert (toupper (repmat ("äöü", 2, 1, 3)), repmat ("ÄÖÜ", 2, 1, 3))
18196 1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2220 %!assert (toupper (100), 100)
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2221 %!assert (toupper ({[100, 100; 100, 100]}), {[100, 100; 100, 100]})
24587 6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2222 %!assert (toupper (100i), 100i)
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2223 %!assert (toupper ({[100i, 100; 100, 100i]}), {[100i, 100; 100, 100i]})
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2224 %!assert (toupper (single (100i)), single (100i))
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2225 %!assert (toupper ({single([100i, 100; 100, 100i])}),
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2226 %! {single([100i, 100; 100, 100i])})
6ece7c7e4912 tolower/toupper functions return complex numbers unchanged (bug #52380). Stevie Schraudner <stevietodd@hotmail.com> parents: 24555 diff changeset	2227
18196 1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2228 %!test
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2229 %! classes = {@char, @double, @single, ...
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2230 %! @int8, @int16, @int32, @int64, ...
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2231 %! @uint8, @uint16, @uint32, @uint64};
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2232 %! for i = 1:numel (classes)
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2233 %! cls = classes{i};
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2234 %! assert (class (toupper (cls (97))), class (cls (97)));
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2235 %! assert (class (toupper (cls ([98, 99]))), class (cls ([98, 99])));
1b6db9303933 allow toupper and tolower to handle numeric values (bug #33537) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	2236 %! endfor
8387 1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2237 %!test
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2238 %! a(3,3,3,3) = "d";
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2239 %! assert (toupper (a)(3,3,3,3), "D");
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	2240 %!test
13964 12fa52c6e886 Use char() instead of deprecated setstr() in %!test code. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	2241 %! charset = char (0:127);
13140 98d23b0f16e1 maint: move test_string.m tests to source files John W. Eaton <jwe@octave.org> parents: 13093 diff changeset	2242 %! result = charset;
24620 f5ad5d6f16fd Deprecate toascii function Rik <rik@octave.org> parents: 24587 diff changeset	2243 %! result (double ("a":"z") + 1) = result (double ("A":"Z") + 1);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2244 %! assert (toupper (charset), result);
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2245
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2246 %!error <Invalid call to toupper> toupper ()
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	2247 %!error <Invalid call to toupper> upper ()
13972 09432c6f23e7 mappers.cc: Update %!tests to modern coding standards Rik <octave@nomad.inbox5.com> parents: 13966 diff changeset	2248 %!error toupper (1, 2)
8387 1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2249 */
1567db1e166c make upper and lower aliases of toupper and tolower respectively Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8366 diff changeset	2250
7503 8c32f95c2639 convert mapper functions to new format David Bateman <dbateman@free.fr> parents: 7385 diff changeset	2251 DEFALIAS (gammaln, lgamma);

Mercurial > octave

annotate libinterp/corefcn/mappers.cc @ 27956:2310164737b3 stable