octave_packages/m/general/issquare.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} {} issquare (@var{x})
  21 ## Return true if @var{x} is a square matrix.
  22 ## @seealso{isscalar, isvector, ismatrix, size}
  23 ## @end deftypefn
  24
  25 ## Author: A. S. Hodel <scotte@eng.auburn.edu>
  26 ## Created: August 1993
  27 ## Adapted-By: jwe
  28
  29 function retval = issquare (x)
  30
  31   if (nargin != 1)
  32     print_usage ();
  33   endif
  34
  35   if (ndims (x) == 2)
  36     [r, c] = size (x);
  37     retval = r == c;
  38   else
  39     retval = false;
  40   endif
  41
  42 endfunction
  43
  44 %!assert(issquare ([]));
  45 %!assert(issquare (1));
  46 %!assert(!(issquare ([1, 2])));
  47 %!assert(issquare ([1, 2; 3, 4]));
  48 %!assert(!(issquare ([1, 2; 3, 4; 5, 6])));
  49 %!assert(!(issquare (ones (3,3,3))));
  50 %!assert(issquare ("t"));
  51 %!assert(!(issquare ("test")));
  52 %!assert(issquare (["test"; "ing"; "1"; "2"]));
  53 %!test
  54 %! s.a = 1;
  55 %! assert(issquare (s));
  56 %!assert(issquare ({1, 2; 3, 4}));
  57 %!assert(sparse (([1, 2; 3, 4])));
  58
  59 %% Test input validation
  60 %!error issquare ();
  61 %!error issquare ([1, 2; 3, 4], 2);
  62