Mercurial > octave

annotate src/mappers.cc @ 7636:99c410f7f0b0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
implement mapper function for banker's rounding
author Jaroslav Hajek <highegg@gmail.com>
date Tue, 25 Mar 2008 15:56:41 -0400
parents 8a939b217863
children 2df457529cfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 2002, 2003, 2004, 2005, 2006, 2007 John W. Eaton
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
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6969
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6969
diff changeset
11 option) any later version.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
16 for more details.
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
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6969
diff changeset
20 <http://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
240
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 164
diff changeset
24 #ifdef HAVE_CONFIG_H
1192
b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe]
jwe
parents: 1173
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>
3010
1aeb8869e464 [project @ 1997-06-01 19:24:02 by jwe]
jwe
parents: 2970
diff changeset
29 #include <cfloat>
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
30
4524
fd95dc5e6f28 [project @ 2003-10-02 03:14:48 by jwe]
jwe
parents: 4268
diff changeset
31 #include "lo-ieee.h"
3156
a494f93e60ff [project @ 1998-02-20 07:47:48 by jwe]
jwe
parents: 3010
diff changeset
32 #include "lo-specfun.h"
2889
8aa189b811d0 [project @ 1997-04-28 01:35:18 by jwe]
jwe
parents: 2847
diff changeset
33 #include "lo-mappers.h"
8aa189b811d0 [project @ 1997-04-28 01:35:18 by jwe]
jwe
parents: 2847
diff changeset
34
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1343
diff changeset
35 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1343
diff changeset
36 #include "error.h"
2955
dfffbf305468 [project @ 1997-05-09 15:15:18 by jwe]
jwe
parents: 2909
diff changeset
37 #include "variables.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
38
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
39 DEFUN (abs, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
40 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
41 @deftypefn {Mapping Function} {} abs (@var{z})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
42 Compute the magnitude of @var{z}, defined as\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
43 @iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
44 @tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
45 $|z| = \\sqrt{x^2 + y^2}$.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
46 @end tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
47 @end iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
48 @ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
49 |@var{z}| = @code{sqrt (x^2 + y^2)}.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
50 @end ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
51 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
52 For example,\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
53 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
54 @example\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
55 @group\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
56 abs (3 + 4i)\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
57 @result{} 5\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
58 @end group\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
59 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
60 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
61 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
62 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
63 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
64 retval = args(0).abs ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
65 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
66 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
67
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
68 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
69 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
70
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
71 DEFUN (acos, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
72 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
73 @deftypefn {Mapping Function} {} acos (@var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
74 Compute the inverse cosine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
75 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
76 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
77 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
78 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
79 retval = args(0).acos ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
80 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
81 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
82
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
83 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
84 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
85
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
86
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
87 DEFUN (acosh, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
88 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
89 @deftypefn {Mapping Function} {} acosh (@var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
90 Compute the inverse hyperbolic cosine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
91 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
92 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
93 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
94 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
95 retval = args(0).acosh ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
96 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
97 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
98
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
99 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
100 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
101
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
102 DEFUN (angle, args, ,
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3446
diff changeset
103 "-*- texinfo -*-\n\
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3446
diff changeset
104 @deftypefn {Mapping Function} {} angle (@var{z})\n\
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3446
diff changeset
105 See arg.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
106 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
107 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
108 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
109 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
110 retval = args(0).arg ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
111 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
112 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
113
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
114 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
115 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
116
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
117 DEFUN (arg, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
118 "-*- texinfo -*-\n\
3446
5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe]
jwe
parents: 3428
diff changeset
119 @deftypefn {Mapping Function} {} arg (@var{z})\n\
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3446
diff changeset
120 @deftypefnx {Mapping Function} {} angle (@var{z})\n\
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
121 Compute the argument of @var{z}, defined as\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
122 @iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
123 @tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
124 $\\theta = \\tan^{-1}(y/x)$.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
125 @end tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
126 @end iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
127 @ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
128 @var{theta} = @code{atan (@var{y}/@var{x})}.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
129 @end ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
130 @noindent\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
131 in radians. \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
132 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
133 For example,\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
134 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
135 @example\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
136 @group\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
137 arg (3 + 4i)\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
138 @result{} 0.92730\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
139 @end group\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
140 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
141 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
142 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
143 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
144 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
145 retval = args(0).arg ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
146 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
147 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
148
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
149 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
150 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
151
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
152 DEFUN (asin, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
153 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
154 @deftypefn {Mapping Function} {} asin (@var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
155 Compute the inverse sine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
156 @end deftypefn")
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 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
159 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
160 retval = args(0).asin ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
161 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
162 print_usage ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
163
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
164 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
165 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
166
7385
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
167 /*
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
168 %!test
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
169 %! rt2 = sqrt (2);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
170 %! rt3 = sqrt (3);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
171 %! v = [0, pi/6, pi/4, pi/3, pi/2, pi/3, pi/4, pi/6, 0];
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
172 %! x = [0, 1/2, rt2/2, rt3/2, 1, rt3/2, rt2/2, 1/2, 0];
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
173 %! assert(all (abs (asin (x) - v) < sqrt (eps)));
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
174 %!error asin ();
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
175 %!error asin (1, 2);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
176 */
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
177
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
178 DEFUN (asinh, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
179 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
180 @deftypefn {Mapping Function} {} asinh (@var{x})\n\
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4968
diff changeset
181 Compute the inverse hyperbolic sine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
182 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
183 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
184 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
185 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
186 retval = args(0).asinh ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
187 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
188 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
189
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
190 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
191 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
192
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
193 DEFUN (atan, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
194 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
195 @deftypefn {Mapping Function} {} atan (@var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
196 Compute the inverse tangent of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
197 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
198 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
199 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
200 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
201 retval = args(0).atan ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
202 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
203 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
204
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
205 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
206 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
207
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
208 DEFUN (atanh, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
209 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
210 @deftypefn {Mapping Function} {} atanh (@var{x})\n\
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4968
diff changeset
211 Compute the inverse hyperbolic tangent of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
212 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
213 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
214 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
215 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
216 retval = args(0).atanh ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
217 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
218 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
219
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
220 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
221 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
222
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
223 DEFUN (ceil, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
224 "-*- texinfo -*-\n\
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3369
diff changeset
225 @deftypefn {Mapping Function} {} ceil (@var{x})\n\
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
226 Return the smallest integer not less than @var{x}. If @var{x} is\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
227 complex, return @code{ceil (real (@var{x})) + ceil (imag (@var{x})) * I}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
228 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
229 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
230 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
231 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
232 retval = args(0).ceil ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
233 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
234 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
235
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
236 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
237 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
238
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
239 DEFUN (conj, args, ,
3381
69b167451491 [project @ 1999-12-15 20:48:10 by jwe]
jwe
parents: 3373
diff changeset
240 "-*- texinfo -*-\n\
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
241 @deftypefn {Mapping Function} {} conj (@var{z})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
242 Return the complex conjugate of @var{z}, defined as\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
243 @iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
244 @tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
245 $\\bar{z} = x - iy$.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
246 @end tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
247 @end iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
248 @ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
249 @code{conj (@var{z})} = @var{x} - @var{i}@var{y}.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
250 @end ifinfo\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
251 @seealso{real, imag}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
252 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
253 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
254 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
255 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
256 retval = args(0).conj ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
257 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
258 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
259
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
260 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
261 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
262
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
263 DEFUN (cos, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
264 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
265 @deftypefn {Mapping Function} {} cos (@var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
266 Compute the cosine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
267 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
268 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
269 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
270 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
271 retval = args(0).cos ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
272 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
273 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
274
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
275 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
276 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
277
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
278 DEFUN (cosh, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
279 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
280 @deftypefn {Mapping Function} {} cosh (@var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
281 Compute the hyperbolic cosine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
282 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
283 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
284 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
285 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
286 retval = args(0).cosh ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
287 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
288 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
289
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
290 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
291 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
292
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
293 DEFUN (erf, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
294 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
295 @deftypefn {Mapping Function} {} erf (@var{z})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
296 Computes the error function,\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
297 @iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
298 @tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
299 $$\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
300 {\\rm erf} (z) = {2 \\over \\sqrt{\\pi}}\\int_0^z e^{-t^2} dt\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
301 $$\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
302 @end tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
303 @end iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
304 @ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
305 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
306 @smallexample\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
307 z\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
308 /\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
309 erf (z) = (2/sqrt (pi)) | e^(-t^2) dt\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
310 /\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
311 t=0\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
312 @end smallexample\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
313 @end ifinfo\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
314 @seealso{erfc, erfinv}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
315 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
316 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
317 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
318 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
319 retval = args(0).erf ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
320 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
321 print_usage ();
624
1a7dea6fa26b [project @ 1994-08-17 16:19:40 by jwe]
jwe
parents: 529
diff changeset
322
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
323 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
324 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
325
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
326 DEFUN (erfc, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
327 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
328 @deftypefn {Mapping Function} {} erfc (@var{z})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
329 Computes the complementary error function,\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
330 @iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
331 @tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
332 $1 - {\\rm erf} (z)$.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
333 @end tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
334 @end iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
335 @ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
336 @code{1 - erf (@var{z})}.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
337 @end ifinfo\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
338 @seealso{erf, erfinv}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
339 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
340 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
341 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
342 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
343 retval = args(0).erfc ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
344 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
345 print_usage ();
624
1a7dea6fa26b [project @ 1994-08-17 16:19:40 by jwe]
jwe
parents: 529
diff changeset
346
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
347 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
348 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
349
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
350 DEFUN (exp, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
351 "-*- texinfo -*-\n\
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3369
diff changeset
352 @deftypefn {Mapping Function} {} exp (@var{x})\n\
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
353 Compute the exponential of @var{x}. To compute the matrix exponential,\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
354 see @ref{Linear Algebra}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
355 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
356 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
357 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
358 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
359 retval = args(0).exp ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
360 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
361 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
362
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
363 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
364 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
365
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
366 DEFUN (finite, args, ,
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
367 "-*- texinfo -*-\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
368 @deftypefn {Mapping Function} {} finite (@var{x})\n\
3600
c11d138d654a [project @ 2000-02-24 03:55:32 by jwe]
jwe
parents: 3586
diff changeset
369 Return 1 for elements of @var{x} that are finite values and zero\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
370 otherwise. For example,\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
371 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
372 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
373 @group\n\
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4968
diff changeset
374 finite ([13, Inf, NA, NaN])\n\
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4968
diff changeset
375 @result{} [ 1, 0, 0, 0 ]\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
376 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
377 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
378 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
379 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
380 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
381 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
382 retval = args(0).finite ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
383 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
384 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
385
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
386 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
387 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
388
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
389 DEFUN (fix, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
390 "-*- texinfo -*-\n\
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3369
diff changeset
391 @deftypefn {Mapping Function} {} fix (@var{x})\n\
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
392 Truncate @var{x} toward zero. If @var{x} is complex, return\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
393 @code{fix (real (@var{x})) + fix (imag (@var{x})) * I}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
394 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
395 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
396 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
397 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
398 retval = args(0).fix ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
399 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
400 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
401
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
402 return retval;
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
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
405
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
406 DEFUN (floor, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
407 "-*- texinfo -*-\n\
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3369
diff changeset
408 @deftypefn {Mapping Function} {} floor (@var{x})\n\
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
409 Return the largest integer not greater than @var{x}. If @var{x} is\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
410 complex, return @code{floor (real (@var{x})) + floor (imag (@var{x})) * I}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
411 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
412 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
413 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
414 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
415 retval = args(0).floor ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
416 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
417 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
418
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
419 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
420 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
421
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
422 DEFUN (gamma, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
423 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
424 @deftypefn {Mapping Function} {} gamma (@var{z})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
425 Computes the Gamma function,\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
426 @iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
427 @tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
428 $$\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
429 \\Gamma (z) = \\int_0^\\infty t^{z-1} e^{-t} dt.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
430 $$\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
431 @end tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
432 @end iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
433 @ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
434 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
435 @example\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
436 infinity\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
437 /\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
438 gamma (z) = | t^(z-1) exp (-t) dt.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
439 /\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
440 t=0\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
441 @end example\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
442 @end ifinfo\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
443 @seealso{gammai, lgamma}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
444 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
445 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
446 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
447 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
448 retval = args(0).gamma ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
449 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
450 print_usage ();
624
1a7dea6fa26b [project @ 1994-08-17 16:19:40 by jwe]
jwe
parents: 529
diff changeset
451
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
452 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
453 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
454
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
455 DEFUN (imag, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
456 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
457 @deftypefn {Mapping Function} {} imag (@var{z})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
458 Return the imaginary part of @var{z} as a real number.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
459 @seealso{real, conj}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
460 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
461 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
462 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
463 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
464 retval = args(0).imag ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
465 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
466 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
467
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
468 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
469 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
470
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
471 DEFUNX ("isalnum", Fisalnum, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
472 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
473 @deftypefn {Mapping Function} {} isalnum (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
474 Return 1 for characters that are letters or digits (@code{isalpha\n\
4165
e05de825dbd6 [project @ 2002-11-11 23:25:48 by jwe]
jwe
parents: 4100
diff changeset
475 (@var{s})} or @code{isdigit (@var{s})} is true).\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
476 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
477 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
478 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
479 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
480 retval = args(0).xisalnum ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
481 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
482 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
483
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
484 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
485 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
486
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
487 DEFUNX ("isalpha", Fisalpha, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
488 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
489 @deftypefn {Mapping Function} {} isalpha (@var{s})\n\
4168
20e641883610 [project @ 2002-11-12 02:56:54 by jwe]
jwe
parents: 4165
diff changeset
490 @deftypefnx {Mapping Function} {} isletter (@var{s})\n\
4165
e05de825dbd6 [project @ 2002-11-11 23:25:48 by jwe]
jwe
parents: 4100
diff changeset
491 Return true for characters that are letters (@code{isupper (@var{s})}\n\
e05de825dbd6 [project @ 2002-11-11 23:25:48 by jwe]
jwe
parents: 4100
diff changeset
492 or @code{islower (@var{s})} is true).\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
493 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
494 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
495 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
496 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
497 retval = args(0).xisalpha ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
498 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
499 print_usage ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
500
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
501 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
502 }
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
503
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
504 DEFUNX ("isascii", Fisascii, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
505 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
506 @deftypefn {Mapping Function} {} isascii (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
507 Return 1 for characters that are ASCII (in the range 0 to 127 decimal).\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
508 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
509 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
510 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
511 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
512 retval = args(0).xisascii ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
513 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
514 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
515
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
516 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
517 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
518
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
519 DEFUNX ("iscntrl", Fiscntrl, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
520 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
521 @deftypefn {Mapping Function} {} iscntrl (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
522 Return 1 for control characters.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
523 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
524 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
525 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
526 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
527 retval = args(0).xiscntrl ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
528 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
529 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
530
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
531 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
532 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
533
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
534 DEFUNX ("isdigit", Fisdigit, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
535 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
536 @deftypefn {Mapping Function} {} isdigit (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
537 Return 1 for characters that are decimal digits.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
538 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
539 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
540 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
541 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
542 retval = args(0).xisdigit ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
543 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
544 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
545
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
546 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
547 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
548
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
549 DEFUN (isinf, args, ,
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
550 "-*- texinfo -*-\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
551 @deftypefn {Mapping Function} {} isinf (@var{x})\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
552 Return 1 for elements of @var{x} that are infinite and zero\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
553 otherwise. For example,\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
554 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
555 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
556 @group\n\
4025
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
557 isinf ([13, Inf, NA, NaN])\n\
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
558 @result{} [ 0, 1, 0, 0 ]\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
559 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
560 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
561 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
562 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
563 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
564 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
565 retval = args(0).isinf ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
566 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
567 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
568
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
569 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
570 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
571
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
572 DEFUNX ("isgraph", Fisgraph, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
573 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
574 @deftypefn {Mapping Function} {} isgraph (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
575 Return 1 for printable characters (but not the space character).\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
576 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
577 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
578 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
579 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
580 retval = args(0).xisgraph ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
581 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
582 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
583
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
584 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
585 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
586
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
587 DEFUNX ("islower", Fislower, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
588 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
589 @deftypefn {Mapping Function} {} islower (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
590 Return 1 for characters that are lower case letters.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
591 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
592 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
593 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
594 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
595 retval = args(0).xislower ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
596 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
597 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
598
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
599 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
600 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
601
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
602 DEFUN (isna, args, ,
4025
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
603 "-*- texinfo -*-\n\
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
604 @deftypefn {Mapping Function} {} isna (@var{x})\n\
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
605 Return 1 for elements of @var{x} that are NA (missing) values and zero\n\
5389
25c8956d2204 [project @ 2005-06-15 03:45:46 by jwe]
jwe
parents: 5307
diff changeset
606 otherwise. For example,\n\
4025
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
607 \n\
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
608 @example\n\
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
609 @group\n\
6218
c1b66b74937d [project @ 2006-12-27 17:43:50 by jwe]
jwe
parents: 6206
diff changeset
610 isna ([13, Inf, NA, NaN])\n\
4025
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
611 @result{} [ 0, 0, 1, 0 ]\n\
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
612 @end group\n\
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
613 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
614 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
615 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
616 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
617 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
618 retval = args(0).isna ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
619 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
620 print_usage ();
4025
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
621
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
622 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
623 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
624
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
625 DEFUN (isnan, args, ,
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
626 "-*- texinfo -*-\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
627 @deftypefn {Mapping Function} {} isnan (@var{x})\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
628 Return 1 for elements of @var{x} that are NaN values and zero\n\
5389
25c8956d2204 [project @ 2005-06-15 03:45:46 by jwe]
jwe
parents: 5307
diff changeset
629 otherwise. NA values are also considered NaN values. For example,\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
630 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
631 @example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
632 @group\n\
4025
cfb762dc9259 [project @ 2002-08-09 06:32:15 by jwe]
jwe
parents: 3775
diff changeset
633 isnan ([13, Inf, NA, NaN])\n\
5389
25c8956d2204 [project @ 2005-06-15 03:45:46 by jwe]
jwe
parents: 5307
diff changeset
634 @result{} [ 0, 0, 1, 1 ]\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
635 @end group\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3368
diff changeset
636 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
637 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
638 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
639 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
640 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
641 retval = args(0).isnan ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
642 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
643 print_usage ();
624
1a7dea6fa26b [project @ 1994-08-17 16:19:40 by jwe]
jwe
parents: 529
diff changeset
644
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
645 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
646 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
647
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
648 DEFUNX ("isprint", Fisprint, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
649 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
650 @deftypefn {Mapping Function} {} isprint (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
651 Return 1 for printable characters (including the space character).\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
652 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
653 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
654 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
655 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
656 retval = args(0).xisprint ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
657 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
658 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
659
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
660 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
661 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
662
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
663 DEFUNX ("ispunct", Fispunct, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
664 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
665 @deftypefn {Mapping Function} {} ispunct (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
666 Return 1 for punctuation characters.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
667 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
668 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
669 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
670 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
671 retval = args(0).xispunct ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
672 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
673 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
674
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
675 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
676 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
677
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
678 DEFUNX ("isspace", Fisspace, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
679 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
680 @deftypefn {Mapping Function} {} isspace (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
681 Return 1 for whitespace characters (space, formfeed, newline,\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
682 carriage return, tab, and vertical tab).\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
683 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
684 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
685 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
686 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
687 retval = args(0).xisspace ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
688 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
689 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
690
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
691 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
692 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
693
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
694 DEFUNX ("isupper", Fisupper, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
695 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
696 @deftypefn {Mapping Function} {} isupper (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
697 Return 1 for upper case letters.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
698 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
699 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
700 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
701 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
702 retval = args(0).xisupper ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
703 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
704 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
705
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
706 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
707 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
708
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
709 DEFUNX ("isxdigit", Fisxdigit, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
710 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
711 @deftypefn {Mapping Function} {} isxdigit (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
712 Return 1 for characters that are hexadecimal digits.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
713 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
714 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
715 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
716 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
717 retval = args(0).xisxdigit ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
718 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
719 print_usage ();
2089
4dcc8b77e84a [project @ 1996-04-26 07:55:54 by jwe]
jwe
parents: 1996
diff changeset
720
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
721 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
722 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
723
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
724 DEFUN (lgamma, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
725 "-*- texinfo -*-\n\
5518
a9bd6c31751f [project @ 2005-10-29 04:26:38 by jwe]
jwe
parents: 5418
diff changeset
726 @deftypefn {Mapping Function} {} lgamma (@var{x})\n\
a9bd6c31751f [project @ 2005-10-29 04:26:38 by jwe]
jwe
parents: 5418
diff changeset
727 @deftypefnx {Mapping Function} {} gammaln (@var{x})\n\
7601
8a939b217863 Treat negative values to lgamma and beta correctly
David Bateman <dbateman@free.fr>
parents: 7528
diff changeset
728 Return the natural logarithm of the gamma function of @var{x}.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
729 @seealso{gamma, gammai}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
730 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
731 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
732 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
733 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
734 retval = args(0).lgamma ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
735 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
736 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
737
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
738 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
739 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
740
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
741 DEFUN (log, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
742 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
743 @deftypefn {Mapping Function} {} log (@var{x})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
744 Compute the natural logarithm for each element of @var{x}. To compute the\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
745 matrix logarithm, see @ref{Linear Algebra}.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
746 @seealso{log2, log10, logspace, exp}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
747 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
748 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
749 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
750 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
751 retval = args(0).log ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
752 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
753 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
754
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
755 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
756 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
757
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
758 DEFUN (log10, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
759 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
760 @deftypefn {Mapping Function} {} log10 (@var{x})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
761 Compute the base-10 logarithm for each element of @var{x}.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
762 @seealso{log, log2, logspace, exp}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
763 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
764 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
765 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
766 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
767 retval = args(0).log10 ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
768 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
769 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
770
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
771 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
772 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
773
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
774 DEFUN (real, args, ,
3381
69b167451491 [project @ 1999-12-15 20:48:10 by jwe]
jwe
parents: 3373
diff changeset
775 "-*- texinfo -*-\n\
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
776 @deftypefn {Mapping Function} {} real (@var{z})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
777 Return the real part of @var{z}.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
778 @seealso{imag, conj}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
779 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
780 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
781 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
782 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
783 retval = args(0).real ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
784 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
785 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
786
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
787 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
788 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
789
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
790 DEFUN (round, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
791 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
792 @deftypefn {Mapping Function} {} round (@var{x})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
793 Return the integer nearest to @var{x}. If @var{x} is complex, return\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
794 @code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
795 @seealso{rem}\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
796 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
797 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
798 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
799 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
800 retval = args(0).round ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
801 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
802 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
803
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
804 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
805 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
806
7636
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
807 DEFUN (roundb, args, ,
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
808 "-*- texinfo -*-\n\
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
809 @deftypefn {Mapping Function} {} roundb (@var{x})\n\
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
810 Return the integer nearest to @var{x}. If there are two nearest\n\
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
811 integers, return the even one (banker's rounding). If @var{x} is complex,\n\
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
812 return @code{roundb (real (@var{x})) + roundb (imag (@var{x})) * I}.\n\
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
813 @seealso{rem}\n\
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
814 @end deftypefn")
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
815 {
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
816 octave_value retval;
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
817 if (args.length () == 1)
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
818 retval = args(0).roundb ();
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
819 else
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
820 print_usage ();
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
821
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
822 return retval;
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
823 }
99c410f7f0b0 implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents: 7601
diff changeset
824
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
825 DEFUN (sign, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
826 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
827 @deftypefn {Mapping Function} {} sign (@var{x})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
828 Compute the @dfn{signum} function, which is defined as\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
829 @iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
830 @tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
831 $$\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
832 {\\rm sign} (@var{x}) = \\cases{1,&$x>0$;\\cr 0,&$x=0$;\\cr -1,&$x<0$.\\cr}\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
833 $$\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
834 @end tex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
835 @end iftex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
836 @ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
837 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
838 @example\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
839 -1, x < 0;\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
840 sign (x) = 0, x = 0;\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
841 1, x > 0.\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
842 @end example\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
843 @end ifinfo\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
844 \n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
845 For complex arguments, @code{sign} returns @code{x ./ abs (@var{x})}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
846 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
847 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
848 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
849 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
850 retval = args(0).signum ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
851 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
852 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
853
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
854 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
855 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
856
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
857 DEFUN (sin, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
858 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
859 @deftypefn {Mapping Function} {} sin (@var{x})\n\
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4968
diff changeset
860 Compute the sine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
861 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
862 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
863 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
864 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
865 retval = args(0).sin ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
866 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
867 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
868
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
869 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
870 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
871
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
872 DEFUN (sinh, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
873 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
874 @deftypefn {Mapping Function} {} sinh (@var{x})\n\
5418
58107fed39bf [project @ 2005-07-21 00:04:46 by jwe]
jwe
parents: 5389
diff changeset
875 Compute the hyperbolic sine of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
876 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
877 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
878 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
879 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
880 retval = args(0).sinh ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
881 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
882 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
883
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
884 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
885 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
886
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
887 DEFUN (sqrt, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
888 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
889 @deftypefn {Mapping Function} {} sqrt (@var{x})\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
890 Compute the square root of @var{x}. If @var{x} is negative, a complex\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
891 result is returned. To compute the matrix square root, see\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
892 @ref{Linear Algebra}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
893 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
894 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
895 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
896 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
897 retval = args(0).sqrt ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
898 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
899 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
900
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
901 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
902 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
903
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
904 DEFUN (tan, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
905 "-*- texinfo -*-\n\
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
906 @deftypefn {Mapping Function} {} tan (@var{z})\n\
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4968
diff changeset
907 Compute tangent of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
908 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
909 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
910 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
911 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
912 retval = args(0).tan ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
913 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
914 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
915
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
916 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
917 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
918
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
919 DEFUN (tanh, args, ,
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
920 "-*- texinfo -*-\n\
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
921 @deftypefn {Mapping Function} {} tanh (@var{x})\n\
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3411
diff changeset
922 Compute hyperbolic tangent of each element of @var{x}.\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
923 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
924 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
925 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
926 if (args.length () == 1)
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
927 retval = args(0).tanh ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
928 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
929 print_usage ();
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
930
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
931 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
932 }
1562
1cff14ab83a4 [project @ 1995-10-12 11:02:40 by jwe]
jwe
parents: 1384
diff changeset
933
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
934 DEFUNX ("toascii", Ftoascii, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
935 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
936 @deftypefn {Mapping Function} {} toascii (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
937 Return ASCII representation of @var{s} in a matrix. For example,\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
938 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
939 @example\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
940 @group\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
941 toascii (\"ASCII\")\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
942 @result{} [ 65, 83, 67, 73, 73 ]\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
943 @end group\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
944 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
945 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
946 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
947 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
948 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
949 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
950 retval = args(0).xtoascii ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
951 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
952 print_usage ();
2267
4028b7c79927 [project @ 1996-05-24 00:39:30 by jwe]
jwe
parents: 2190
diff changeset
953
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
954 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
955 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
956
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
957 DEFUNX ("tolower", Ftolower, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
958 "-*- texinfo -*-\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
959 @deftypefn {Mapping Function} {} tolower (@var{s})\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
960 Return a copy of the string @var{s}, with each upper-case character\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
961 replaced by the corresponding lower-case one; nonalphabetic characters\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
962 are left unchanged. For example,\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
963 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
964 @example\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
965 tolower (\"MiXeD cAsE 123\")\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
966 @result{} \"mixed case 123\"\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
967 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
968 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
969 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
970 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
971 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
972 retval = args(0).xtolower ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
973 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
974 print_usage ();
2267
4028b7c79927 [project @ 1996-05-24 00:39:30 by jwe]
jwe
parents: 2190
diff changeset
975
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
976 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
977 }
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
978
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
979 DEFUNX ("toupper", Ftoupper, args, ,
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
980 "-*- texinfo -*-\n\
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3362
diff changeset
981 @deftypefn {Built-in Function} {} toupper (@var{s})\n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
982 Return a copy of the string @var{s}, with each lower-case character\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
983 replaced by the corresponding upper-case one; nonalphabetic characters\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
984 are left unchanged. For example,\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
985 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
986 @example\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
987 @group\n\
3552
41daa489833a [project @ 2000-02-03 03:05:28 by jwe]
jwe
parents: 3458
diff changeset
988 toupper (\"MiXeD cAsE 123\")\n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
989 @result{} \"MIXED CASE 123\"\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
990 @end group\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3322
diff changeset
991 @end example\n\
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
992 @end deftypefn")
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
993 {
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
994 octave_value retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
995 if (args.length () == 1)
7528
26d8a92644de try to avoid ctype macro problems
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
996 retval = args(0).xtoupper ();
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
997 else
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
998 print_usage ();
3206
d0d2b69dc6c2 [project @ 1998-11-03 02:43:31 by jwe]
jwe
parents: 3156
diff changeset
999
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
1000 return retval;
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
1001 }
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3249
diff changeset
1002
7503
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
1003 DEFALIAS (gammaln, lgamma);
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
1004
8c32f95c2639 convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents: 7385
diff changeset
1005 DEFALIAS (isfinite, finite);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 331
diff changeset
1006
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1007 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1008 ;;; Local Variables: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1009 ;;; mode: C++ ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1010 ;;; End: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1011 */