Mercurial > octave-nkf
annotate src/ov-scalar.h @ 11129:0de5cc44e690
use gripe functions for NaN to logical and NaN to character conversions more consistently
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 21 Oct 2010 16:12:00 -0400 |
parents | d9e57045b9e1 |
children | fd0a3ac60b0e |
rev | line source |
---|---|
2376 | 1 /* |
2 | |
7017 | 3 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2005, 2006, |
8920 | 4 2007, 2008, 2009 John W. Eaton |
2376 | 5 |
6 This file is part of Octave. | |
7 | |
8 Octave is free software; you can redistribute it and/or modify it | |
9 under the terms of the GNU General Public License as published by the | |
7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
11 option) any later version. | |
2376 | 12 |
13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 for more details. | |
17 | |
18 You should have received a copy of the GNU General Public License | |
7016 | 19 along with Octave; see the file COPYING. If not, see |
20 <http://www.gnu.org/licenses/>. | |
2376 | 21 |
22 */ | |
23 | |
24 #if !defined (octave_scalar_h) | |
25 #define octave_scalar_h 1 | |
26 | |
27 #include <cstdlib> | |
28 | |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
29 #include <iosfwd> |
2376 | 30 #include <string> |
31 | |
5110 | 32 #include "lo-ieee.h" |
2889 | 33 #include "lo-mappers.h" |
2376 | 34 #include "lo-utils.h" |
35 #include "mx-base.h" | |
2477 | 36 #include "oct-alloc.h" |
2376 | 37 #include "str-vec.h" |
38 | |
5943 | 39 #include "gripes.h" |
2376 | 40 #include "ov-base.h" |
4749 | 41 #include "ov-re-mat.h" |
3223 | 42 #include "ov-base-scalar.h" |
2376 | 43 #include "ov-typeinfo.h" |
44 | |
45 class octave_value_list; | |
46 | |
47 class tree_walker; | |
48 | |
49 // Real scalar values. | |
50 | |
51 class | |
6153 | 52 OCTINTERP_API |
3223 | 53 octave_scalar : public octave_base_scalar<double> |
2376 | 54 { |
55 public: | |
56 | |
57 octave_scalar (void) | |
3223 | 58 : octave_base_scalar<double> (0.0) { } |
2376 | 59 |
60 octave_scalar (double d) | |
3223 | 61 : octave_base_scalar<double> (d) { } |
2376 | 62 |
63 octave_scalar (const octave_scalar& s) | |
3223 | 64 : octave_base_scalar<double> (s) { } |
2376 | 65 |
66 ~octave_scalar (void) { } | |
67 | |
5759 | 68 octave_base_value *clone (void) const { return new octave_scalar (*this); } |
4749 | 69 |
70 // We return an octave_matrix here instead of an octave_scalar so | |
71 // that in expressions like A(2,2,2) = 2 (for A previously | |
72 // undefined), A will be empty instead of a 1x1 object. | |
5759 | 73 octave_base_value *empty_clone (void) const { return new octave_matrix (); } |
2376 | 74 |
5885 | 75 octave_value do_index_op (const octave_value_list& idx, |
10313 | 76 bool resize_ok = false); |
2376 | 77 |
8345
c777f3ce02d8
smarter conversion lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8202
diff
changeset
|
78 type_conv_info numeric_demotion_function (void) const; |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
79 |
2376 | 80 idx_vector index_vector (void) const { return idx_vector (scalar); } |
81 | |
5110 | 82 octave_value any (int = 0) const |
83 { return (scalar != 0 && ! lo_ieee_isnan (scalar)); } | |
84 | |
9685 | 85 builtin_type_t builtin_type (void) const { return btyp_double; } |
86 | |
2376 | 87 bool is_real_scalar (void) const { return true; } |
88 | |
89 bool is_real_type (void) const { return true; } | |
90 | |
5895 | 91 bool is_double_type (void) const { return true; } |
92 | |
7576 | 93 bool is_float_type (void) const { return true; } |
94 | |
5533 | 95 int8NDArray |
96 int8_array_value (void) const | |
97 { return int8NDArray (dim_vector (1, 1), scalar); } | |
98 | |
99 int16NDArray | |
100 int16_array_value (void) const | |
101 { return int16NDArray (dim_vector (1, 1), scalar); } | |
102 | |
103 int32NDArray | |
104 int32_array_value (void) const | |
105 { return int32NDArray (dim_vector (1, 1), scalar); } | |
106 | |
107 int64NDArray | |
108 int64_array_value (void) const | |
109 { return int64NDArray (dim_vector (1, 1), scalar); } | |
110 | |
111 uint8NDArray | |
112 uint8_array_value (void) const | |
113 { return uint8NDArray (dim_vector (1, 1), scalar); } | |
114 | |
115 uint16NDArray | |
116 uint16_array_value (void) const | |
117 { return uint16NDArray (dim_vector (1, 1), scalar); } | |
118 | |
119 uint32NDArray | |
120 uint32_array_value (void) const | |
121 { return uint32NDArray (dim_vector (1, 1), scalar); } | |
122 | |
123 uint64NDArray | |
124 uint64_array_value (void) const | |
125 { return uint64NDArray (dim_vector (1, 1), scalar); } | |
126 | |
8854
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
127 #define DEFINE_INT_SCALAR_VALUE(TYPE) \ |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
128 octave_ ## TYPE \ |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
129 TYPE ## _scalar_value (void) const \ |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
130 { return octave_ ## TYPE (scalar); } |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
131 |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
132 DEFINE_INT_SCALAR_VALUE (int8) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
133 DEFINE_INT_SCALAR_VALUE (int16) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
134 DEFINE_INT_SCALAR_VALUE (int32) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
135 DEFINE_INT_SCALAR_VALUE (int64) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
136 DEFINE_INT_SCALAR_VALUE (uint8) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
137 DEFINE_INT_SCALAR_VALUE (uint16) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
138 DEFINE_INT_SCALAR_VALUE (uint32) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
139 DEFINE_INT_SCALAR_VALUE (uint64) |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
140 |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
141 #undef DEFINE_INT_SCALAR_VALUE |
97d146d1648b
add missing scalar->int scalar conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
8437
diff
changeset
|
142 |
2376 | 143 double double_value (bool = false) const { return scalar; } |
144 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
145 float float_value (bool = false) const { return static_cast<float> (scalar); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
146 |
2916 | 147 double scalar_value (bool = false) const { return scalar; } |
148 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
149 float float_scalar_value (bool = false) const { return static_cast<float> (scalar); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
150 |
3145 | 151 Matrix matrix_value (bool = false) const |
152 { return Matrix (1, 1, scalar); } | |
2376 | 153 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
154 FloatMatrix float_matrix_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
155 { return FloatMatrix (1, 1, scalar); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
156 |
4569 | 157 NDArray array_value (bool = false) const |
4630 | 158 { return NDArray (dim_vector (1, 1), scalar); } |
4505 | 159 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
160 FloatNDArray float_array_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
161 { return FloatNDArray (dim_vector (1, 1), scalar); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
162 |
5989 | 163 SparseMatrix sparse_matrix_value (bool = false) const |
164 { return SparseMatrix (Matrix (1, 1, scalar)); } | |
165 | |
8202
cf59d542f33e
replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
166 // FIXME Need SparseComplexMatrix (Matrix) constructor!!! |
5989 | 167 SparseComplexMatrix sparse_complex_matrix_value (bool = false) const |
168 { return SparseComplexMatrix (sparse_matrix_value ()); } | |
169 | |
5731 | 170 octave_value resize (const dim_vector& dv, bool fill = false) const; |
4915 | 171 |
2376 | 172 Complex complex_value (bool = false) const { return scalar; } |
173 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
174 FloatComplex float_complex_value (bool = false) const { return scalar; } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
175 |
2376 | 176 ComplexMatrix complex_matrix_value (bool = false) const |
177 { return ComplexMatrix (1, 1, Complex (scalar)); } | |
178 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
179 FloatComplexMatrix float_complex_matrix_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
180 { return FloatComplexMatrix (1, 1, FloatComplex (scalar)); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
181 |
4569 | 182 ComplexNDArray complex_array_value (bool = false) const |
4630 | 183 { return ComplexNDArray (dim_vector (1, 1), Complex (scalar)); } |
4569 | 184 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
185 FloatComplexNDArray float_complex_array_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
186 { return FloatComplexNDArray (dim_vector (1, 1), FloatComplex (scalar)); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
187 |
5533 | 188 charNDArray |
189 char_array_value (bool = false) const | |
190 { | |
191 charNDArray retval (dim_vector (1, 1)); | |
192 retval(0) = static_cast<char> (scalar); | |
193 return retval; | |
194 } | |
195 | |
5943 | 196 bool bool_value (bool warn = false) const |
197 { | |
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
198 if (xisnan (scalar)) |
11129
0de5cc44e690
use gripe functions for NaN to logical and NaN to character conversions more consistently
John W. Eaton <jwe@octave.org>
parents:
10759
diff
changeset
|
199 gripe_nan_to_logical_conversion (); |
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
200 else if (warn && scalar != 0 && scalar != 1) |
5943 | 201 gripe_logical_conversion (); |
202 | |
203 return scalar; | |
204 } | |
5533 | 205 |
5943 | 206 boolNDArray bool_array_value (bool warn = false) const |
207 { | |
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
208 if (xisnan (scalar)) |
11129
0de5cc44e690
use gripe functions for NaN to logical and NaN to character conversions more consistently
John W. Eaton <jwe@octave.org>
parents:
10759
diff
changeset
|
209 gripe_nan_to_logical_conversion (); |
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
210 else if (warn && scalar != 0 && scalar != 1) |
5943 | 211 gripe_logical_conversion (); |
212 | |
213 return boolNDArray (dim_vector (1, 1), scalar); | |
214 } | |
5533 | 215 |
5279 | 216 octave_value convert_to_str_internal (bool pad, bool force, char type) const; |
3223 | 217 |
2376 | 218 void increment (void) { ++scalar; } |
219 | |
220 void decrement (void) { --scalar; } | |
221 | |
6974 | 222 bool save_ascii (std::ostream& os); |
4687 | 223 |
224 bool load_ascii (std::istream& is); | |
225 | |
226 bool save_binary (std::ostream& os, bool& save_as_floats); | |
227 | |
228 bool load_binary (std::istream& is, bool swap, | |
10313 | 229 oct_mach_info::float_format fmt); |
4687 | 230 |
231 #if defined (HAVE_HDF5) | |
232 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
233 | |
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9812
diff
changeset
|
234 bool load_hdf5 (hid_t loc_id, const char *name); |
4687 | 235 #endif |
236 | |
4944 | 237 int write (octave_stream& os, int block_size, |
10313 | 238 oct_data_conv::data_type output_type, int skip, |
239 oct_mach_info::float_format flt_fmt) const | |
4944 | 240 { |
241 return os.write (array_value (), block_size, output_type, | |
10313 | 242 skip, flt_fmt); |
4944 | 243 } |
244 | |
5900 | 245 mxArray *as_mxArray (void) const; |
246 | |
9812
f80c566bc751
improve unary mapper system
Jaroslav Hajek <highegg@gmail.com>
parents:
9685
diff
changeset
|
247 octave_value map (unary_mapper_t umap) const; |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
248 |
10670
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
249 bool fast_elem_insert_self (void *where, builtin_type_t btyp) const; |
654fbde5dceb
make cellfun's fast scalar collection mechanism public
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
250 |
2376 | 251 private: |
252 | |
4612 | 253 DECLARE_OCTAVE_ALLOCATOR |
2477 | 254 |
4612 | 255 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
2376 | 256 }; |
257 | |
258 #endif |