annotate scripts/general/logical.m @ 6046:34f96dd5441b

[project @ 2006-10-10 16:10:25 by jwe]
author jwe
date Tue, 10 Oct 2006 16:10:31 +0000
parents 4c8a2e4e0717
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2823
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
2 ##
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
4 ##
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
9 ##
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
14 ##
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 3674
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 3674
diff changeset
18 ## 02110-1301, USA.
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
19
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
20 ## -*- texinfo -*-
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
21 ## @deftypefn {Function File} {} logical (@var{arg})
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
22 ## Convert @var{arg} to a logical value. For example,
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
23 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
24 ## @example
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
25 ## logical ([-1, 0, 1])
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
26 ## @end example
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
27 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
28 ## @noindent
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
29 ## is equivalent to
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
30 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
31 ## @example
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
32 ## [-1, 0, 1] != 0
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
33 ## @end example
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3225
diff changeset
34 ## @end deftypefn
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
35
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
36 ## Author: jwe
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
37
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
38 function y = logical (x)
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
39
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
40 if (nargin == 1)
3674
ef883684e58e [project @ 2000-06-07 17:11:33 by jwe]
jwe
parents: 3449
diff changeset
41 if (islogical (x) || isempty (x))
ef883684e58e [project @ 2000-06-07 17:11:33 by jwe]
jwe
parents: 3449
diff changeset
42 y = x;
ef883684e58e [project @ 2000-06-07 17:11:33 by jwe]
jwe
parents: 3449
diff changeset
43 elseif (isnumeric (x))
3225
7aae2c3636a7 [project @ 1998-12-04 23:20:12 by jwe]
jwe
parents: 2847
diff changeset
44 y = x != 0;
7aae2c3636a7 [project @ 1998-12-04 23:20:12 by jwe]
jwe
parents: 2847
diff changeset
45 else
3674
ef883684e58e [project @ 2000-06-07 17:11:33 by jwe]
jwe
parents: 3449
diff changeset
46 error ("logical not defined for type `%s'", typeinfo (x));
3225
7aae2c3636a7 [project @ 1998-12-04 23:20:12 by jwe]
jwe
parents: 2847
diff changeset
47 endif
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
48 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
49 print_usage ();
2823
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
50 endif
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
51
7ffbb34efd2d [project @ 1997-03-24 22:50:14 by jwe]
jwe
parents:
diff changeset
52 endfunction