|
1
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
1
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
20 |
|
|
21 */ |
|
|
22 |
|
240
|
23 #ifdef HAVE_CONFIG_H |
|
1192
|
24 #include <config.h> |
|
1
|
25 #endif |
|
|
26 |
|
2089
|
27 #include <cctype> |
|
3010
|
28 #include <cfloat> |
|
1
|
29 |
|
4524
|
30 #include "lo-ieee.h" |
|
3156
|
31 #include "lo-specfun.h" |
|
2889
|
32 #include "lo-mappers.h" |
|
|
33 |
|
1352
|
34 #include "defun.h" |
|
|
35 #include "error.h" |
|
2970
|
36 #include "ov-mapper.h" |
|
2955
|
37 #include "variables.h" |
|
1
|
38 |
|
2190
|
39 // XXX FIXME XXX -- perhaps this could be avoided by determining |
|
|
40 // whether the is* functions are actually functions or just macros. |
|
|
41 |
|
2889
|
42 static int |
|
4100
|
43 xabs (int c) |
|
|
44 { |
|
|
45 return static_cast<unsigned char> (c); |
|
|
46 } |
|
|
47 |
|
|
48 static int |
|
2190
|
49 xisalnum (int c) |
|
|
50 { |
|
|
51 return isalnum (c); |
|
|
52 } |
|
|
53 |
|
2889
|
54 static int |
|
2190
|
55 xisalpha (int c) |
|
|
56 { |
|
|
57 return isalpha (c); |
|
|
58 } |
|
|
59 |
|
2889
|
60 static int |
|
2190
|
61 xisascii (int c) |
|
|
62 { |
|
|
63 return isascii (c); |
|
|
64 } |
|
|
65 |
|
2889
|
66 static int |
|
2190
|
67 xiscntrl (int c) |
|
|
68 { |
|
|
69 return iscntrl (c); |
|
|
70 } |
|
|
71 |
|
2889
|
72 static int |
|
2190
|
73 xisdigit (int c) |
|
|
74 { |
|
|
75 return isdigit (c); |
|
|
76 } |
|
|
77 |
|
2889
|
78 static int |
|
2190
|
79 xisgraph (int c) |
|
|
80 { |
|
|
81 return isgraph (c); |
|
|
82 } |
|
|
83 |
|
2889
|
84 static int |
|
2190
|
85 xislower (int c) |
|
|
86 { |
|
|
87 return islower (c); |
|
|
88 } |
|
|
89 |
|
2889
|
90 static int |
|
2190
|
91 xisprint (int c) |
|
|
92 { |
|
|
93 return isprint (c); |
|
|
94 } |
|
|
95 |
|
2889
|
96 static int |
|
2190
|
97 xispunct (int c) |
|
|
98 { |
|
|
99 return ispunct (c); |
|
|
100 } |
|
|
101 |
|
2889
|
102 static int |
|
2190
|
103 xisspace (int c) |
|
|
104 { |
|
|
105 return isspace (c); |
|
|
106 } |
|
|
107 |
|
2889
|
108 static int |
|
2190
|
109 xisupper (int c) |
|
|
110 { |
|
|
111 return isupper (c); |
|
|
112 } |
|
|
113 |
|
2889
|
114 static int |
|
2190
|
115 xisxdigit (int c) |
|
|
116 { |
|
|
117 return isxdigit (c); |
|
|
118 } |
|
|
119 |
|
2889
|
120 static int |
|
2267
|
121 xtoascii (int c) |
|
|
122 { |
|
4100
|
123 return toascii ((int) ((unsigned char) c)); |
|
2267
|
124 } |
|
|
125 |
|
2889
|
126 static int |
|
2267
|
127 xtolower (int c) |
|
|
128 { |
|
|
129 return tolower (c); |
|
|
130 } |
|
|
131 |
|
2889
|
132 static int |
|
2267
|
133 xtoupper (int c) |
|
|
134 { |
|
|
135 return toupper (c); |
|
|
136 } |
|
|
137 |
|
4524
|
138 static double |
|
|
139 xabs (const Complex& x) |
|
|
140 { |
|
|
141 return (xisinf (x.real ()) || xisinf (x.imag ())) ? octave_Inf : abs (x); |
|
|
142 } |
|
|
143 |
|
3564
|
144 static Complex |
|
|
145 xconj (const Complex& x) |
|
|
146 { |
|
|
147 return conj (x); |
|
|
148 } |
|
|
149 |
|
|
150 static double |
|
|
151 xconj (double x) |
|
|
152 { |
|
|
153 return x; |
|
|
154 } |
|
|
155 |
|
3586
|
156 static double |
|
3564
|
157 ximag (const Complex& x) |
|
|
158 { |
|
3586
|
159 return x.imag (); |
|
3564
|
160 } |
|
|
161 |
|
3586
|
162 static double |
|
3564
|
163 xreal (const Complex& x) |
|
|
164 { |
|
3586
|
165 return x.real (); |
|
3564
|
166 } |
|
|
167 |
|
529
|
168 void |
|
|
169 install_mapper_functions (void) |
|
|
170 { |
|
4524
|
171 DEFUN_MAPPER (abs, xabs, 0, 0, fabs, xabs, 0, 0.0, 0.0, 1, 0, |
|
3321
|
172 "-*- texinfo -*-\n\ |
|
|
173 @deftypefn {Mapping Function} {} abs (@var{z})\n\ |
|
|
174 Compute the magnitude of @var{z}, defined as\n\ |
|
|
175 @iftex\n\ |
|
|
176 @tex\n\ |
|
|
177 $|z| = \\sqrt{x^2 + y^2}$.\n\ |
|
|
178 @end tex\n\ |
|
|
179 @end iftex\n\ |
|
|
180 @ifinfo\n\ |
|
|
181 |@var{z}| = @code{sqrt (x^2 + y^2)}.\n\ |
|
|
182 @end ifinfo\n\ |
|
|
183 \n\ |
|
|
184 For example,\n\ |
|
|
185 \n\ |
|
|
186 @example\n\ |
|
|
187 @group\n\ |
|
|
188 abs (3 + 4i)\n\ |
|
|
189 @result{} 5\n\ |
|
|
190 @end group\n\ |
|
|
191 @end example\n\ |
|
|
192 @end deftypefn"); |
|
529
|
193 |
|
4268
|
194 DEFUN_MAPPER (acos, 0, 0, 0, acos, 0, acos, -1.0, 1.0, 0, 1, |
|
3321
|
195 "-*- texinfo -*-\n\ |
|
3428
|
196 @deftypefn {Mapping Function} {} acos (@var{x})\n\ |
|
|
197 Compute the inverse cosine of each element of @var{x}.\n\ |
|
3321
|
198 @end deftypefn"); |
|
529
|
199 |
|
4668
|
200 DEFUN_MAPPER (acosh, 0, 0, 0, acosh, 0, acosh, 1.0, octave_Inf, 0, 1, |
|
3321
|
201 "-*- texinfo -*-\n\ |
|
3428
|
202 @deftypefn {Mapping Function} {} acosh (@var{x})\n\ |
|
|
203 Compute the inverse hyperbolic cosine of each element of @var{x}.\n\ |
|
3321
|
204 @end deftypefn"); |
|
529
|
205 |
|
4100
|
206 DEFUN_MAPPER (angle, 0, 0, 0, arg, arg, 0, 0.0, 0.0, 0, 0, |
|
3458
|
207 "-*- texinfo -*-\n\ |
|
|
208 @deftypefn {Mapping Function} {} angle (@var{z})\n\ |
|
|
209 See arg.\n\ |
|
|
210 @end deftypefn"); |
|
529
|
211 |
|
4100
|
212 DEFUN_MAPPER (arg, 0, 0, 0, arg, arg, 0, 0.0, 0.0, 0, 0, |
|
3321
|
213 "-*- texinfo -*-\n\ |
|
3446
|
214 @deftypefn {Mapping Function} {} arg (@var{z})\n\ |
|
3458
|
215 @deftypefnx {Mapping Function} {} angle (@var{z})\n\ |
|
3321
|
216 Compute the argument of @var{z}, defined as\n\ |
|
|
217 @iftex\n\ |
|
|
218 @tex\n\ |
|
|
219 $\\theta = \\tan^{-1}(y/x)$.\n\ |
|
|
220 @end tex\n\ |
|
|
221 @end iftex\n\ |
|
|
222 @ifinfo\n\ |
|
|
223 @var{theta} = @code{atan (@var{y}/@var{x})}.\n\ |
|
|
224 @end ifinfo\n\ |
|
|
225 \n\ |
|
|
226 @noindent\n\ |
|
|
227 in radians. \n\ |
|
|
228 \n\ |
|
|
229 For example,\n\ |
|
|
230 \n\ |
|
|
231 @example\n\ |
|
|
232 @group\n\ |
|
|
233 arg (3 + 4i)\n\ |
|
|
234 @result{} 0.92730\n\ |
|
|
235 @end group\n\ |
|
|
236 @end example\n\ |
|
|
237 @end deftypefn"); |
|
529
|
238 |
|
4268
|
239 DEFUN_MAPPER (asin, 0, 0, 0, asin, 0, asin, -1.0, 1.0, 0, 1, |
|
3321
|
240 "-*- texinfo -*-\n\ |
|
3428
|
241 @deftypefn {Mapping Function} {} asin (@var{x})\n\ |
|
|
242 Compute the inverse sine of each element of @var{x}.\n\ |
|
3321
|
243 @end deftypefn"); |
|
529
|
244 |
|
4100
|
245 DEFUN_MAPPER (asinh, 0, 0, 0, asinh, 0, asinh, 0.0, 0.0, 0, 0, |
|
3321
|
246 "-*- texinfo -*-\n\ |
|
3428
|
247 @deftypefn {Mapping Function} {} asinh (@var{x})\n\ |
|
|
248 Ompute the inverse hyperbolic sine of each element of @var{x}.\n\ |
|
3321
|
249 @end deftypefn"); |
|
529
|
250 |
|
4268
|
251 DEFUN_MAPPER (atan, 0, 0, 0, atan, 0, atan, 0.0, 0.0, 0, 0, |
|
3321
|
252 "-*- texinfo -*-\n\ |
|
3428
|
253 @deftypefn {Mapping Function} {} atan (@var{x})\n\ |
|
|
254 Compute the inverse tangent of each element of @var{x}.\n\ |
|
3321
|
255 @end deftypefn"); |
|
529
|
256 |
|
4100
|
257 DEFUN_MAPPER (atanh, 0, 0, 0, atanh, 0, atanh, -1.0, 1.0, 0, 1, |
|
3321
|
258 "-*- texinfo -*-\n\ |
|
3428
|
259 @deftypefn {Mapping Function} {} atanh (@var{x})\n\ |
|
|
260 Compute the inverse hyperbolic tanget of each element of @var{x}.\n\ |
|
3321
|
261 @end deftypefn"); |
|
529
|
262 |
|
4268
|
263 DEFUN_MAPPER (ceil, 0, 0, 0, ceil, 0, ceil, 0.0, 0.0, 0, 0, |
|
3321
|
264 "-*- texinfo -*-\n\ |
|
3373
|
265 @deftypefn {Mapping Function} {} ceil (@var{x})\n\ |
|
3321
|
266 Return the smallest integer not less than @var{x}. If @var{x} is\n\ |
|
|
267 complex, return @code{ceil (real (@var{x})) + ceil (imag (@var{x})) * I}.\n\ |
|
|
268 @end deftypefn"); |
|
529
|
269 |
|
4100
|
270 DEFUN_MAPPER (conj, 0, 0, 0, xconj, 0, xconj, 0.0, 0.0, 0, 0, |
|
3381
|
271 "-*- texinfo -*-\n\ |
|
3321
|
272 @deftypefn {Mapping Function} {} conj (@var{z})\n\ |
|
|
273 Return the complex conjugate of @var{z}, defined as\n\ |
|
|
274 @iftex\n\ |
|
|
275 @tex\n\ |
|
|
276 $\\bar{z} = x - iy$.\n\ |
|
|
277 @end tex\n\ |
|
|
278 @end iftex\n\ |
|
|
279 @ifinfo\n\ |
|
|
280 @code{conj (@var{z})} = @var{x} - @var{i}@var{y}.\n\ |
|
|
281 @end ifinfo\n\ |
|
|
282 @end deftypefn\n\ |
|
3411
|
283 @seealso{real and imag}"); |
|
529
|
284 |
|
4268
|
285 DEFUN_MAPPER (cos, 0, 0, 0, cos, 0, cos, 0.0, 0.0, 0, 0, |
|
3321
|
286 "-*- texinfo -*-\n\ |
|
3428
|
287 @deftypefn {Mapping Function} {} cos (@var{x})\n\ |
|
|
288 Compute the cosine of each element of @var{x}.\n\ |
|
3321
|
289 @end deftypefn"); |
|
529
|
290 |
|
4268
|
291 DEFUN_MAPPER (cosh, 0, 0, 0, cosh, 0, cosh, 0.0, 0.0, 0, 0, |
|
3321
|
292 "-*- texinfo -*-\n\ |
|
3428
|
293 @deftypefn {Mapping Function} {} cosh (@var{x})\n\ |
|
|
294 Compute the hyperbolic cosine of each element of @var{x}.\n\ |
|
3321
|
295 @end deftypefn"); |
|
529
|
296 |
|
4100
|
297 DEFUN_MAPPER (erf, 0, 0, 0, erf, 0, 0, 0.0, 0.0, 0, 0, |
|
3321
|
298 "-*- texinfo -*-\n\ |
|
|
299 @deftypefn {Mapping Function} {} erf (@var{z})\n\ |
|
|
300 Computes the error function,\n\ |
|
|
301 @iftex\n\ |
|
|
302 @tex\n\ |
|
|
303 $$\n\ |
|
|
304 {\\rm erf} (z) = {2 \\over \\sqrt{\\pi}}\\int_0^z e^{-t^2} dt\n\ |
|
|
305 $$\n\ |
|
|
306 @end tex\n\ |
|
|
307 @end iftex\n\ |
|
|
308 @ifinfo\n\ |
|
|
309 \n\ |
|
|
310 @smallexample\n\ |
|
|
311 z\n\ |
|
|
312 /\n\ |
|
|
313 erf (z) = (2/sqrt (pi)) | e^(-t^2) dt\n\ |
|
|
314 /\n\ |
|
|
315 t=0\n\ |
|
|
316 @end smallexample\n\ |
|
|
317 @end ifinfo\n\ |
|
|
318 @end deftypefn\n\ |
|
3411
|
319 @seealso{erfc and erfinv}"); |
|
624
|
320 |
|
4100
|
321 DEFUN_MAPPER (erfc, 0, 0, 0, erfc, 0, 0, 0.0, 0.0, 0, 0, |
|
3321
|
322 "-*- texinfo -*-\n\ |
|
|
323 @deftypefn {Mapping Function} {} erfc (@var{z})\n\ |
|
|
324 Computes the complementary error function,\n\ |
|
|
325 @iftex\n\ |
|
|
326 @tex\n\ |
|
|
327 $1 - {\\rm erf} (z)$.\n\ |
|
|
328 @end tex\n\ |
|
|
329 @end iftex\n\ |
|
|
330 @ifinfo\n\ |
|
|
331 @code{1 - erf (@var{z})}.\n\ |
|
|
332 @end ifinfo\n\ |
|
|
333 @end deftypefn\n\ |
|
|
334 \n\ |
|
3411
|
335 @seealso{erf and erfinv}"); |
|
624
|
336 |
|
4268
|
337 DEFUN_MAPPER (exp, 0, 0, 0, exp, 0, exp, 0.0, 0.0, 0, 0, |
|
3321
|
338 "-*- texinfo -*-\n\ |
|
3373
|
339 @deftypefn {Mapping Function} {} exp (@var{x})\n\ |
|
3321
|
340 Compute the exponential of @var{x}. To compute the matrix exponential,\n\ |
|
|
341 see @ref{Linear Algebra}.\n\ |
|
|
342 @end deftypefn"); |
|
529
|
343 |
|
4100
|
344 DEFUN_MAPPER (finite, 0, xfinite, xfinite, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3369
|
345 "-*- texinfo -*-\n\ |
|
|
346 @deftypefn {Mapping Function} {} finite (@var{x})\n\ |
|
3600
|
347 Return 1 for elements of @var{x} that are finite values and zero\n\ |
|
3369
|
348 otherwise. For example,\n\ |
|
|
349 \n\ |
|
|
350 @example\n\ |
|
|
351 @group\n\ |
|
|
352 finite ([13, Inf, NaN])\n\ |
|
|
353 @result{} [ 1, 0, 0 ]\n\ |
|
|
354 @end group\n\ |
|
|
355 @end example\n\ |
|
|
356 @end deftypefn"); |
|
529
|
357 |
|
4100
|
358 DEFUN_MAPPER (fix, 0, 0, 0, fix, 0, fix, 0.0, 0.0, 0, 0, |
|
3321
|
359 "-*- texinfo -*-\n\ |
|
3373
|
360 @deftypefn {Mapping Function} {} fix (@var{x})\n\ |
|
3321
|
361 Truncate @var{x} toward zero. If @var{x} is complex, return\n\ |
|
|
362 @code{fix (real (@var{x})) + fix (imag (@var{x})) * I}.\n\ |
|
|
363 @end deftypefn"); |
|
529
|
364 |
|
4268
|
365 DEFUN_MAPPER (floor, 0, 0, 0, floor, 0, floor, 0.0, 0.0, 0, 0, |
|
3321
|
366 "-*- texinfo -*-\n\ |
|
3373
|
367 @deftypefn {Mapping Function} {} floor (@var{x})\n\ |
|
3321
|
368 Return the largest integer not greater than @var{x}. If @var{x} is\n\ |
|
|
369 complex, return @code{floor (real (@var{x})) + floor (imag (@var{x})) * I}.\n\ |
|
|
370 @end deftypefn"); |
|
529
|
371 |
|
4100
|
372 DEFUN_MAPPER (gamma, 0, 0, 0, xgamma, 0, 0, 0.0, 0.0, 0, 0, |
|
3321
|
373 "-*- texinfo -*-\n\ |
|
|
374 @deftypefn {Mapping Function} {} gamma (@var{z})\n\ |
|
|
375 Computes the Gamma function,\n\ |
|
|
376 @iftex\n\ |
|
|
377 @tex\n\ |
|
|
378 $$\n\ |
|
|
379 \\Gamma (z) = \\int_0^\\infty t^{z-1} e^{-t} dt.\n\ |
|
|
380 $$\n\ |
|
|
381 @end tex\n\ |
|
|
382 @end iftex\n\ |
|
|
383 @ifinfo\n\ |
|
|
384 \n\ |
|
|
385 @example\n\ |
|
|
386 infinity\n\ |
|
|
387 /\n\ |
|
|
388 gamma (z) = | t^(z-1) exp (-t) dt.\n\ |
|
|
389 /\n\ |
|
|
390 t=0\n\ |
|
|
391 @end example\n\ |
|
|
392 @end ifinfo\n\ |
|
|
393 @end deftypefn\n\ |
|
|
394 \n\ |
|
3411
|
395 @seealso{gammai and lgamma}"); |
|
624
|
396 |
|
4100
|
397 DEFUN_MAPPER (imag, 0, 0, 0, imag, ximag, 0, 0.0, 0.0, 0, 0, |
|
3321
|
398 "-*- texinfo -*-\n\ |
|
|
399 @deftypefn {Mapping Function} {} imag (@var{z})\n\ |
|
|
400 Return the imaginary part of @var{z} as a real number.\n\ |
|
|
401 @end deftypefn\n\ |
|
|
402 \n\ |
|
3411
|
403 @seealso{real and conj}"); |
|
2089
|
404 |
|
4100
|
405 DEFUN_MAPPER (isalnum, xisalnum, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
406 "-*- texinfo -*-\n\ |
|
|
407 @deftypefn {Mapping Function} {} isalnum (@var{s})\n\ |
|
|
408 Return 1 for characters that are letters or digits (@code{isalpha\n\ |
|
4165
|
409 (@var{s})} or @code{isdigit (@var{s})} is true).\n\ |
|
3361
|
410 @end deftypefn"); |
|
2089
|
411 |
|
4100
|
412 DEFUN_MAPPER (isalpha, xisalpha, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
413 "-*- texinfo -*-\n\ |
|
|
414 @deftypefn {Mapping Function} {} isalpha (@var{s})\n\ |
|
4168
|
415 @deftypefnx {Mapping Function} {} isletter (@var{s})\n\ |
|
4165
|
416 Return true for characters that are letters (@code{isupper (@var{s})}\n\ |
|
|
417 or @code{islower (@var{s})} is true).\n\ |
|
3361
|
418 @end deftypefn"); |
|
2089
|
419 |
|
4100
|
420 DEFUN_MAPPER (isascii, xisascii, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
421 "-*- texinfo -*-\n\ |
|
|
422 @deftypefn {Mapping Function} {} isascii (@var{s})\n\ |
|
|
423 Return 1 for characters that are ASCII (in the range 0 to 127 decimal).\n\ |
|
|
424 @end deftypefn"); |
|
2089
|
425 |
|
4100
|
426 DEFUN_MAPPER (iscntrl, xiscntrl, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
427 "-*- texinfo -*-\n\ |
|
|
428 @deftypefn {Mapping Function} {} iscntrl (@var{s})\n\ |
|
|
429 Return 1 for control characters.\n\ |
|
|
430 @end deftypefn"); |
|
2089
|
431 |
|
4100
|
432 DEFUN_MAPPER (isdigit, xisdigit, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
433 "-*- texinfo -*-\n\ |
|
|
434 @deftypefn {Mapping Function} {} isdigit (@var{s})\n\ |
|
|
435 Return 1 for characters that are decimal digits.\n\ |
|
|
436 @end deftypefn"); |
|
2089
|
437 |
|
4100
|
438 DEFUN_MAPPER (isinf, 0, xisinf, xisinf, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3369
|
439 "-*- texinfo -*-\n\ |
|
|
440 @deftypefn {Mapping Function} {} isinf (@var{x})\n\ |
|
|
441 Return 1 for elements of @var{x} that are infinite and zero\n\ |
|
|
442 otherwise. For example,\n\ |
|
|
443 \n\ |
|
|
444 @example\n\ |
|
|
445 @group\n\ |
|
4025
|
446 isinf ([13, Inf, NA, NaN])\n\ |
|
|
447 @result{} [ 0, 1, 0, 0 ]\n\ |
|
3369
|
448 @end group\n\ |
|
|
449 @end example\n\ |
|
|
450 @end deftypefn"); |
|
529
|
451 |
|
4100
|
452 DEFUN_MAPPER (isgraph, xisgraph, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
453 "-*- texinfo -*-\n\ |
|
|
454 @deftypefn {Mapping Function} {} isgraph (@var{s})\n\ |
|
|
455 Return 1 for printable characters (but not the space character).\n\ |
|
|
456 @end deftypefn"); |
|
529
|
457 |
|
4100
|
458 DEFUN_MAPPER (islower, xislower, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
459 "-*- texinfo -*-\n\ |
|
|
460 @deftypefn {Mapping Function} {} islower (@var{s})\n\ |
|
|
461 Return 1 for characters that are lower case letters.\n\ |
|
|
462 @end deftypefn"); |
|
2089
|
463 |
|
4100
|
464 DEFUN_MAPPER (isna, 0, octave_is_NA, octave_is_NA, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
4025
|
465 "-*- texinfo -*-\n\ |
|
|
466 @deftypefn {Mapping Function} {} isna (@var{x})\n\ |
|
|
467 Return 1 for elements of @var{x} that are NA (missing) values and zero\n\ |
|
|
468 otherwise. For example,\n\ |
|
|
469 \n\ |
|
|
470 @example\n\ |
|
|
471 @group\n\ |
|
|
472 is_NA ([13, Inf, NA, NaN])\n\ |
|
|
473 @result{} [ 0, 0, 1, 0 ]\n\ |
|
|
474 @end group\n\ |
|
|
475 @end example\n\ |
|
|
476 @end deftypefn"); |
|
|
477 |
|
|
478 DEFUN_MAPPER (is_nan_or_na, 0, octave_is_NaN_or_NA, |
|
4100
|
479 octave_is_NaN_or_NA, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
4025
|
480 "-*- texinfo -*-\n\ |
|
|
481 @deftypefn {Mapping Function} {} is_nan_or_na (@var{x})\n\ |
|
|
482 Return 1 for elements of @var{x} that are NaN or NA (missing) values\n\ |
|
|
483 and zero otherwise. For example,\n\ |
|
|
484 \n\ |
|
|
485 @example\n\ |
|
|
486 @group\n\ |
|
|
487 is_NAN_or_NA ([13, Inf, NA, NaN])\n\ |
|
|
488 @result{} [ 0, 0, 1, 1 ]\n\ |
|
|
489 @end group\n\ |
|
|
490 @end example\n\ |
|
|
491 @end deftypefn"); |
|
|
492 |
|
4100
|
493 DEFUN_MAPPER (isnan, 0, xisnan, xisnan, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3369
|
494 "-*- texinfo -*-\n\ |
|
|
495 @deftypefn {Mapping Function} {} isnan (@var{x})\n\ |
|
|
496 Return 1 for elements of @var{x} that are NaN values and zero\n\ |
|
|
497 otherwise. For example,\n\ |
|
|
498 \n\ |
|
|
499 @example\n\ |
|
|
500 @group\n\ |
|
4025
|
501 isnan ([13, Inf, NA, NaN])\n\ |
|
|
502 @result{} [ 0, 0, 0, 1 ]\n\ |
|
3369
|
503 @end group\n\ |
|
|
504 @end example\n\ |
|
|
505 @end deftypefn"); |
|
624
|
506 |
|
4100
|
507 DEFUN_MAPPER (isprint, xisprint, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
508 "-*- texinfo -*-\n\ |
|
|
509 @deftypefn {Mapping Function} {} isprint (@var{s})\n\ |
|
|
510 Return 1 for printable characters (including the space character).\n\ |
|
|
511 @end deftypefn"); |
|
2089
|
512 |
|
4100
|
513 DEFUN_MAPPER (ispunct, xispunct, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
514 "-*- texinfo -*-\n\ |
|
|
515 @deftypefn {Mapping Function} {} ispunct (@var{s})\n\ |
|
|
516 Return 1 for punctuation characters.\n\ |
|
|
517 @end deftypefn"); |
|
2089
|
518 |
|
4100
|
519 DEFUN_MAPPER (isspace, xisspace, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
520 "-*- texinfo -*-\n\ |
|
|
521 @deftypefn {Mapping Function} {} isspace (@var{s})\n\ |
|
|
522 Return 1 for whitespace characters (space, formfeed, newline,\n\ |
|
|
523 carriage return, tab, and vertical tab).\n\ |
|
|
524 @end deftypefn"); |
|
2089
|
525 |
|
4100
|
526 DEFUN_MAPPER (isupper, xisupper, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
527 "-*- texinfo -*-\n\ |
|
|
528 @deftypefn {Mapping Function} {} isupper (@var{s})\n\ |
|
|
529 Return 1 for upper case letters.\n\ |
|
|
530 @end deftypefn"); |
|
2089
|
531 |
|
4100
|
532 DEFUN_MAPPER (isxdigit, xisxdigit, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, |
|
3361
|
533 "-*- texinfo -*-\n\ |
|
|
534 @deftypefn {Mapping Function} {} isxdigit (@var{s})\n\ |
|
|
535 Return 1 for characters that are hexadecimal digits.\n\ |
|
|
536 @end deftypefn"); |
|
2089
|
537 |
|
4100
|
538 DEFUN_MAPPER (lgamma, 0, 0, 0, xlgamma, 0, 0, 0.0, 0.0, 0, 0, |
|
3321
|
539 "-*- texinfo -*-\n\ |
|
|
540 @deftypefn {Mapping Function} {} lgamma (@var{a}, @var{x})\n\ |
|
|
541 @deftypefnx {Mapping Function} {} gammaln (@var{a}, @var{x})\n\ |
|
|
542 Return the natural logarithm of the gamma function.\n\ |
|
|
543 @end deftypefn\n\ |
|
3411
|
544 @seealso{gamma and gammai}"); |
|
529
|
545 |
|
4668
|
546 DEFUN_MAPPER (log, 0, 0, 0, log, 0, log, 0.0, octave_Inf, 0, 1, |
|
3321
|
547 "-*- texinfo -*-\n\ |
|
|
548 @deftypefn {Mapping Function} {} log (@var{x})\n\ |
|
|
549 Compute the natural logarithm for each element of @var{x}. To compute the\n\ |
|
|
550 matrix logarithm, see @ref{Linear Algebra}.\n\ |
|
|
551 @end deftypefn\n\ |
|
3411
|
552 @seealso{log2, log10, logspace, and exp}"); |
|
529
|
553 |
|
4668
|
554 DEFUN_MAPPER (log10, 0, 0, 0, log10, 0, log10, 0.0, octave_Inf, 0, 1, |
|
3321
|
555 "-*- texinfo -*-\n\ |
|
|
556 @deftypefn {Mapping Function} {} log10 (@var{x})\n\ |
|
|
557 Compute the base-10 logarithm for each element of @var{x}.\n\ |
|
|
558 @end deftypefn\n\ |
|
3411
|
559 @seealso{log, log2, logspace, and exp}"); |
|
529
|
560 |
|
4100
|
561 DEFUN_MAPPER (real, 0, 0, 0, real, xreal, 0, 0.0, 0.0, 0, 0, |
|
3381
|
562 "-*- texinfo -*-\n\ |
|
3321
|
563 @deftypefn {Mapping Function} {} real (@var{z})\n\ |
|
|
564 Return the real part of @var{z}.\n\ |
|
|
565 @end deftypefn\n\ |
|
3411
|
566 @seealso{imag and conj}"); |
|
529
|
567 |
|
4100
|
568 DEFUN_MAPPER (round, 0, 0, 0, round, 0, round, 0.0, 0.0, 0, 0, |
|
3321
|
569 "-*- texinfo -*-\n\ |
|
|
570 @deftypefn {Mapping Function} {} round (@var{x})\n\ |
|
|
571 Return the integer nearest to @var{x}. If @var{x} is complex, return\n\ |
|
|
572 @code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\ |
|
|
573 @end deftypefn\n\ |
|
3411
|
574 @seealso{rem}"); |
|
529
|
575 |
|
4100
|
576 DEFUN_MAPPER (sign, 0, 0, 0, signum, 0, signum, 0.0, 0.0, 0, 0, |
|
3321
|
577 "-*- texinfo -*-\n\ |
|
|
578 @deftypefn {Mapping Function} {} sign (@var{x})\n\ |
|
|
579 Compute the @dfn{signum} function, which is defined as\n\ |
|
|
580 @iftex\n\ |
|
|
581 @tex\n\ |
|
|
582 $$\n\ |
|
|
583 {\\rm sign} (@var{x}) = \\cases{1,&$x>0$;\\cr 0,&$x=0$;\\cr -1,&$x<0$.\\cr}\n\ |
|
|
584 $$\n\ |
|
|
585 @end tex\n\ |
|
|
586 @end iftex\n\ |
|
|
587 @ifinfo\n\ |
|
|
588 \n\ |
|
|
589 @example\n\ |
|
|
590 -1, x < 0;\n\ |
|
|
591 sign (x) = 0, x = 0;\n\ |
|
|
592 1, x > 0.\n\ |
|
|
593 @end example\n\ |
|
|
594 @end ifinfo\n\ |
|
|
595 \n\ |
|
|
596 For complex arguments, @code{sign} returns @code{x ./ abs (@var{x})}.\n\ |
|
|
597 @end deftypefn"); |
|
529
|
598 |
|
4268
|
599 DEFUN_MAPPER (sin, 0, 0, 0, sin, 0, sin, 0.0, 0.0, 0, 0, |
|
3321
|
600 "-*- texinfo -*-\n\ |
|
3428
|
601 @deftypefn {Mapping Function} {} sin (@var{x})\n\ |
|
|
602 Compute the sin of each element of @var{x}.\n\ |
|
3321
|
603 @end deftypefn"); |
|
529
|
604 |
|
4268
|
605 DEFUN_MAPPER (sinh, 0, 0, 0, sinh, 0, sinh, 0.0, 0.0, 0, 0, |
|
3321
|
606 "-*- texinfo -*-\n\ |
|
3428
|
607 @deftypefn {Mapping Function} {} sinh (@var{x})\n\ |
|
|
608 Compute the inverse hyperbolic sin of each element of @var{x}.\n\ |
|
3321
|
609 @end deftypefn"); |
|
529
|
610 |
|
4668
|
611 DEFUN_MAPPER (sqrt, 0, 0, 0, sqrt, 0, sqrt, 0.0, octave_Inf, 0, 1, |
|
3321
|
612 "-*- texinfo -*-\n\ |
|
|
613 @deftypefn {Mapping Function} {} sqrt (@var{x})\n\ |
|
|
614 Compute the square root of @var{x}. If @var{x} is negative, a complex\n\ |
|
|
615 result is returned. To compute the matrix square root, see\n\ |
|
|
616 @ref{Linear Algebra}.\n\ |
|
|
617 @end deftypefn"); |
|
529
|
618 |
|
4268
|
619 DEFUN_MAPPER (tan, 0, 0, 0, tan, 0, tan, 0.0, 0.0, 0, 0, |
|
3321
|
620 "-*- texinfo -*-\n\ |
|
|
621 @deftypefn {Mapping Function} {} tan (@var{z})\n\ |
|
3428
|
622 Compute tanget of each element of @var{x}.\n\ |
|
3321
|
623 @end deftypefn"); |
|
529
|
624 |
|
4268
|
625 DEFUN_MAPPER (tanh, 0, 0, 0, tanh, 0, tanh, 0.0, 0.0, 0, 0, |
|
3321
|
626 "-*- texinfo -*-\n\ |
|
3428
|
627 @deftypefn {Mapping Function} {} tanh (@var{x})\n\ |
|
|
628 Compute hyperbolic tangent of each element of @var{x}.\n\ |
|
3321
|
629 @end deftypefn"); |
|
1562
|
630 |
|
4100
|
631 DEFUN_MAPPER (toascii, xtoascii, 0, 0, 0, 0, 0, 0.0, 0.0, 1, 0, |
|
3361
|
632 "-*- texinfo -*-\n\ |
|
|
633 @deftypefn {Mapping Function} {} toascii (@var{s})\n\ |
|
|
634 Return ASCII representation of @var{s} in a matrix. For example,\n\ |
|
|
635 \n\ |
|
|
636 @example\n\ |
|
|
637 @group\n\ |
|
|
638 toascii (\"ASCII\")\n\ |
|
|
639 @result{} [ 65, 83, 67, 73, 73 ]\n\ |
|
|
640 @end group\n\ |
|
|
641 \n\ |
|
|
642 @end example\n\ |
|
3362
|
643 @end deftypefn"); |
|
2267
|
644 |
|
4100
|
645 DEFUN_MAPPER (tolower, xtolower, 0, 0, 0, 0, 0, 0.0, 0.0, 2, 0, |
|
3361
|
646 "-*- texinfo -*-\n\ |
|
|
647 @deftypefn {Mapping Function} {} tolower (@var{s})\n\ |
|
|
648 Return a copy of the string @var{s}, with each upper-case character\n\ |
|
|
649 replaced by the corresponding lower-case one; nonalphabetic characters\n\ |
|
|
650 are left unchanged. For example,\n\ |
|
|
651 \n\ |
|
|
652 @example\n\ |
|
|
653 tolower (\"MiXeD cAsE 123\")\n\ |
|
|
654 @result{} \"mixed case 123\"\n\ |
|
|
655 @end example\n\ |
|
3362
|
656 @end deftypefn"); |
|
2267
|
657 |
|
4100
|
658 DEFUN_MAPPER (toupper, xtoupper, 0, 0, 0, 0, 0, 0.0, 0.0, 2, 0, |
|
3361
|
659 "-*- texinfo -*-\n\ |
|
3368
|
660 @deftypefn {Built-in Function} {} toupper (@var{s})\n\ |
|
3361
|
661 Return a copy of the string @var{s}, with each lower-case character\n\ |
|
|
662 replaced by the corresponding upper-case one; nonalphabetic characters\n\ |
|
|
663 are left unchanged. For example,\n\ |
|
|
664 \n\ |
|
|
665 @example\n\ |
|
|
666 @group\n\ |
|
3552
|
667 toupper (\"MiXeD cAsE 123\")\n\ |
|
3361
|
668 @result{} \"MIXED CASE 123\"\n\ |
|
|
669 @end group\n\ |
|
|
670 @end example\n\ |
|
3362
|
671 @end deftypefn"); |
|
2267
|
672 |
|
1562
|
673 DEFALIAS (gammaln, lgamma); |
|
3206
|
674 |
|
|
675 DEFALIAS (isfinite, finite); |
|
3321
|
676 |
|
|
677 // Leave the previous new line, mkgendoc needs it! |
|
529
|
678 } |
|
|
679 |
|
1
|
680 /* |
|
|
681 ;;; Local Variables: *** |
|
|
682 ;;; mode: C++ *** |
|
|
683 ;;; End: *** |
|
|
684 */ |
