annotate libinterp/corefcn/typecast.cc @ 18794:03c2671493f9

maint: Periodic merge of gui-release to default.
author Rik <rik@octave.org>
date Mon, 02 Jun 2014 11:17:59 -0700
parents 175b392e91fe
children 6f3e922c5197
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
1 /*
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
2
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17396
diff changeset
3 Copyright (C) 2007-2013 David Bateman
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
4 Copyright (C) 2009 VZLU Prague
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
5
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
6 This file is part of Octave.
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
7
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6948
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6948
diff changeset
11 option) any later version.
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
12
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
16 for more details.
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
17
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
18 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: 6948
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6948
diff changeset
20 <http://www.gnu.org/licenses/>.
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
21
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
22 */
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
23
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
24 #ifdef HAVE_CONFIG_H
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
25 #include <config.h>
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
26 #endif
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
27
17396
0b644adf4f31 speak CHAR_BIT in C++-ese
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
28 #include <limits>
15289
27bdffcb41c5 *typecast.cc: Include <climits> for CHAR_BIT.
Júlio Hoffimann <julio.hoffimann@gmail.com>
parents: 15195
diff changeset
29
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
30 #include "mx-base.h"
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
31
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14360
diff changeset
32 #include "defun.h"
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
33 #include "error.h"
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
34 #include "gripes.h"
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
35 #include "oct-obj.h"
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
36 #include "unwind-prot.h"
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
37
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
38 static dim_vector
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
39 get_vec_dims (const dim_vector& old_dims, octave_idx_type n)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
40 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
41 if (old_dims.length () == 2 && old_dims(0) == 1)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
42 return dim_vector (1, n);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
43 else if (old_dims.length () == 2 && old_dims (0) == 0 && old_dims (1) == 0)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
44 return dim_vector ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
45 else
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
46 return dim_vector (n, 1);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
47 }
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
48
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
49 template <class ArrayType>
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
50 static void
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
51 get_data_and_bytesize (const ArrayType& array,
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
52 const void *& data,
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
53 octave_idx_type& byte_size,
10066
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9758
diff changeset
54 dim_vector& old_dims,
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9758
diff changeset
55 unwind_protect& frame)
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
56 {
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
57 // The array given may be a temporary, constructed from a scalar or sparse
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
58 // array. This will ensure the data will be deallocated after we exit.
10066
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9758
diff changeset
59 frame.add_delete (new ArrayType (array));
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
60
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
61 data = reinterpret_cast<const void *> (array.data ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
62 byte_size = array.byte_size ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
63
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
64 old_dims = array.dims ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
65 }
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
66
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
67 template <class ArrayType>
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
68 static ArrayType
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
69 reinterpret_copy (const void *data, octave_idx_type byte_size,
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
70 const dim_vector& old_dims)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
71 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
72 typedef typename ArrayType::element_type T;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
73 octave_idx_type n = byte_size / sizeof (T);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
74
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
75 if (n * static_cast<int> (sizeof (T)) == byte_size)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
76 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
77 ArrayType retval (get_vec_dims (old_dims, n));
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
78 T *dest = retval.fortran_vec ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
79 std::memcpy (dest, data, n * sizeof (T));
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
80
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
81 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
82 }
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
83 else
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
84 {
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
85 error ("typecast: incorrect number of input values to make output value");
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
86 return ArrayType ();
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
87 }
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
88 }
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
89
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
90
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14360
diff changeset
91 DEFUN (typecast, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
92 "-*- texinfo -*-\n\
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14360
diff changeset
93 @deftypefn {Built-in Function} {} typecast (@var{x}, @var{class})\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
94 Return a new array @var{y} resulting from interpreting the data of\n\
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9689
diff changeset
95 @var{x} in memory as data of the numeric class @var{class}. Both the class\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
96 of @var{x} and @var{class} must be one of the built-in numeric classes:\n\
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
97 \n\
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
98 @example\n\
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9689
diff changeset
99 @group\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
100 \"logical\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
101 \"char\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
102 \"int8\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
103 \"int16\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
104 \"int32\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
105 \"int64\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
106 \"uint8\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
107 \"uint16\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
108 \"uint32\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
109 \"uint64\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
110 \"double\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
111 \"single\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
112 \"double complex\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
113 \"single complex\"\n\
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9689
diff changeset
114 @end group\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
115 @end example\n\
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
116 \n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
117 @noindent\n\
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
118 the last two are reserved for @var{class}; they indicate that a\n\
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
119 complex-valued result is requested. Complex arrays are stored in memory as\n\
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
120 consecutive pairs of real numbers. The sizes of integer types are given by\n\
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
121 their bit counts. Both logical and char are typically one byte wide;\n\
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
122 however, this is not guaranteed by C++. If your system is IEEE conformant,\n\
12642
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 11586
diff changeset
123 single and double should be 4 bytes and 8 bytes wide, respectively.\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 15545
diff changeset
124 @qcode{\"logical\"} is not allowed for @var{class}. If the input is a row\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 15545
diff changeset
125 vector, the return value is a row vector, otherwise it is a column vector. \n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 15545
diff changeset
126 If the bit length of @var{x} is not divisible by that of @var{class}, an\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 15545
diff changeset
127 error occurs.\n\
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
128 \n\
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
129 An example of the use of typecast on a little-endian machine is\n\
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
130 \n\
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
131 @example\n\
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
132 @group\n\
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
133 @var{x} = uint16 ([1, 65535]);\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
134 typecast (@var{x}, \"uint8\")\n\
15542
69f45f3ab96a Correct big-endian/little-endian reversal in typecast documentation.
Rik <rik@octave.org>
parents: 14138
diff changeset
135 @result{} [ 1, 0, 255, 255]\n\
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
136 @end group\n\
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
137 @end example\n\
10807
bdde9c59f77a typecast: Combine two @seealso macro uses to one.
Rik <octave@nomad.inbox5.com>
parents: 10066
diff changeset
138 @seealso{cast, bitunpack, bitpack, swapbytes}\n\
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
139 @end deftypefn")
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
140 {
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
141 octave_value retval;
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
142
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
143 if (args.length () == 2)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
144 {
10066
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9758
diff changeset
145 unwind_protect frame;
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
146 const void *data = 0;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
147 octave_idx_type byte_size = 0;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
148 dim_vector old_dims;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
149
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
150 octave_value array = args(0);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
151
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
152 if (array.is_bool_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
153 get_data_and_bytesize (array.bool_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
154 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
155 else if (array.is_string ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
156 get_data_and_bytesize (array.char_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
157 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
158 else if (array.is_integer_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
159 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
160 if (array.is_int8_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
161 get_data_and_bytesize (array.int8_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
162 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
163 else if (array.is_int16_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
164 get_data_and_bytesize (array.int16_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
165 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
166 else if (array.is_int32_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
167 get_data_and_bytesize (array.int32_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
168 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
169 else if (array.is_int64_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
170 get_data_and_bytesize (array.int64_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
171 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
172 else if (array.is_uint8_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
173 get_data_and_bytesize (array.uint8_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
174 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
175 else if (array.is_uint16_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
176 get_data_and_bytesize (array.uint16_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
177 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
178 else if (array.is_uint32_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
179 get_data_and_bytesize (array.uint32_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
180 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
181 else if (array.is_uint64_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
182 get_data_and_bytesize (array.uint64_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
183 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
184 else
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
185 assert (0);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
186 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
187 else if (array.is_complex_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
188 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
189 if (array.is_single_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
190 get_data_and_bytesize (array.float_complex_array_value (), data,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
191 byte_size, old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
192 else
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
193 get_data_and_bytesize (array.complex_array_value (), data,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
194 byte_size, old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
195 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
196 else if (array.is_real_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
197 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
198 if (array.is_single_type ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
199 get_data_and_bytesize (array.float_array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
200 old_dims, frame);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
201 else
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
202 get_data_and_bytesize (array.array_value (), data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
203 old_dims, frame); }
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
204 else
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
205 error ("typecast: invalid input class: %s",
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
206 array.class_name ().c_str ());
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
207
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
208 std::string numclass = args(1).string_value ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
209
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
210 if (error_state || numclass.size () == 0)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
211 ;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
212 else if (numclass == "char")
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
213 retval = octave_value (reinterpret_copy<charNDArray>
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
214 (data, byte_size, old_dims), array.is_dq_string () ? '"'
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
215 : '\'');
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
216 else if (numclass[0] == 'i')
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
217 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
218 if (numclass == "int8")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
219 retval = reinterpret_copy<int8NDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
220 else if (numclass == "int16")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
221 retval = reinterpret_copy<int16NDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
222 else if (numclass == "int32")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
223 retval = reinterpret_copy<int32NDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
224 else if (numclass == "int64")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
225 retval = reinterpret_copy<int64NDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
226 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
227 else if (numclass[0] == 'u')
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
228 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
229 if (numclass == "uint8")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
230 retval = reinterpret_copy<uint8NDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
231 else if (numclass == "uint16")
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
232 retval = reinterpret_copy<uint16NDArray> (data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
233 old_dims);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
234 else if (numclass == "uint32")
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
235 retval = reinterpret_copy<uint32NDArray> (data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
236 old_dims);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
237 else if (numclass == "uint64")
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
238 retval = reinterpret_copy<uint64NDArray> (data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
239 old_dims);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
240 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
241 else if (numclass == "single")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
242 retval = reinterpret_copy<FloatNDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
243 else if (numclass == "double")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
244 retval = reinterpret_copy<NDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
245 else if (numclass == "single complex")
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
246 retval = reinterpret_copy<FloatComplexNDArray> (data, byte_size,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
247 old_dims);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
248 else if (numclass == "double complex")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
249 retval = reinterpret_copy<ComplexNDArray> (data, byte_size, old_dims);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
250
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
251 if (! error_state && retval.is_undefined ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
252 error ("typecast: cannot convert to %s class", numclass.c_str ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
253 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
254 else
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
255 print_usage ();
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
256
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
257 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
258 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
259
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
260 template <class ArrayType>
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
261 ArrayType
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
262 do_bitpack (const boolNDArray& bitp)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
263 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
264 typedef typename ArrayType::element_type T;
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
265 octave_idx_type n
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
266 = bitp.numel () / (sizeof (T) * std::numeric_limits<unsigned char>::digits);
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
267
17396
0b644adf4f31 speak CHAR_BIT in C++-ese
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
268 if (n * static_cast<int> (sizeof (T)) * std::numeric_limits<unsigned char>::digits == bitp.numel ())
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
269 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
270
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
271 ArrayType retval (get_vec_dims (bitp.dims (), n));
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
272
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
273 const bool *bits = bitp.fortran_vec ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
274 char *packed = reinterpret_cast<char *> (retval.fortran_vec ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
275
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
276 octave_idx_type m = n * sizeof (T);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
277
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
278 for (octave_idx_type i = 0; i < m; i++)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
279 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
280 char c = bits[0];
17396
0b644adf4f31 speak CHAR_BIT in C++-ese
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
281 for (int j = 1; j < std::numeric_limits<unsigned char>::digits; j++)
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
282 c |= bits[j] << j;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
283
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
284 packed[i] = c;
17396
0b644adf4f31 speak CHAR_BIT in C++-ese
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
285 bits += std::numeric_limits<unsigned char>::digits;
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
286 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
287
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
288 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
289 }
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
290 else
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
291 {
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
292 error ("bitpack: incorrect number of bits to make up output value");
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
293 return ArrayType ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
294 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
295 }
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
296
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14360
diff changeset
297 DEFUN (bitpack, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
298 "-*- texinfo -*-\n\
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14360
diff changeset
299 @deftypefn {Built-in Function} {@var{y} =} bitpack (@var{x}, @var{class})\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
300 Return a new array @var{y} resulting from interpreting an array\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
301 @var{x} as raw bit patterns for data of the numeric class @var{class}.\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
302 @var{class} must be one of the built-in numeric classes:\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
303 \n\
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
304 @example\n\
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9689
diff changeset
305 @group\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
306 \"char\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
307 \"int8\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
308 \"int16\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
309 \"int32\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
310 \"int64\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
311 \"uint8\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
312 \"uint16\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
313 \"uint32\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
314 \"uint64\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
315 \"double\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
316 \"single\"\n\
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9689
diff changeset
317 @end group\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
318 @end example\n\
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
319 \n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10807
diff changeset
320 The number of elements of @var{x} should be divisible by the bit length of\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
321 @var{class}. If it is not, excess bits are discarded. Bits come in\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
322 increasing order of significance, i.e., @code{x(1)} is bit 0, @code{x(2)} is\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
323 bit 1, etc. The result is a row vector if @var{x} is a row vector, otherwise\n\
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
324 it is a column vector.\n\
11572
7d6d8c1e471f Grammarcheck Texinfo for files in src directory.
Rik <octave@nomad.inbox5.com>
parents: 11553
diff changeset
325 @seealso{bitunpack, typecast}\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
326 @end deftypefn")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
327 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
328 octave_value retval;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
329
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
330 if (args.length () == 2 && args(0).is_bool_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
331 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
332 boolNDArray bitp = args(0).bool_array_value ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
333
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
334 std::string numclass = args(1).string_value ();
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
335
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
336 if (error_state || numclass.size () == 0)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
337 ;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
338 else if (numclass == "char")
9689
34d6f005db4b eliminate is_string argument from octave_value character array constructors
John W. Eaton <jwe@octave.org>
parents: 9671
diff changeset
339 retval = octave_value (do_bitpack<charNDArray> (bitp), '\'');
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
340 else if (numclass[0] == 'i')
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
341 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
342 if (numclass == "int8")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
343 retval = do_bitpack<int8NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
344 else if (numclass == "int16")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
345 retval = do_bitpack<int16NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
346 else if (numclass == "int32")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
347 retval = do_bitpack<int32NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
348 else if (numclass == "int64")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
349 retval = do_bitpack<int64NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
350 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
351 else if (numclass[0] == 'u')
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
352 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
353 if (numclass == "uint8")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
354 retval = do_bitpack<uint8NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
355 else if (numclass == "uint16")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
356 retval = do_bitpack<uint16NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
357 else if (numclass == "uint32")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
358 retval = do_bitpack<uint32NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
359 else if (numclass == "uint64")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
360 retval = do_bitpack<uint64NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
361 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
362 else if (numclass == "single")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
363 retval = do_bitpack<FloatNDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
364 else if (numclass == "double")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
365 retval = do_bitpack<NDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
366 else if (numclass == "single complex")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
367 retval = do_bitpack<FloatComplexNDArray> (bitp);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
368 else if (numclass == "double complex")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
369 retval = do_bitpack<ComplexNDArray> (bitp);
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
370
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
371 if (! error_state && retval.is_undefined ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
372 error ("bitpack: cannot pack to %s class", numclass.c_str ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
373 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
374 else
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
375 print_usage ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
376
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
377 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
378 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
379
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
380 template <class ArrayType>
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
381 boolNDArray
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
382 do_bitunpack (const ArrayType& array)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
383 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
384 typedef typename ArrayType::element_type T;
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
385 octave_idx_type n = array.numel () * sizeof (T)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
386 * std::numeric_limits<unsigned char>::digits;
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
387
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
388 boolNDArray retval (get_vec_dims (array.dims (), n));
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
389
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
390 const char *packed = reinterpret_cast<const char *> (array.fortran_vec ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
391 bool *bits = retval.fortran_vec ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
392
17396
0b644adf4f31 speak CHAR_BIT in C++-ese
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
393 octave_idx_type m = n / std::numeric_limits<unsigned char>::digits;
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
394
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
395 for (octave_idx_type i = 0; i < m; i++)
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
396 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
397 char c = packed[i];
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
398 bits[0] = c & 1;
17396
0b644adf4f31 speak CHAR_BIT in C++-ese
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
399 for (int j = 1; j < std::numeric_limits<unsigned char>::digits; j++)
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
400 bits[j] = (c >>= 1) & 1;
17396
0b644adf4f31 speak CHAR_BIT in C++-ese
John W. Eaton <jwe@octave.org>
parents: 17281
diff changeset
401 bits += std::numeric_limits<unsigned char>::digits;
6869
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
402 }
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
403
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
404 return retval;
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman]
dbateman
parents:
diff changeset
405 }
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
406
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14360
diff changeset
407 DEFUN (bitunpack, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
408 "-*- texinfo -*-\n\
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14360
diff changeset
409 @deftypefn {Built-in Function} {@var{y} =} bitunpack (@var{x})\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
410 Return an array @var{y} corresponding to the raw bit patterns of\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
411 @var{x}. @var{x} must belong to one of the built-in numeric classes:\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
412 \n\
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
413 @example\n\
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9689
diff changeset
414 @group\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
415 \"char\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
416 \"int8\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
417 \"int16\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
418 \"int32\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
419 \"int64\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
420 \"uint8\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
421 \"uint16\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
422 \"uint32\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
423 \"uint64\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
424 \"double\"\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
425 \"single\"\n\
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9689
diff changeset
426 @end group\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
427 @end example\n\
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
428 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
429 The result is a row vector if @var{x} is a row vector; otherwise, it is a\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
430 column vector.\n\
11572
7d6d8c1e471f Grammarcheck Texinfo for files in src directory.
Rik <octave@nomad.inbox5.com>
parents: 11553
diff changeset
431 @seealso{bitpack, typecast}\n\
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
432 @end deftypefn")
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
433 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
434 octave_value retval;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
435
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
436 if (args.length () == 1
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
437 && (args(0).is_numeric_type () || args(0).is_string ()))
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
438 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
439 octave_value array = args(0);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
440
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
441 if (array.is_string ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
442 retval = do_bitunpack (array.char_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
443 else if (array.is_integer_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
444 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
445 if (array.is_int8_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
446 retval = do_bitunpack (array.int8_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
447 else if (array.is_int16_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
448 retval = do_bitunpack (array.int16_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
449 else if (array.is_int32_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
450 retval = do_bitunpack (array.int32_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
451 else if (array.is_int64_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
452 retval = do_bitunpack (array.int64_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
453 else if (array.is_uint8_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
454 retval = do_bitunpack (array.uint8_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
455 else if (array.is_uint16_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
456 retval = do_bitunpack (array.uint16_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
457 else if (array.is_uint32_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
458 retval = do_bitunpack (array.uint32_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
459 else if (array.is_uint64_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
460 retval = do_bitunpack (array.uint64_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
461 else
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
462 assert (0);
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
463 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
464 else if (array.is_complex_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
465 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
466 if (array.is_single_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
467 retval = do_bitunpack (array.float_complex_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
468 else
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
469 retval = do_bitunpack (array.complex_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
470 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
471 else if (array.is_real_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
472 {
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
473 if (array.is_single_type ())
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
474 retval = do_bitunpack (array.float_array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
475 else
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
476 retval = do_bitunpack (array.array_value ());
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
477 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
478 else
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
479 error ("bitunpack: invalid input class: %s",
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
480 array.class_name ().c_str ());
9671
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
481 }
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
482 else
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
483 print_usage ();
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
484
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
485 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
486 }