[Octave-bug-tracker] [bug #48088] document that issquare, iscolumn, isempty, etc operate on cell arrays

[Nicholas Jankowski]

Follow-up Comment #13, bug#48088 (group octave):

I'm still of the opinion that object is the right word to use. Even the Octave
docs have a section about built-in data types named 'Numeric Objects', and it
talks about the different built-in classes including numeric ones. But I do
see where the nomenclature gets muddy, and I also like using 'array' as the
generic term and only matrix where that's specifically the right one. I think
maybe the following would work if this an improvement i'll push a patch
later:

issquare

Return true if X is a 2-D square array.

     A square array is any 2-D object array for which 'size (X)' returns '[N,
N]' where N is a non-negative integer.


isvector

    Return true if X is a vector.

     A vector is any 2-D object array where one of the dimensions is equal to
1
     (either 1xN or Nx1).  As a consequence of this definition, a 1x1
     array (a scalar) is also a vector.



isscalar

   Return true if X is a scalar.

     A scalar is any single element 2-D object for which 'size (X)' 
         returns '[1, 1]'.


ismatrix

  Return true if X is a matrix.

     A matrix is an any object array where 'ndims (X) == 2' and for
     which 'size (X)' returns '[M, N]' with non-negative M and N.


isrow (and similar for iscolumn)

     Return true if X is a row vector.

     A row vector is any 2-D object array for which 'size (X)' returns '[1,
N]'
     with non-negative N.



isnull

    Return true if X is a special null array, string, or single quoted
     string.
<snip>


isdiag

    Return true if A is a diagonal numeric matrix, defined as a 2-D array
where all elements above and below the main diagonal are zero.


isbanded

 Return true if A is a numeric matrix with non-zero entries confined between 
 LOWER diagonals below the main diagonal and UPPER diagonals above the
     main diagonal.

     LOWER and UPPER must be non-negative integers.


issymmetric

 Return true if A is a symmetric or skew-symmetric numeric matrix within the
     tolerance specified by TOL.


istril

    Return true if A is a lower triangular numeric matrix.

     A lower triangular matrix has nonzero entries only on the main
     diagonal and below.



istriu

   Return true if A is an upper triangular numeric matrix.

     An upper triangular matrix has nonzero entries only on the main
     diagonal and above.


ishermitian

    Return true if A is a Hermitian or skew-Hermitian numeric matrix within
the
     tolerance specified by TOL.
<snip>


isdefinite

    Return true if A is symmetric positive definite numeric matrix within the
     tolerance specified by TOL.
<snip>




    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?48088>

_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/