Mercurial > octave-nkf
annotate src/ov-scalar.h @ 7961:a5d1e27ee1f4 ss-3-1-51
3.1.51 snapshot
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 22 Jul 2008 11:40:48 -0400 |
| parents | 935be827eaf8 |
| children | cf59d542f33e |
| rev | line source |
|---|---|
| 2376 | 1 /* |
| 2 | |
| 7017 | 3 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2005, 2006, |
| 4 2007 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 | |
| 3503 | 29 #include <iostream> |
| 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_map; | |
| 46 class octave_value_list; | |
| 47 | |
| 48 class tree_walker; | |
| 49 | |
| 50 // Real scalar values. | |
| 51 | |
| 52 class | |
| 6153 | 53 OCTINTERP_API |
| 3223 | 54 octave_scalar : public octave_base_scalar<double> |
| 2376 | 55 { |
| 56 public: | |
| 57 | |
| 58 octave_scalar (void) | |
| 3223 | 59 : octave_base_scalar<double> (0.0) { } |
| 2376 | 60 |
| 61 octave_scalar (double d) | |
| 3223 | 62 : octave_base_scalar<double> (d) { } |
| 2376 | 63 |
| 64 octave_scalar (const octave_scalar& s) | |
| 3223 | 65 : octave_base_scalar<double> (s) { } |
| 2376 | 66 |
| 67 ~octave_scalar (void) { } | |
| 68 | |
| 5759 | 69 octave_base_value *clone (void) const { return new octave_scalar (*this); } |
| 4749 | 70 |
| 71 // We return an octave_matrix here instead of an octave_scalar so | |
| 72 // that in expressions like A(2,2,2) = 2 (for A previously | |
| 73 // undefined), A will be empty instead of a 1x1 object. | |
| 5759 | 74 octave_base_value *empty_clone (void) const { return new octave_matrix (); } |
| 2376 | 75 |
| 5885 | 76 octave_value do_index_op (const octave_value_list& idx, |
| 77 bool resize_ok = false); | |
| 2376 | 78 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
79 type_conv_fcn numeric_demotion_function (void) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
80 |
| 2376 | 81 idx_vector index_vector (void) const { return idx_vector (scalar); } |
| 82 | |
| 5110 | 83 octave_value any (int = 0) const |
| 84 { return (scalar != 0 && ! lo_ieee_isnan (scalar)); } | |
| 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 | |
| 2376 | 94 bool valid_as_scalar_index (void) const |
| 5042 | 95 { |
| 96 return (! xisnan (scalar) | |
| 97 && D_NINT (scalar) == scalar | |
| 5275 | 98 && NINTbig (scalar) == 1); |
| 5042 | 99 } |
| 2376 | 100 |
| 101 bool valid_as_zero_index (void) const | |
| 5042 | 102 { |
| 103 return (! xisnan (scalar) | |
| 104 && D_NINT (scalar) == scalar | |
| 5275 | 105 && NINTbig (scalar) == 0); |
| 5042 | 106 } |
| 2376 | 107 |
| 5533 | 108 int8NDArray |
| 109 int8_array_value (void) const | |
| 110 { return int8NDArray (dim_vector (1, 1), scalar); } | |
| 111 | |
| 112 int16NDArray | |
| 113 int16_array_value (void) const | |
| 114 { return int16NDArray (dim_vector (1, 1), scalar); } | |
| 115 | |
| 116 int32NDArray | |
| 117 int32_array_value (void) const | |
| 118 { return int32NDArray (dim_vector (1, 1), scalar); } | |
| 119 | |
| 120 int64NDArray | |
| 121 int64_array_value (void) const | |
| 122 { return int64NDArray (dim_vector (1, 1), scalar); } | |
| 123 | |
| 124 uint8NDArray | |
| 125 uint8_array_value (void) const | |
| 126 { return uint8NDArray (dim_vector (1, 1), scalar); } | |
| 127 | |
| 128 uint16NDArray | |
| 129 uint16_array_value (void) const | |
| 130 { return uint16NDArray (dim_vector (1, 1), scalar); } | |
| 131 | |
| 132 uint32NDArray | |
| 133 uint32_array_value (void) const | |
| 134 { return uint32NDArray (dim_vector (1, 1), scalar); } | |
| 135 | |
| 136 uint64NDArray | |
| 137 uint64_array_value (void) const | |
| 138 { return uint64NDArray (dim_vector (1, 1), scalar); } | |
| 139 | |
| 2376 | 140 double double_value (bool = false) const { return scalar; } |
| 141 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
142 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
|
143 |
| 2916 | 144 double scalar_value (bool = false) const { return scalar; } |
| 145 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
146 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
|
147 |
| 3145 | 148 Matrix matrix_value (bool = false) const |
| 149 { return Matrix (1, 1, scalar); } | |
| 2376 | 150 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
151 FloatMatrix float_matrix_value (bool = false) const |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
152 { return FloatMatrix (1, 1, scalar); } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
153 |
| 4569 | 154 NDArray array_value (bool = false) const |
| 4630 | 155 { return NDArray (dim_vector (1, 1), scalar); } |
| 4505 | 156 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
157 FloatNDArray float_array_value (bool = false) const |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
158 { return FloatNDArray (dim_vector (1, 1), scalar); } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
159 |
| 5989 | 160 SparseMatrix sparse_matrix_value (bool = false) const |
| 161 { return SparseMatrix (Matrix (1, 1, scalar)); } | |
| 162 | |
| 163 // XXX FIXME XXX Need SparseComplexMatrix (Matrix) constructor!!! | |
| 164 SparseComplexMatrix sparse_complex_matrix_value (bool = false) const | |
| 165 { return SparseComplexMatrix (sparse_matrix_value ()); } | |
| 166 | |
| 5731 | 167 octave_value resize (const dim_vector& dv, bool fill = false) const; |
| 4915 | 168 |
| 2376 | 169 Complex complex_value (bool = false) const { return scalar; } |
| 170 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
171 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
|
172 |
| 2376 | 173 ComplexMatrix complex_matrix_value (bool = false) const |
| 174 { return ComplexMatrix (1, 1, Complex (scalar)); } | |
| 175 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
176 FloatComplexMatrix float_complex_matrix_value (bool = false) const |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
177 { return FloatComplexMatrix (1, 1, FloatComplex (scalar)); } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
178 |
| 4569 | 179 ComplexNDArray complex_array_value (bool = false) const |
| 4630 | 180 { return ComplexNDArray (dim_vector (1, 1), Complex (scalar)); } |
| 4569 | 181 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
182 FloatComplexNDArray float_complex_array_value (bool = false) const |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
183 { return FloatComplexNDArray (dim_vector (1, 1), FloatComplex (scalar)); } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
184 |
| 5533 | 185 charNDArray |
| 186 char_array_value (bool = false) const | |
| 187 { | |
| 188 charNDArray retval (dim_vector (1, 1)); | |
| 189 retval(0) = static_cast<char> (scalar); | |
| 190 return retval; | |
| 191 } | |
| 192 | |
| 5943 | 193 bool bool_value (bool warn = false) const |
| 194 { | |
|
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
195 if (xisnan (scalar)) |
|
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
196 error ("invalid conversion from NaN to logical"); |
|
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
197 else if (warn && scalar != 0 && scalar != 1) |
| 5943 | 198 gripe_logical_conversion (); |
| 199 | |
| 200 return scalar; | |
| 201 } | |
| 5533 | 202 |
| 5943 | 203 boolNDArray bool_array_value (bool warn = false) const |
| 204 { | |
|
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
205 if (xisnan (scalar)) |
|
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
206 error ("invalid conversion from NaN to logical"); |
|
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7885
diff
changeset
|
207 else if (warn && scalar != 0 && scalar != 1) |
| 5943 | 208 gripe_logical_conversion (); |
| 209 | |
| 210 return boolNDArray (dim_vector (1, 1), scalar); | |
| 211 } | |
| 5533 | 212 |
| 5279 | 213 octave_value convert_to_str_internal (bool pad, bool force, char type) const; |
| 3223 | 214 |
| 2376 | 215 void increment (void) { ++scalar; } |
| 216 | |
| 217 void decrement (void) { --scalar; } | |
| 218 | |
| 6974 | 219 bool save_ascii (std::ostream& os); |
| 4687 | 220 |
| 221 bool load_ascii (std::istream& is); | |
| 222 | |
| 223 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 224 | |
| 225 bool load_binary (std::istream& is, bool swap, | |
| 226 oct_mach_info::float_format fmt); | |
| 227 | |
| 228 #if defined (HAVE_HDF5) | |
| 229 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 230 | |
| 231 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); | |
| 232 #endif | |
| 233 | |
| 4944 | 234 int write (octave_stream& os, int block_size, |
| 235 oct_data_conv::data_type output_type, int skip, | |
| 236 oct_mach_info::float_format flt_fmt) const | |
| 237 { | |
| 238 return os.write (array_value (), block_size, output_type, | |
| 239 skip, flt_fmt); | |
| 240 } | |
| 241 | |
| 5900 | 242 mxArray *as_mxArray (void) const; |
| 243 | |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
244 octave_value erf (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
245 octave_value erfc (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
246 octave_value gamma (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
247 octave_value lgamma (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
248 octave_value abs (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
249 octave_value acos (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
250 octave_value acosh (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
251 octave_value angle (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
252 octave_value arg (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
253 octave_value asin (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
254 octave_value asinh (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
255 octave_value atan (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
256 octave_value atanh (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
257 octave_value ceil (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
258 octave_value conj (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
259 octave_value cos (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
260 octave_value cosh (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
261 octave_value exp (void) const; |
|
7638
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7636
diff
changeset
|
262 octave_value expm1 (void) const; |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
263 octave_value fix (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
264 octave_value floor (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
265 octave_value imag (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
266 octave_value log (void) const; |
| 7740 | 267 octave_value log2 (void) const; |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
268 octave_value log10 (void) const; |
|
7638
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7636
diff
changeset
|
269 octave_value log1p (void) const; |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
270 octave_value real (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
271 octave_value round (void) const; |
|
7636
99c410f7f0b0
implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents:
7576
diff
changeset
|
272 octave_value roundb (void) const; |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
273 octave_value signum (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
274 octave_value sin (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
275 octave_value sinh (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
276 octave_value sqrt (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
277 octave_value tan (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
278 octave_value tanh (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
279 octave_value finite (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
280 octave_value isinf (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
281 octave_value isna (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
282 octave_value isnan (void) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
283 |
| 2376 | 284 private: |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
285 octave_value map (double (*fcn) (double)) const; |
| 2376 | 286 |
| 4612 | 287 DECLARE_OCTAVE_ALLOCATOR |
| 2477 | 288 |
| 4612 | 289 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
| 2376 | 290 }; |
| 291 | |
| 292 #endif | |
| 293 | |
| 294 /* | |
| 295 ;;; Local Variables: *** | |
| 296 ;;; mode: C++ *** | |
| 297 ;;; End: *** | |
| 298 */ |