Mercurial > hg > octave-nkf

annotate scripts/general/iscolumn.m @ 17463:cc13924a4266 ss-3-7-7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
snapshot 3.7.7 * configure.ac (OCTAVE_VERSION): Bump to 3.7.7.
author John W. Eaton <jwe@octave.org>
date Mon, 23 Sep 2013 13:31:02 -0400
parents 72c96de7a403
children d63878346099
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14039
diff changeset
1 ## Copyright (C) 2012 John W. Eaton
12488
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
2 ##
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
3 ## This file is part of Octave.
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
4 ##
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
8 ## your option) any later version.
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
9 ##
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
13 ## General Public License for more details.
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
14 ##
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
18
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
19 ## -*- texinfo -*-
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
20 ## @deftypefn {Function File} {} iscolumn (@var{x})
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
21 ## Return true if @var{x} is a column vector.
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
22 ## @seealso{isrow, isscalar, isvector, ismatrix}
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
23 ## @end deftypefn
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
24
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
25 ## Author: Rik Wehbring
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
26
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
27 function retval = iscolumn (x)
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
28
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
29 if (nargin != 1)
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
30 print_usage ();
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
31 endif
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
32
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
33 sz = size (x);
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
34 retval = (ndims (x) == 2 && (sz(2) == 1));
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
35
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
36 endfunction
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
37
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
38
14039
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
39 %!assert (iscolumn ([1, 2, 3]), false)
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
40 %!assert (iscolumn ([1; 2; 3]))
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
41 %!assert (iscolumn (1))
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
42 %!assert (iscolumn ([]), false)
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
43 %!assert (iscolumn ([1, 2; 3, 4]), false)
12488
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
44
14039
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
45 %!assert (iscolumn ("t"))
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
46 %!assert (iscolumn ("test"), false)
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
47 %!assert (iscolumn (["test"; "ing"]), false)
12488
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
48
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
49 %!test
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
50 %! s.a = 1;
14039
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
51 %! assert (iscolumn (s));
12488
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
52
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
53 %% Test input validation
14039
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
54 %!error iscolumn ()
e98140f84ae0 test: Rewrite %!tests to preserve warning state.
Rik <octave@nomad.inbox5.com>
parents: 12604
diff changeset
55 %!error iscolumn ([1, 2], 2)
12488
bea828c03969 Add new isrow, iscolumn functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
56