home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts / general / is_square.m < prev    next >
Encoding:
Text File  |  1999-11-23  |  1.3 KB  |  48 lines
  1. ## Copyright (C) 1996, 1997 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 2, or (at your option)
  8. ## 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, write to the Free
  17. ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  18. ## 02111-1307, USA.
  19.  
  20. ## -*- texinfo -*-
  21. ## @deftypefn {Function File} {} is_square (@var{x})
  22. ## If @var{x} is a square matrix, then return the dimension of @var{x}.
  23. ## Otherwise, return 0.
  24. ## @end deftypefn
  25.  
  26. ## See also: size, rows, columns, length, is_matrix, is_scalar, is_vector
  27.  
  28. ## Author: A. S. Hodel <scotte@eng.auburn.edu>
  29. ## Created: August 1993
  30. ## Adapted-By: jwe
  31.  
  32. function retval = is_square (x)
  33.  
  34.   retval = 0;
  35.  
  36.   if (nargin == 1)
  37.     if (is_matrix (x))
  38.       [nr, nc] = size (x);
  39.       if (nr == nc && nr > 0)
  40.           retval = nr;
  41.       endif
  42.     endif
  43.   else
  44.     usage ("is_square (x)");
  45.   endif
  46.  
  47. endfunction
  48.