changeset 10290:1756b3035282

clarify isnumeric and ismatrix
author Jaroslav Hajek <highegg@gmail.com>
date Wed, 10 Feb 2010 07:07:00 +0100
parents 4b124317dc38
children fc879f361bda
files src/ChangeLog src/data.cc
diffstat 2 files changed, 10 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2010-02-10  Jaroslav Hajek  <highegg@gmail.com>
+
+	* data.cc (Fisnumeric): Improve documentation.
+	(Fismatrix): Ditto.
+
 2010-02-09  John W. Eaton  <jwe@octave.org>
 
 	* graphics.cc, graphics.h.in
--- a/src/data.cc
+++ b/src/data.cc
@@ -3310,7 +3310,9 @@
 DEFUN (isnumeric, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} isnumeric (@var{x})\n\
-Return nonzero if @var{x} is a numeric object.\n\
+Return nonzero if @var{x} is a numeric object, i.e. an integer, real or complex array.\n\
+Logical and character arrays are not considered to be numeric.\n\
+@seealso{ischar, islogical, isinteger}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -3342,7 +3344,8 @@
 DEFUN (ismatrix, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} ismatrix (@var{a})\n\
-Return 1 if @var{a} is a matrix.  Otherwise, return 0.\n\
+Return 1 if @var{a} is a numeric, logical or character matrix or scalar.\n\
+Otherwise, return 0.\n\
 @end deftypefn")
 {
   octave_value retval = false;