octave_packages/m/general/isvector.m

   1 ## Copyright (C) 1996-2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} isvector (@var{x})
  21 ## Return true if @var{x} is a vector.  A vector is a 2-D array
  22 ## where one of the dimensions is equal to 1.  As a consequence a
  23 ## 1x1 array, or scalar, is also a vector.
  24 ## @seealso{isscalar, ismatrix, size, rows, columns, length}
  25 ## @end deftypefn
  26
  27 ## Author: jwe
  28
  29 function retval = isvector (x)
  30
  31   if (nargin != 1)
  32     print_usage ();
  33   endif
  34
  35   sz = size (x);
  36   retval = (ndims (x) == 2 && (sz(1) == 1 || sz(2) == 1));
  37
  38 endfunction
  39
  40
  41 %!assert (isvector (1))
  42 %!assert (isvector ([1; 2; 3]))
  43 %!assert (isvector ([]), false)
  44 %!assert (isvector ([1, 2; 3, 4]), false)
  45
  46 %!assert (isvector ("t"))
  47 %!assert (isvector ("test"))
  48 %!assert (isvector (["test"; "ing"]), false)
  49
  50 %!test
  51 %! s.a = 1;
  52 %! assert (isvector (s));
  53
  54 %% Test input validation
  55 %!error isvector ()
  56 %!error isvector ([1, 2], 2)
  57