|
2847
|
1 ## Copyright (C) 1996, 1997 John W. Eaton |
|
2313
|
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. |
|
245
|
19 |
|
3321
|
20 ## -*- texinfo -*- |
|
3373
|
21 ## @deftypefn {Function File} {} is_square (@var{x}) |
|
3321
|
22 ## If @var{x} is a square matrix, then return the dimension of @var{x}. |
|
|
23 ## Otherwise, return 0. |
|
|
24 ## @end deftypefn |
|
3408
|
25 ## @seealso{size, rows, columns, length, is_matrix, is_scalar, and is_vector} |
|
26
|
26 |
|
2312
|
27 ## Author: A. S. Hodel <scotte@eng.auburn.edu> |
|
|
28 ## Created: August 1993 |
|
|
29 ## Adapted-By: jwe |
|
26
|
30 |
|
2312
|
31 function retval = is_square (x) |
|
78
|
32 |
|
3197
|
33 retval = 0; |
|
|
34 |
|
26
|
35 if (nargin == 1) |
|
3197
|
36 if (is_matrix (x)) |
|
|
37 [nr, nc] = size (x); |
|
|
38 if (nr == nc && nr > 0) |
|
3426
|
39 retval = nr; |
|
3197
|
40 endif |
|
26
|
41 endif |
|
|
42 else |
|
904
|
43 usage ("is_square (x)"); |
|
26
|
44 endif |
|
|
45 |
|
|
46 endfunction |
