Updated Mappers Documentation

[Bill Denney]

Hi,

I added documentation (and one test) to the mappers.  There are many 
more @seealso references now.

Have a good day,

Bill

# HG changeset patch
# User address@hidden
# Date 1205592127 14400
# Node ID d7f2e316ba22a9ace07aaeafa207c7f552173b14
# Parent  5e794cfcbde1a74db488c5d266c67a2fbb09dea2
mappers.cc: documentation

diff -r 5e794cfcbde1 -r d7f2e316ba22 src/ChangeLog
--- a/src/ChangeLog     Sat Mar 15 09:52:29 2008 -0400
+++ b/src/ChangeLog     Sat Mar 15 10:42:07 2008 -0400
@@ -1,3 +1,7 @@ 2008-03-13  John W. Eaton  <address@hidden
+2008-03-15  Bill Denney  <address@hidden>
+
+       * mappers.cc: updated documentation, added one test
+
 2008-03-13  John W. Eaton  <address@hidden>
 
        * ov-usr-fcn.cc (octave_user_function::octave_user_function):
diff -r 5e794cfcbde1 -r d7f2e316ba22 src/mappers.cc
--- a/src/mappers.cc    Sat Mar 15 09:52:29 2008 -0400
+++ b/src/mappers.cc    Sat Mar 15 10:42:07 2008 -0400
@@ -57,6 +57,7 @@ abs (3 + 4i)\n\
      @result{} 5\n\
 @end group\n\
 @end example\n\
address@hidden
 @end deftypefn")
 {
   octave_value retval;
@@ -72,6 +73,7 @@ DEFUN (acos, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} acos (@var{x})\n\
 Compute the inverse cosine of each element of @var{x}.\n\
address@hidden,acosd,atan,cos,sin,tan,sec,csc,cot}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -88,6 +90,7 @@ DEFUN (acosh, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} acosh (@var{x})\n\
 Compute the inverse hyperbolic cosine of each element of @var{x}.\n\
address@hidden,atanh,cosh,sinh,tanh}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -102,7 +105,8 @@ DEFUN (angle, args, ,
 DEFUN (angle, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} angle (@var{z})\n\
-See arg.\n\
+See @code{arg}.\n\
address@hidden
 @end deftypefn")
 {
   octave_value retval;
@@ -138,6 +142,7 @@ arg (3 + 4i)\n\
      @result{} 0.92730\n\
 @end group\n\
 @end example\n\
address@hidden
 @end deftypefn")
 {
   octave_value retval;
@@ -153,6 +158,7 @@ DEFUN (asin, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} asin (@var{x})\n\
 Compute the inverse sine of each element of @var{x}.\n\
address@hidden,asind,atan,cos,sin,tan,sec,csc,cot}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -179,6 +185,7 @@ DEFUN (asinh, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} asinh (@var{x})\n\
 Compute the inverse hyperbolic sine of each element of @var{x}.\n\
address@hidden,atanh,cosh,sinh,tanh}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -194,6 +201,7 @@ DEFUN (atan, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} atan (@var{x})\n\
 Compute the inverse tangent of each element of @var{x}.\n\
address@hidden,asin,atand,cos,sin,tan,sec,csc,cot}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -209,6 +217,7 @@ DEFUN (atanh, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} atanh (@var{x})\n\
 Compute the inverse hyperbolic tangent of each element of @var{x}.\n\
address@hidden,asinh,cosh,sinh,tanh}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -225,6 +234,7 @@ DEFUN (ceil, args, ,
 @deftypefn {Mapping Function} {} ceil (@var{x})\n\
 Return the smallest integer not less than @var{x}.  If @var{x} is\n\
 complex, return @code{ceil (real (@var{x})) + ceil (imag (@var{x})) * I}.\n\
address@hidden,fix,round}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -264,6 +274,7 @@ DEFUN (cos, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} cos (@var{x})\n\
 Compute the cosine of each element of @var{x}.\n\
address@hidden,asin,atan,cosd,sin,tan,sec,csc,cot}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -279,6 +290,7 @@ DEFUN (cosh, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} cosh (@var{x})\n\
 Compute the hyperbolic cosine of each element of @var{x}.\n\
address@hidden,tanh,acosh,asinh,atanh}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -375,6 +387,7 @@ finite ([13, Inf, NA, NaN])\n\
      @result{} [ 1, 0, 0, 0 ]\n\
 @end group\n\
 @end example\n\
address@hidden,isna,isnan,isnumeric}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -386,11 +399,17 @@ finite ([13, Inf, NA, NaN])\n\
   return retval;
 }
 
+/*
+## Tests
+%!assert(finite ([13 Inf NA NaN]), [1 0 0 0])
+*/
+
 DEFUN (fix, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} fix (@var{x})\n\
 Truncate @var{x} toward zero.  If @var{x} is complex, return\n\
 @code{fix (real (@var{x})) + fix (imag (@var{x})) * I}.\n\
