octave_packages/m/general/iscolumn.m

   1 ## Copyright (C) 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} {} iscolumn (@var{x})
  21 ## Return true if @var{x} is a column vector.
  22 ## @seealso{isrow, isscalar, isvector, ismatrix}
  23 ## @end deftypefn
  24
  25 ## Author: Rik Wehbring
  26
  27 function retval = iscolumn (x)
  28
  29   if (nargin != 1)
  30     print_usage ();
  31   endif
  32
  33   sz = size (x);
  34   retval = (ndims (x) == 2 && (sz(2) == 1));
  35
  36 endfunction
  37
  38
  39 %!assert (iscolumn ([1, 2, 3]), false)
  40 %!assert (iscolumn ([1; 2; 3]))
  41 %!assert (iscolumn (1))
  42 %!assert (iscolumn ([]), false)
  43 %!assert (iscolumn ([1, 2; 3, 4]), false)
  44
  45 %!assert (iscolumn ("t"))
  46 %!assert (iscolumn ("test"), false)
  47 %!assert (iscolumn (["test"; "ing"]), false)
  48
  49 %!test
  50 %! s.a = 1;
  51 %! assert (iscolumn (s));
  52
  53 %% Test input validation
  54 %!error iscolumn ()
  55 %!error iscolumn ([1, 2], 2)
  56