annotate scripts/strings/hex2dec.m @ 9051:1bf0ce0930be

Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents eb63fbe60fab
children 16f53d29049f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
1 ## Copyright (C) 1996, 1999, 2000, 2001, 2005, 2006, 2007, 2008 Daniel Calvelo
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## 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
6 ## 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: 6666
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6666
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## 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
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## 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: 6666
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6666
diff changeset
17 ## <http://www.gnu.org/licenses/>.
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
18
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
19 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
20 ## @deftypefn {Function File} {} hex2dec (@var{s})
6666
5d4ce539004f [project @ 2007-05-28 06:07:39 by jwe]
jwe
parents: 6046
diff changeset
21 ## Return the integer corresponding to the hexadecimal number stored
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
22 ## in the string @var{s}. For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
23 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
24 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
25 ## @group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
26 ## hex2dec ("12B")
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
27 ## @result{} 299
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
28 ## hex2dec ("12b")
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
29 ## @result{} 299
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
30 ## @end group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
31 ## @end example
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3426
diff changeset
32 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3426
diff changeset
33 ## 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: 3426
diff changeset
34 ## numbers, one per row of @var{s}. Invalid rows evaluate to NaN.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
35 ## @seealso{dec2hex, base2dec, dec2base, bin2dec, dec2bin}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
36 ## @end deftypefn
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
37
3791
c1c532a0acb2 [project @ 2001-02-09 15:28:23 by jwe]
jwe
parents: 3789
diff changeset
38 ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3426
diff changeset
39 ## 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
40
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
41 function d = hex2dec (h)
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
42
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
43 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
44 print_usage ();
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
45 else
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3426
diff changeset
46 d = base2dec (h, 16);
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
47 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
48
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
49 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
50
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
51 %!assert(hex2dec ("12b") == 299 && hex2dec ("12B") == 299);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
52
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
53 %!error hex2dec ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
54
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
55 %!error hex2dec ("str", 1);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
56