Mercurial > hg > octave-nkf

comparison src/data.cc @ 9308:f2bf62f62286

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation for NA and isna functions
author Rik <rdrider0-list@yahoo.com>
date Sat, 06 Jun 2009 21:25:37 -0700
parents 3b9aacf07744
children fb8b8589dd46
comparison
equal deleted inserted replaced
9307:c2923c27c877 9308:f2bf62f62286
3705 specified. When called with more than one scalar argument the first two\n\ 3705 specified. When called with more than one scalar argument the first two\n\
3706 arguments are taken as the number of rows and columns and any further\n\ 3706 arguments are taken as the number of rows and columns and any further\n\
3707 arguments specify additional matrix dimensions.\n\ 3707 arguments specify additional matrix dimensions.\n\
3708 The optional argument @var{class} specifies the return type and may be\n\ 3708 The optional argument @var{class} specifies the return type and may be\n\
3709 either \"double\" or \"single\".\n\ 3709 either \"double\" or \"single\".\n\
3710 @seealso{isinf}\n\
3710 @end deftypefn") 3711 @end deftypefn")
3711 { 3712 {
3712 return fill_matrix (args, lo_ieee_inf_value (), 3713 return fill_matrix (args, lo_ieee_inf_value (),
3713 lo_ieee_float_inf_value (), "Inf"); 3714 lo_ieee_float_inf_value (), "Inf");
3714 } 3715 }
4083 DEFALIAS (J, I); 4084 DEFALIAS (J, I);
4084 DEFALIAS (j, I); 4085 DEFALIAS (j, I);
4085 4086
4086 DEFUN (NA, args, , 4087 DEFUN (NA, args, ,
4087 "-*- texinfo -*-\n\ 4088 "-*- texinfo -*-\n\
4088 @deftypefn {Built-in Function} {} NA (@var{x})\n\ 4089 @deftypefn {Built-in Function} {} NA\n\
4090 @deftypefnx {Built-in Function} {} NA (@var{n})\n\
4089 @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m})\n\ 4091 @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m})\n\
4090 @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m}, @var{k}, @dots{})\n\ 4092 @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m}, @var{k}, @dots{})\n\
4091 @deftypefnx {Built-in Function} {} NA (@dots{}, @var{class})\n\ 4093 @deftypefnx {Built-in Function} {} NA (@dots{}, @var{class})\n\
4092 Return a matrix or N-dimensional array whose elements are all equal\n\ 4094 Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\
4093 to the special constant used to designate missing values.\n\ 4095 to the special constant used to designate missing values.\n\
4096 \n\
4097 Note that NA always compares not equal to NA (NA != NA).\n\
4098 To find NA values, use the @code{isna} function.\n\
4099 \n\
4100 When called with no arguments, return a scalar with the value @samp{NA}.\n\
4101 When called with a single argument, return a square matrix with the dimension\n\
4102 specified. When called with more than one scalar argument the first two\n\
4103 arguments are taken as the number of rows and columns and any further\n\
4104 arguments specify additional matrix dimensions.\n\
4105 The optional argument @var{class} specifies the return type and may be\n\
4106 either \"double\" or \"single\".\n\
4107 @seealso{isna}\n\
4094 @end deftypefn") 4108 @end deftypefn")
4095 { 4109 {
4096 return fill_matrix (args, lo_ieee_na_value (), 4110 return fill_matrix (args, lo_ieee_na_value (),
4097 lo_ieee_float_na_value (), "NA"); 4111 lo_ieee_float_na_value (), "NA");
4098 } 4112 }