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