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