address@hidden,floor,round}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -408,6 +427,7 @@ DEFUN (floor, args, ,
 @deftypefn {Mapping Function} {} floor (@var{x})\n\
 Return the largest integer not greater than @var{x}.  If @var{x} is\n\
 complex, return @code{floor (real (@var{x})) + floor (imag (@var{x})) * I}.\n\
address@hidden,fix,round}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -473,6 +493,7 @@ DEFUNX ("isalnum", Fisalnum, args, ,
 @deftypefn {Mapping Function} {} isalnum (@var{s})\n\
 Return 1 for characters that are letters or digits (@code{isalpha\n\
 (@var{s})} or @code{isdigit (@var{s})} is true).\n\
address@hidden,isdigit,isnumeric,ispunct,isupper,islower}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -490,6 +511,7 @@ DEFUNX ("isalpha", Fisalpha, args, ,
 @deftypefnx {Mapping Function} {} isletter (@var{s})\n\
 Return true for characters that are letters (@code{isupper (@var{s})}\n\
 or @code{islower (@var{s})} is true).\n\
address@hidden,isdigit,isnumeric,isascii,ispunct}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -505,6 +527,7 @@ DEFUNX ("isascii", Fisascii, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} isascii (@var{s})\n\
 Return 1 for characters that are ASCII (in the range 0 to 127 decimal).\n\
address@hidden,isalpha,isdigit,ispunct}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -520,6 +543,7 @@ DEFUNX ("iscntrl", Fiscntrl, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} iscntrl (@var{s})\n\
 Return 1 for control characters.\n\
address@hidden,isascii,isdigit,isalnum,ispunct}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -535,6 +559,7 @@ DEFUNX ("isdigit", Fisdigit, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} isdigit (@var{s})\n\
 Return 1 for characters that are decimal digits.\n\
address@hidden,isalpha,isnumeric,isalnum,ispunct}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -558,6 +583,7 @@ isinf ([13, Inf, NA, NaN])\n\
      @result{} [ 0, 1, 0, 0 ]\n\
 @end group\n\
 @end example\n\
address@hidden,isfinite,isna}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -573,6 +599,7 @@ DEFUNX ("isgraph", Fisgraph, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} isgraph (@var{s})\n\
 Return 1 for printable characters (but not the space character).\n\
address@hidden,isalpha,iscntrl,isascii,ispunct}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -588,6 +615,7 @@ DEFUNX ("islower", Fislower, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} islower (@var{s})\n\
 Return 1 for characters that are lower case letters.\n\
address@hidden,isalpha,isalnum,isdigit,ispunct}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -611,6 +639,7 @@ isna ([13, Inf, NA, NaN])\n\
      @result{} [ 0, 0, 1, 0 ]\n\
 @end group\n\
 @end example\n\
address@hidden,isinf,isfinite,isnumeric}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -664,6 +693,7 @@ DEFUNX ("ispunct", Fispunct, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} ispunct (@var{s})\n\
 Return 1 for punctuation characters.\n\
address@hidden,isdigit,isnumeric,isalnum,isupper,islower}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -680,6 +710,7 @@ DEFUNX ("isspace", Fisspace, args, ,
 @deftypefn {Mapping Function} {} isspace (@var{s})\n\
 Return 1 for whitespace characters (space, formfeed, newline,\n\
 carriage return, tab, and vertical tab).\n\
address@hidden,isdigit,isnumeric,isalnum,isupper,islower}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -695,6 +726,7 @@ DEFUNX ("isupper", Fisupper, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} isupper (@var{s})\n\
 Return 1 for upper case letters.\n\
address@hidden,isdigit,isnumeric,isalnum,islower}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -710,6 +742,7 @@ DEFUNX ("isxdigit", Fisxdigit, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} isxdigit (@var{s})\n\
 Return 1 for characters that are hexadecimal digits.\n\
address@hidden,isnumeric,isalnum,isdigit}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -793,7 +826,7 @@ DEFUN (round, args, ,
 @deftypefn {Mapping Function} {} round (@var{x})\n\
 Return the integer nearest to @var{x}.  If @var{x} is complex, return\n\
 @code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\
address@hidden
address@hidden,floor,fix,mod,rem}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -826,6 +859,7 @@ sign (x) =  0, x = 0;\n\
 @end ifinfo\n\
 \n\
 For complex arguments, @code{sign} returns @code{x ./ abs (@var{x})}.\n\
address@hidden
 @end deftypefn")
 {
   octave_value retval;
@@ -841,6 +875,7 @@ DEFUN (sin, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} sin (@var{x})\n\
 Compute the sine of each element of @var{x}.\n\
address@hidden,asin,atan,cos,sind,tan,sec,csc,cot}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -856,6 +891,7 @@ DEFUN (sinh, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} sinh (@var{x})\n\
 Compute the hyperbolic sine of each element of @var{x}.\n\
address@hidden,tanh,acosh,asinh,atanh}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -888,6 +924,7 @@ DEFUN (tan, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} tan (@var{z})\n\
 Compute tangent of each element of @var{x}.\n\
address@hidden,asin,atan,cos,sin,tand,sec,csc,cot}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -903,6 +940,7 @@ DEFUN (tanh, args, ,
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} tanh (@var{x})\n\
 Compute hyperbolic tangent of each element of @var{x}.\n\
address@hidden,sinh,acosh,asinh,atanh}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -926,6 +964,7 @@ toascii (\"ASCII\")\n\
 @end group\n\
 \n\
 @end example\n\
address@hidden,double}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -948,6 +987,7 @@ tolower (\"MiXeD cAsE 123\")\n\
 tolower (\"MiXeD cAsE 123\")\n\
      @result{} \"mixed case 123\"\n\
 @end example\n\
address@hidden,upper,tolower,toupper}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -972,6 +1012,7 @@ toupper (\"MiXeD cAsE 123\")\n\
      @result{} \"MIXED CASE 123\"\n\
 @end group\n\
 @end example\n\
address@hidden,upper,tolower}\n\
 @end deftypefn")
 {
   octave_value retval;