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