comparison src/mappers.cc @ 5642:2618a0750ae6

[project @ 2006-03-06 21:26:48 by jwe]
author jwe
date Mon, 06 Mar 2006 21:26:54 +0000
parents a9bd6c31751f
children 2b20d1707f29
comparison
equal deleted inserted replaced
5641:eb998631a4aa 5642:2618a0750ae6
277 @end tex\n\ 277 @end tex\n\
278 @end iftex\n\ 278 @end iftex\n\
279 @ifinfo\n\ 279 @ifinfo\n\
280 @code{conj (@var{z})} = @var{x} - @var{i}@var{y}.\n\ 280 @code{conj (@var{z})} = @var{x} - @var{i}@var{y}.\n\
281 @end ifinfo\n\ 281 @end ifinfo\n\
282 @end deftypefn\n\ 282 @seealso{real, imag}\n\
283 @seealso{real and imag}"); 283 @end deftypefn\n\");
284 284
285 DEFUN_MAPPER (cos, 0, 0, 0, cos, 0, std::cos, 0.0, 0.0, 0, 0, 285 DEFUN_MAPPER (cos, 0, 0, 0, cos, 0, std::cos, 0.0, 0.0, 0, 0,
286 "-*- texinfo -*-\n\ 286 "-*- texinfo -*-\n\
287 @deftypefn {Mapping Function} {} cos (@var{x})\n\ 287 @deftypefn {Mapping Function} {} cos (@var{x})\n\
288 Compute the cosine of each element of @var{x}.\n\ 288 Compute the cosine of each element of @var{x}.\n\
313 erf (z) = (2/sqrt (pi)) | e^(-t^2) dt\n\ 313 erf (z) = (2/sqrt (pi)) | e^(-t^2) dt\n\
314 /\n\ 314 /\n\
315 t=0\n\ 315 t=0\n\
316 @end smallexample\n\ 316 @end smallexample\n\
317 @end ifinfo\n\ 317 @end ifinfo\n\
318 @end deftypefn\n\ 318 @seealso{erfc, erfinv}\n\
319 @seealso{erfc and erfinv}"); 319 @end deftypefn");
320 320
321 DEFUN_MAPPER (erfc, 0, 0, 0, erfc, 0, 0, 0.0, 0.0, 0, 0, 321 DEFUN_MAPPER (erfc, 0, 0, 0, erfc, 0, 0, 0.0, 0.0, 0, 0,
322 "-*- texinfo -*-\n\ 322 "-*- texinfo -*-\n\
323 @deftypefn {Mapping Function} {} erfc (@var{z})\n\ 323 @deftypefn {Mapping Function} {} erfc (@var{z})\n\
324 Computes the complementary error function,\n\ 324 Computes the complementary error function,\n\
328 @end tex\n\ 328 @end tex\n\
329 @end iftex\n\ 329 @end iftex\n\
330 @ifinfo\n\ 330 @ifinfo\n\
331 @code{1 - erf (@var{z})}.\n\ 331 @code{1 - erf (@var{z})}.\n\
332 @end ifinfo\n\ 332 @end ifinfo\n\
333 @end deftypefn\n\ 333 @seealso{erf, erfinv}\n\
334 \n\ 334 @end deftypefn");
335 @seealso{erf and erfinv}");
336 335
337 DEFUN_MAPPER (exp, 0, 0, 0, exp, 0, std::exp, 0.0, 0.0, 0, 0, 336 DEFUN_MAPPER (exp, 0, 0, 0, exp, 0, std::exp, 0.0, 0.0, 0, 0,
338 "-*- texinfo -*-\n\ 337 "-*- texinfo -*-\n\
339 @deftypefn {Mapping Function} {} exp (@var{x})\n\ 338 @deftypefn {Mapping Function} {} exp (@var{x})\n\
340 Compute the exponential of @var{x}. To compute the matrix exponential,\n\ 339 Compute the exponential of @var{x}. To compute the matrix exponential,\n\
388 gamma (z) = | t^(z-1) exp (-t) dt.\n\ 387 gamma (z) = | t^(z-1) exp (-t) dt.\n\
389 /\n\ 388 /\n\
390 t=0\n\ 389 t=0\n\
391 @end example\n\ 390 @end example\n\
392 @end ifinfo\n\ 391 @end ifinfo\n\
393 @end deftypefn\n\ 392 @seealso{gammai, lgamma}\n\
394 \n\ 393 @end deftypefn");
395 @seealso{gammai and lgamma}");
396 394
397 DEFUN_MAPPER (imag, 0, 0, 0, imag, ximag, 0, 0.0, 0.0, 0, 0, 395 DEFUN_MAPPER (imag, 0, 0, 0, imag, ximag, 0, 0.0, 0.0, 0, 0,
398 "-*- texinfo -*-\n\ 396 "-*- texinfo -*-\n\
399 @deftypefn {Mapping Function} {} imag (@var{z})\n\ 397 @deftypefn {Mapping Function} {} imag (@var{z})\n\
400 Return the imaginary part of @var{z} as a real number.\n\ 398 Return the imaginary part of @var{z} as a real number.\n\
401 @end deftypefn\n\ 399 @seealso{real, conj}\n\
402 \n\ 400 @end deftypefn");
403 @seealso{real and conj}");
404 401
405 DEFUN_MAPPER (isalnum, xisalnum, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0, 402 DEFUN_MAPPER (isalnum, xisalnum, 0, 0, 0, 0, 0, 0.0, 0.0, 0, 0,
406 "-*- texinfo -*-\n\ 403 "-*- texinfo -*-\n\
407 @deftypefn {Mapping Function} {} isalnum (@var{s})\n\ 404 @deftypefn {Mapping Function} {} isalnum (@var{s})\n\
408 Return 1 for characters that are letters or digits (@code{isalpha\n\ 405 Return 1 for characters that are letters or digits (@code{isalpha\n\
523 DEFUN_MAPPER (lgamma, 0, 0, 0, xlgamma, 0, 0, 0.0, 0.0, 0, 0, 520 DEFUN_MAPPER (lgamma, 0, 0, 0, xlgamma, 0, 0, 0.0, 0.0, 0, 0,
524 "-*- texinfo -*-\n\ 521 "-*- texinfo -*-\n\
525 @deftypefn {Mapping Function} {} lgamma (@var{x})\n\ 522 @deftypefn {Mapping Function} {} lgamma (@var{x})\n\
526 @deftypefnx {Mapping Function} {} gammaln (@var{x})\n\ 523 @deftypefnx {Mapping Function} {} gammaln (@var{x})\n\
527 Return the natural logarithm of the gamma function.\n\ 524 Return the natural logarithm of the gamma function.\n\
528 @end deftypefn\n\ 525 @seealso{gamma, gammai}\n\
529 @seealso{gamma and gammai}"); 526 @end deftypefn");
530 527
531 DEFUN_MAPPER (log, 0, 0, 0, log, 0, std::log, 0.0, octave_Inf, 0, 1, 528 DEFUN_MAPPER (log, 0, 0, 0, log, 0, std::log, 0.0, octave_Inf, 0, 1,
532 "-*- texinfo -*-\n\ 529 "-*- texinfo -*-\n\
533 @deftypefn {Mapping Function} {} log (@var{x})\n\ 530 @deftypefn {Mapping Function} {} log (@var{x})\n\
534 Compute the natural logarithm for each element of @var{x}. To compute the\n\ 531 Compute the natural logarithm for each element of @var{x}. To compute the\n\
535 matrix logarithm, see @ref{Linear Algebra}.\n\ 532 matrix logarithm, see @ref{Linear Algebra}.\n\
536 @end deftypefn\n\ 533 @seealso{log2, log10, logspace, exp}\n\
537 @seealso{log2, log10, logspace, and exp}"); 534 @end deftypefn");
538 535
539 DEFUN_MAPPER (log10, 0, 0, 0, log10, 0, std::log10, 0.0, octave_Inf, 0, 1, 536 DEFUN_MAPPER (log10, 0, 0, 0, log10, 0, std::log10, 0.0, octave_Inf, 0, 1,
540 "-*- texinfo -*-\n\ 537 "-*- texinfo -*-\n\
541 @deftypefn {Mapping Function} {} log10 (@var{x})\n\ 538 @deftypefn {Mapping Function} {} log10 (@var{x})\n\
542 Compute the base-10 logarithm for each element of @var{x}.\n\ 539 Compute the base-10 logarithm for each element of @var{x}.\n\
543 @end deftypefn\n\ 540 @seealso{log, log2, logspace, exp}\n\
544 @seealso{log, log2, logspace, and exp}"); 541 @end deftypefn");
545 542
546 DEFUN_MAPPER (real, 0, 0, 0, real, xreal, 0, 0.0, 0.0, 0, 0, 543 DEFUN_MAPPER (real, 0, 0, 0, real, xreal, 0, 0.0, 0.0, 0, 0,
547 "-*- texinfo -*-\n\ 544 "-*- texinfo -*-\n\
548 @deftypefn {Mapping Function} {} real (@var{z})\n\ 545 @deftypefn {Mapping Function} {} real (@var{z})\n\
549 Return the real part of @var{z}.\n\ 546 Return the real part of @var{z}.\n\
550 @end deftypefn\n\ 547 @seealso{imag, conj}\n\
551 @seealso{imag and conj}"); 548 @end deftypefn");
552 549
553 DEFUN_MAPPER (round, 0, 0, 0, xround, 0, xround, 0.0, 0.0, 0, 0, 550 DEFUN_MAPPER (round, 0, 0, 0, xround, 0, xround, 0.0, 0.0, 0, 0,
554 "-*- texinfo -*-\n\ 551 "-*- texinfo -*-\n\
555 @deftypefn {Mapping Function} {} round (@var{x})\n\ 552 @deftypefn {Mapping Function} {} round (@var{x})\n\
556 Return the integer nearest to @var{x}. If @var{x} is complex, return\n\ 553 Return the integer nearest to @var{x}. If @var{x} is complex, return\n\
557 @code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\ 554 @code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\
558 @end deftypefn\n\ 555 @seealso{rem}\n\
559 @seealso{rem}"); 556 @end deftypefn");
560 557
561 DEFUN_MAPPER (sign, 0, 0, 0, signum, 0, signum, 0.0, 0.0, 0, 0, 558 DEFUN_MAPPER (sign, 0, 0, 0, signum, 0, signum, 0.0, 0.0, 0, 0,
562 "-*- texinfo -*-\n\ 559 "-*- texinfo -*-\n\
563 @deftypefn {Mapping Function} {} sign (@var{x})\n\ 560 @deftypefn {Mapping Function} {} sign (@var{x})\n\
564 Compute the @dfn{signum} function, which is defined as\n\ 561 Compute the @dfn{signum} function, which is defined as\n\