annotate libinterp/corefcn/hex2num.cc @ 23220:092078913d54

maint: Merge stable to default.
author John W. Eaton <jwe@octave.org>
date Wed, 22 Feb 2017 12:58:07 -0500
parents ef4d915df748 3ac9f9ecfae5
children ef20eee0247d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 /*
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
2
23219
3ac9f9ecfae5 maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents: 23083
diff changeset
3 Copyright (C) 2008-2017 David Bateman
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
4
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 This file is part of Octave.
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
6
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
8 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
9 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
10 (at your option) any later version.
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
11
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
15 GNU General Public License for more details.
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
16
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
20
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 */
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
22
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21568
diff changeset
23 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21200
diff changeset
24 # include "config.h"
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 #endif
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
26
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 #include <algorithm>
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
28
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
29 #include "defun.h"
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 #include "error.h"
21100
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents: 20962
diff changeset
31 #include "errwarn.h"
20940
48b2ad5ee801 maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents: 20939
diff changeset
32 #include "ovl.h"
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 #include "utils.h"
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
34
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
35 DEFUN (hex2num, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
36 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
37 @deftypefn {} {@var{n} =} hex2num (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
38 @deftypefnx {} {@var{n} =} hex2num (@var{s}, @var{class})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
39 Typecast the 16 character hexadecimal character string to an IEEE 754
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
40 double precision number.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
41
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
42 If fewer than 16 characters are given the strings are right padded with
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
43 @qcode{'0'} characters.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
44
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
45 Given a string matrix, @code{hex2num} treats each row as a separate number.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
46
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
47 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
48 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
49 hex2num (["4005bf0a8b145769"; "4024000000000000"])
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
50 @result{} [2.7183; 10.000]
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
51 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
52 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
53
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
54 The optional argument @var{class} can be passed as the string
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
55 @qcode{"single"} to specify that the given string should be interpreted as
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
56 a single precision number. In this case, @var{s} should be an 8 character
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
57 hexadecimal string. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
58
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
59 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
60 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
61 hex2num (["402df854"; "41200000"], "single")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
62 @result{} [2.7183; 10.000]
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
63 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
64 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
65 @seealso{num2hex, hex2dec, dec2hex}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
66 @end deftypefn */)
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 {
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
68 int nargin = args.length ();
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
69
17178
f010db8b710c hex2num: Add single precision conversion option (bug #39608)
Mike Miller <mtmiller@ieee.org>
parents: 17177
diff changeset
70 if (nargin < 1 || nargin > 2)
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
71 print_usage ();
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20678
diff changeset
72
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20678
diff changeset
73 if (nargin == 2 && ! args(1).is_string ())
17178
f010db8b710c hex2num: Add single precision conversion option (bug #39608)
Mike Miller <mtmiller@ieee.org>
parents: 17177
diff changeset
74 error ("hex2num: CLASS must be a string");
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
75
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
76 const charMatrix cmat = args(0).char_matrix_value ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
77 std::string prec = (nargin == 2) ? args(1).string_value () : "double";
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
78 bool is_single = (prec == "single");
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
79 octave_idx_type nchars = (is_single) ? 8 : 16;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
80
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
81 if (cmat.columns () > nchars)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
82 error ("hex2num: S must be no more than %d characters", nchars);
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
83 else if (prec != "double" && prec != "single")
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
84 error ("hex2num: CLASS must be either \"double\" or \"single\"");
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
85
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
86 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
87 octave_idx_type nr = cmat.rows ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
88 octave_idx_type nc = cmat.columns ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
89
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
90 if (is_single)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
91 {
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
92 FloatColumnVector m (nr);
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
93
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
94 for (octave_idx_type i = 0; i < nr; i++)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
95 {
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
96 union
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
97 {
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
98 uint32_t ival;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
99 float dval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
100 } num;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
101
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
102 num.ival = 0;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
103
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
104 for (octave_idx_type j = 0; j < nc; j++)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
105 {
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
106 unsigned char ch = cmat.elem (i, j);
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
107
20962
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
108 if (! isxdigit (ch))
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
109 error ("hex2num: illegal character found in string S");
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
110
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
111 num.ival <<= 4;
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
112 if (ch >= 'a')
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
113 num.ival += static_cast<uint32_t> (ch - 'a' + 10);
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
114 else if (ch >= 'A')
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
115 num.ival += static_cast<uint32_t> (ch - 'A' + 10);
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
116 else
20962
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
117 num.ival += static_cast<uint32_t> (ch - '0');
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
118 }
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
119
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
120 if (nc < nchars)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
121 num.ival <<= (nchars - nc) * 4;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
122
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
123 m(i) = num.dval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
124 }
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
125
21568
3d60ed163b70 maint: Eliminate bad spacing around '='.
Rik <rik@octave.org>
parents: 21301
diff changeset
126 retval = m;
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
127 }
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
128 else
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
129 {
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
130 ColumnVector m (nr);
8808
d724487d2c4b hex2num.cc: use union to avoid cast and GCC warning
John W. Eaton <jwe@octave.org>
parents: 8807
diff changeset
131
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
132 for (octave_idx_type i = 0; i < nr; i++)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
133 {
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
134 union
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
135 {
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
136 uint64_t ival;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
137 double dval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
138 } num;
13222
82f3a0c27569 fix warnings for uninitialized variables
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
139
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
140 num.ival = 0;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
141
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
142 for (octave_idx_type j = 0; j < nc; j++)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
143 {
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
144 unsigned char ch = cmat.elem (i, j);
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
145
20962
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
146 if (! isxdigit (ch))
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
147 error ("hex2num: illegal character found in string S");
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
148
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
149 num.ival <<= 4;
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
150 if (ch >= 'a')
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
151 num.ival += static_cast<uint64_t> (ch - 'a' + 10);
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
152 else if (ch >= 'A')
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
153 num.ival += static_cast<uint64_t> (ch - 'A' + 10);
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
154 else
20962
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
155 num.ival += static_cast<uint64_t> (ch - '0');
17178
f010db8b710c hex2num: Add single precision conversion option (bug #39608)
Mike Miller <mtmiller@ieee.org>
parents: 17177
diff changeset
156 }
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
157
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
158 if (nc < nchars)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
159 num.ival <<= (nchars - nc) * 4;
17178
f010db8b710c hex2num: Add single precision conversion option (bug #39608)
Mike Miller <mtmiller@ieee.org>
parents: 17177
diff changeset
160
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
161 m(i) = num.dval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
162 }
17178
f010db8b710c hex2num: Add single precision conversion option (bug #39608)
Mike Miller <mtmiller@ieee.org>
parents: 17177
diff changeset
163
21568
3d60ed163b70 maint: Eliminate bad spacing around '='.
Rik <rik@octave.org>
parents: 21301
diff changeset
164 retval = m;
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
165 }
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
166
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
167 return retval;
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
168 }
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
169
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
170 /*
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
171 %!assert (hex2num (["c00";"bff";"000";"3ff";"400"]), [-2:2]')
17178
f010db8b710c hex2num: Add single precision conversion option (bug #39608)
Mike Miller <mtmiller@ieee.org>
parents: 17177
diff changeset
172 %!assert (hex2num (["c00";"bf8";"000";"3f8";"400"], "single"), single([-2:2])')
8808
d724487d2c4b hex2num.cc: use union to avoid cast and GCC warning
John W. Eaton <jwe@octave.org>
parents: 8807
diff changeset
173 */
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
174
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
175 DEFUN (num2hex, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
176 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
177 @deftypefn {} {@var{s} =} num2hex (@var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
178 Typecast a double or single precision number or vector to a 8 or 16
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
179 character hexadecimal string of the IEEE 754 representation of the number.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
180
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
181 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
182
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
183 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
184 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
185 num2hex ([-1, 1, e, Inf])
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
186 @result{} "bff0000000000000
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
187 3ff0000000000000
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
188 4005bf0a8b145769
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
189 7ff0000000000000"
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
190 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
191 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
192
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
193 If the argument @var{n} is a single precision number or vector, the returned
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
194 string has a length of 8. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
195
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
196 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
197 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
198 num2hex (single ([-1, 1, e, Inf]))
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
199 @result{} "bf800000
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
200 3f800000
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
201 402df854
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
202 7f800000"
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
203 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
204 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
205 @seealso{hex2num, hex2dec, dec2hex}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21839
diff changeset
206 @end deftypefn */)
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
207 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20812
diff changeset
208 if (args.length () != 1)
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
209 print_usage ();
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20678
diff changeset
210
21839
6b4f6339df91 num2hex: Report an error on complex arguments (bug #48184)
Mike Miller <mtmiller@octave.org>
parents: 21724
diff changeset
211 if (args(0).is_complex_type ())
6b4f6339df91 num2hex: Report an error on complex arguments (bug #48184)
Mike Miller <mtmiller@octave.org>
parents: 21724
diff changeset
212 error ("num2hex: N must be real");
6b4f6339df91 num2hex: Report an error on complex arguments (bug #48184)
Mike Miller <mtmiller@octave.org>
parents: 21724
diff changeset
213
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
214 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
215
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20678
diff changeset
216 if (args(0).is_single_type ())
17177
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
217 {
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
218 const FloatColumnVector v (args(0).float_vector_value ());
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
219
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
220 octave_idx_type nchars = 8;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
221 octave_idx_type nr = v.numel ();
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
222 charMatrix m (nr, nchars);
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
223 const float *pv = v.fortran_vec ();
17177
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
224
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
225 for (octave_idx_type i = 0; i < nr; i++)
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
226 {
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
227 union
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
228 {
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
229 uint32_t ival;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
230 float dval;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
231 } num;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
232
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
233 num.dval = *pv++;
17177
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
234
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
235 for (octave_idx_type j = 0; j < nchars; j++)
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
236 {
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
237 unsigned char ch =
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
238 static_cast<char>(num.ival >> ((nchars - 1 - j) * 4) & 0xF);
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
239 if (ch >= 10)
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
240 ch += 'a' - 10;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
241 else
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
242 ch += '0';
17177
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
243
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
244 m.elem (i, j) = ch;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
245 }
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
246 }
17177
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
247
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
248 retval = m;
17177
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
249 }
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
250 else
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
251 {
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
252 const ColumnVector v (args(0).vector_value ());
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
253
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
254 octave_idx_type nchars = 16;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
255 octave_idx_type nr = v.numel ();
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
256 charMatrix m (nr, nchars);
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
257 const double *pv = v.fortran_vec ();
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
258
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
259 for (octave_idx_type i = 0; i < nr; i++)
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
260 {
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
261 union
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
262 {
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
263 uint64_t ival;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
264 double dval;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
265 } num;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
266
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
267 num.dval = *pv++;
8808
d724487d2c4b hex2num.cc: use union to avoid cast and GCC warning
John W. Eaton <jwe@octave.org>
parents: 8807
diff changeset
268
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
269 for (octave_idx_type j = 0; j < nchars; j++)
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
270 {
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
271 unsigned char ch =
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
272 static_cast<char>(num.ival >> ((nchars - 1 - j) * 4) & 0xF);
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
273 if (ch >= 10)
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
274 ch += 'a' - 10;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
275 else
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
276 ch += '0';
8808
d724487d2c4b hex2num.cc: use union to avoid cast and GCC warning
John W. Eaton <jwe@octave.org>
parents: 8807
diff changeset
277
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
278 m.elem (i, j) = ch;
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
279 }
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
280 }
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
281
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
282 retval = m;
7639
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
283 }
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
284
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
285 return retval;
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
286 }
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
287
b2fbb393a072 Add the num2hex and hex2num functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
288 /*
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
289 %!assert (num2hex (-2:2), ["c000000000000000";"bff0000000000000";"0000000000000000";"3ff0000000000000";"4000000000000000"])
17177
81d3c4409645 num2hex: Handle single precision argument correctly (bug #39607)
Mike Miller <mtmiller@ieee.org>
parents: 15195
diff changeset
290 %!assert (num2hex (single (-2:2)), ["c0000000";"bf800000";"00000000";"3f800000";"40000000"])
21839
6b4f6339df91 num2hex: Report an error on complex arguments (bug #48184)
Mike Miller <mtmiller@octave.org>
parents: 21724
diff changeset
291
6b4f6339df91 num2hex: Report an error on complex arguments (bug #48184)
Mike Miller <mtmiller@octave.org>
parents: 21724
diff changeset
292 %!error num2hex ()
6b4f6339df91 num2hex: Report an error on complex arguments (bug #48184)
Mike Miller <mtmiller@octave.org>
parents: 21724
diff changeset
293 %!error num2hex (1,2)
6b4f6339df91 num2hex: Report an error on complex arguments (bug #48184)
Mike Miller <mtmiller@octave.org>
parents: 21724
diff changeset
294 %!error num2hex (1j)
8808
d724487d2c4b hex2num.cc: use union to avoid cast and GCC warning
John W. Eaton <jwe@octave.org>
parents: 8807
diff changeset
295 */