Mercurial > hg > octave-nkf

comparison scripts/general/isrow.m @ 12488:bea828c03969

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add new isrow, iscolumn functions.
author Rik <octave@nomad.inbox5.com>
date Mon, 28 Feb 2011 22:35:41 -0800
parents
children 132c89bb44e3
comparison
equal deleted inserted replaced
12487:bac54daffde2 12488:bea828c03969
1 ## Copyright (C) 2011 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} {} isrow (@var{x})
21 ## Return true if @var{x} is a row vector.
22 ## @seealso{iscolumn, isscalar, isvector, ismatrix}
23 ## @end deftypefn
24
25 ## Author: Rik Wehbring
26
27 function retval = isrow (x)
28
29 retval = false;
30
31 if (nargin != 1)
32 print_usage ();
33 endif
34
35 sz = size (x);
36 retval = (ndims (x) == 2 && (sz(1) == 1));
37
38 endfunction
39
40 %!assert(isrow ([1, 2, 3]));
41 %!assert(isrow ([1; 2; 3]), false);
42 %!assert(isrow (1));
43 %!assert(isrow ([]), false);
44 %!assert(isrow ([1, 2; 3, 4]), false);
45
46 %!test
47 %! warning ("off", "Octave:str-to-num");
48 %! assert((isrow ("t")));
49 %!test
50 %! warning ("off", "Octave:str-to-num");
51 %! assert((isrow ("test")));
52
53 %!assert(!(isrow (["test"; "ing"])));
54
55 %!test
56 %! s.a = 1;
57 %! assert((isrow (s)));
58
59 %% Test input validation
60 %!error isrow ();
61 %!error isrow ([1, 2], 2);
62