# HG changeset patch
# User Rik <rdrider0-list@yahoo.com>
# Date 1244348737 25200
# Node ID f2bf62f6228692a98b52bd0c455d7d7d9a836355
# Parent  c2923c27c8771fb4cbf063427b217567fb3e200f
Update documentation for NA and isna functions

diff -r c2923c27c877 -r f2bf62f62286 src/ChangeLog
--- a/src/ChangeLog	Sat Jun 06 18:30:52 2009 -0700
+++ b/src/ChangeLog	Sat Jun 06 21:25:37 2009 -0700
@@ -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
diff -r c2923c27c877 -r f2bf62f62286 src/data.cc
--- a/src/data.cc	Sat Jun 06 18:30:52 2009 -0700
+++ b/src/data.cc	Sat Jun 06 21:25:37 2009 -0700
@@ -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 (), 
diff -r c2923c27c877 -r f2bf62f62286 src/mappers.cc
--- a/src/mappers.cc	Sat Jun 06 18:30:52 2009 -0700
+++ b/src/mappers.cc	Sat Jun 06 21:25:37 2009 -0700
@@ -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;