Mercurial > hg > octave-terminal
changeset 9308:f2bf62f62286
Update documentation for NA and isna functions
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Sat, 06 Jun 2009 21:25:37 -0700 |
parents | c2923c27c877 |
children | fb8b8589dd46 |
files | src/ChangeLog src/data.cc src/mappers.cc |
diffstat | 3 files changed, 22 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2009-06-06 Rik <rdrider0-list@yahoo.com> + + * load-save.cc: Update documentation for NA and isna functions + 2009-06-06 Rik <rdrider0-list@yahoo.com> * load-save.cc: Update documentation for load and save
--- a/src/data.cc +++ b/src/data.cc @@ -3707,6 +3707,7 @@ arguments specify additional matrix dimensions.\n\ The optional argument @var{class} specifies the return type and may be\n\ either \"double\" or \"single\".\n\ +@seealso{isinf}\n\ @end deftypefn") { return fill_matrix (args, lo_ieee_inf_value (), @@ -4085,12 +4086,25 @@ DEFUN (NA, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} NA (@var{x})\n\ +@deftypefn {Built-in Function} {} NA\n\ +@deftypefnx {Built-in Function} {} NA (@var{n})\n\ @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m})\n\ @deftypefnx {Built-in Function} {} NA (@var{n}, @var{m}, @var{k}, @dots{})\n\ @deftypefnx {Built-in Function} {} NA (@dots{}, @var{class})\n\ -Return a matrix or N-dimensional array whose elements are all equal\n\ +Return a scalar, matrix, or N-dimensional array whose elements are all equal\n\ to the special constant used to designate missing values.\n\ +\n\ +Note that NA always compares not equal to NA (NA != NA).\n\ +To find NA values, use the @code{isna} function.\n\ +\n\ +When called with no arguments, return a scalar with the value @samp{NA}.\n\ +When called with a single argument, return a square matrix with the dimension\n\ +specified. When called with more than one scalar argument the first two\n\ +arguments are taken as the number of rows and columns and any further\n\ +arguments specify additional matrix dimensions.\n\ +The optional argument @var{class} specifies the return type and may be\n\ +either \"double\" or \"single\".\n\ +@seealso{isna}\n\ @end deftypefn") { return fill_matrix (args, lo_ieee_na_value (),
--- a/src/mappers.cc +++ b/src/mappers.cc @@ -1023,6 +1023,7 @@ @result{} [ 0, 0, 1, 0 ]\n\ @end group\n\ @end example\n\ +@seealso{isnan}\n\ @end deftypefn") { octave_value retval; @@ -1062,6 +1063,7 @@ @result{} [ 0, 0, 1, 1 ]\n\ @end group\n\ @end example\n\ +@seealso{isna}\n\ @end deftypefn") { octave_value retval;