X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=octave_packages%2Fm%2Fgeneral%2Fiscolumn.m;fp=octave_packages%2Fm%2Fgeneral%2Fiscolumn.m;h=b384bd373d712a5cb24d679017d14b527e9dd0d2;hb=1c0469ada9531828709108a4882a751d2816994a;hp=0000000000000000000000000000000000000000;hpb=63de9f36673d49121015e3695f2c336ea92bc278;p=CreaPhase.git diff --git a/octave_packages/m/general/iscolumn.m b/octave_packages/m/general/iscolumn.m new file mode 100644 index 0000000..b384bd3 --- /dev/null +++ b/octave_packages/m/general/iscolumn.m @@ -0,0 +1,56 @@ +## Copyright (C) 2012 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 +## . + +## -*- texinfo -*- +## @deftypefn {Function File} {} iscolumn (@var{x}) +## Return true if @var{x} is a column vector. +## @seealso{isrow, isscalar, isvector, ismatrix} +## @end deftypefn + +## Author: Rik Wehbring + +function retval = iscolumn (x) + + if (nargin != 1) + print_usage (); + endif + + sz = size (x); + retval = (ndims (x) == 2 && (sz(2) == 1)); + +endfunction + + +%!assert (iscolumn ([1, 2, 3]), false) +%!assert (iscolumn ([1; 2; 3])) +%!assert (iscolumn (1)) +%!assert (iscolumn ([]), false) +%!assert (iscolumn ([1, 2; 3, 4]), false) + +%!assert (iscolumn ("t")) +%!assert (iscolumn ("test"), false) +%!assert (iscolumn (["test"; "ing"]), false) + +%!test +%! s.a = 1; +%! assert (iscolumn (s)); + +%% Test input validation +%!error iscolumn () +%!error iscolumn ([1, 2], 2) +