update packages

[CreaPhase.git] / octave_packages / m / strings / hex2dec.m

diff --git a/octave_packages/m/strings/hex2dec.m b/octave_packages/m/strings/hex2dec.m
new file mode 100644 (file)
index 0000000..c998684
--- /dev/null
+++ b/octave_packages/m/strings/hex2dec.m
@@ -0,0 +1,65 @@
+## Copyright (C) 1996-2012 Daniel Calvelo
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {} hex2dec (@var{s})
+## Return the integer corresponding to the hexadecimal number represented
+## by the string @var{s}.  For example:
+##
+## @example
+## @group
+## hex2dec ("12B")
+##      @result{} 299
+## hex2dec ("12b")
+##      @result{} 299
+## @end group
+## @end example
+##
+## If @var{s} is a string matrix, return a column vector with one converted
+## number per row of @var{s}; Invalid rows evaluate to NaN@.
+##
+## If @var{s} is a cell array of strings, return a column vector with one
+## converted number per cell element in @var{s}.
+##
+## @seealso{dec2hex, base2dec, bin2dec}
+## @end deftypefn
+
+## Author: Daniel Calvelo <dcalvelo@yahoo.com>
+## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
+
+function d = hex2dec (s)
+
+  if (nargin != 1)
+    print_usage ();
+  endif
+
+  d = base2dec (s, 16);
+
+endfunction
+
+
+%!assert(hex2dec ("0000"), 0);
+%!assert(hex2dec ("1FFFFFFFFFFFFF"), 2^53-1);
+%!assert(hex2dec (["12b"; "12B"]), [299; 299]);
+%!assert(hex2dec ({"A1", "1A"}), [161; 26]);
+
+%%Test input validation
+%!error hex2dec ();
+%!error hex2dec (1);
+%!error hex2dec ("1", 2);
+