Mercurial > octave-antonio
annotate scripts/strings/hex2dec.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 9fc020886ae9 |
children |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 ## Copyright (C) 1996-2015 Daniel Calvelo |
2313 | 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 | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 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 | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
2268 | 18 |
3361 | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {} hex2dec (@var{s}) | |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
21 ## Return the integer corresponding to the hexadecimal number represented by |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
22 ## the string @var{s}. |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
23 ## |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
24 ## For example: |
3426 | 25 ## |
3361 | 26 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
27 ## @group |
3361 | 28 ## hex2dec ("12B") |
14402
cbcaf5602469
doc: Make spacing nicer for Strings chapter of manual.
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
29 ## @result{} 299 |
3361 | 30 ## hex2dec ("12b") |
14402
cbcaf5602469
doc: Make spacing nicer for Strings chapter of manual.
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
31 ## @result{} 299 |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
32 ## @end group |
3361 | 33 ## @end example |
3789 | 34 ## |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
35 ## If @var{s} is a string matrix, return a column vector with one converted |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
36 ## number per row of @var{s}; Invalid rows evaluate to NaN@. |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
37 ## |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
38 ## If @var{s} is a cell array of strings, return a column vector with one |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
39 ## converted number per cell element in @var{s}. |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
40 ## |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
41 ## @seealso{dec2hex, base2dec, bin2dec} |
3361 | 42 ## @end deftypefn |
2268 | 43 |
3791 | 44 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> |
3789 | 45 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> |
2314 | 46 |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
47 function d = hex2dec (s) |
2268 | 48 |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
49 if (nargin != 1) |
6046 | 50 print_usage (); |
2268 | 51 endif |
52 | |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
53 d = base2dec (s, 16); |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
54 |
2268 | 55 endfunction |
7411 | 56 |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
57 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
58 %!assert (hex2dec ("0000"), 0) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
59 %!assert (hex2dec ("1FFFFFFFFFFFFF"), 2^53-1) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
60 %!assert (hex2dec (["12b"; "12B"]), [299; 299]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
61 %!assert (hex2dec ({"A1", "1A"}), [161; 26]) |
7411 | 62 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
63 ## Test input validation |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
64 %!error hex2dec () |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
65 %!error hex2dec (1) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
66 %!error hex2dec ("1", 2) |
7411 | 67 |