annotate scripts/strings/bin2dec.m @ 10821:693e22af08ae

Grammarcheck documentation of m-files Add newlines between @item fields for readability.
author Rik <octave@nomad.inbox5.com>
date Mon, 26 Jul 2010 21:25:36 -0700
parents 16f53d29049f
children 7e8ce65f73cf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9245
16f53d29049f update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9051
diff changeset
1 ## Copyright (C) 1996, 2000, 2001, 2005, 2006, 2007, 2008, 2009
16f53d29049f update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9051
diff changeset
2 ## Daniel Calvelo
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
3 ##
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5924
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5924
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5924
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5924
diff changeset
18 ## <http://www.gnu.org/licenses/>.
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
19
3446
5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe]
jwe
parents: 2355
diff changeset
20 ## -*- texinfo -*-
5666
4a48a1df26b7 [project @ 2006-03-15 02:37:55 by jwe]
jwe
parents: 5642
diff changeset
21 ## @deftypefn {Function File} {} bin2dec (@var{s})
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3446
diff changeset
22 ## Return the decimal number corresponding to the binary number stored
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
23 ## in the string @var{s}. For example:
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
24 ##
3446
5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe]
jwe
parents: 2355
diff changeset
25 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
26 ## @group
5666
4a48a1df26b7 [project @ 2006-03-15 02:37:55 by jwe]
jwe
parents: 5642
diff changeset
27 ## bin2dec ("1110")
3446
5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe]
jwe
parents: 2355
diff changeset
28 ## @result{} 14
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
29 ## @end group
3446
5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe]
jwe
parents: 2355
diff changeset
30 ## @end example
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3446
diff changeset
31 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3446
diff changeset
32 ## If @var{s} is a string matrix, returns a column vector of converted
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3446
diff changeset
33 ## numbers, one per row of @var{s}. Invalid rows evaluate to NaN.
5666
4a48a1df26b7 [project @ 2006-03-15 02:37:55 by jwe]
jwe
parents: 5642
diff changeset
34 ## @seealso{dec2hex, base2dec, dec2base, hex2dec, dec2bin}
3446
5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe]
jwe
parents: 2355
diff changeset
35 ## @end deftypefn
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
36
3791
c1c532a0acb2 [project @ 2001-02-09 15:28:23 by jwe]
jwe
parents: 3789
diff changeset
37 ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3446
diff changeset
38 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
39
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3446
diff changeset
40 function d = bin2dec (h)
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
41
5924
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
42 if (nargin == 1 && ischar (h))
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
43 n = rows (h);
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
44 d = zeros (n, 1);
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
45 for i = 1:n
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
46 s = h(i,:);
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
47 s = s(! isspace (s));
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
48 d(i) = base2dec (s, 2);
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
49 endfor
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
50 else
5924
87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe]
jwe
parents: 5666
diff changeset
51 print_usage ();
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
52 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
53
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
54 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
55
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
56 %!assert(bin2dec ("1110") == 14);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
57
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
58 %!error bin2dec ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
59
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
60 %!error bin2dec ("str", 1);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
61