Mercurial > hg > octave-lyh
annotate src/ov-complex.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 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_complex_h) | |
| 25 #define octave_complex_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" |
| 2376 | 33 #include "mx-base.h" |
| 2477 | 34 #include "oct-alloc.h" |
| 2376 | 35 #include "str-vec.h" |
| 36 | |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
37 #include "gripes.h" |
| 2376 | 38 #include "error.h" |
| 39 #include "ov-base.h" | |
| 4749 | 40 #include "ov-cx-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 | |
| 2477 | 48 // Complex scalar values. |
| 2376 | 49 |
| 50 class | |
| 6693 | 51 OCTINTERP_API |
| 3223 | 52 octave_complex : public octave_base_scalar<Complex> |
| 2376 | 53 { |
| 54 public: | |
| 55 | |
| 56 octave_complex (void) | |
| 3223 | 57 : octave_base_scalar<Complex> () { } |
| 2376 | 58 |
| 59 octave_complex (const Complex& c) | |
| 3223 | 60 : octave_base_scalar<Complex> (c) { } |
| 2376 | 61 |
| 62 octave_complex (const octave_complex& c) | |
| 3223 | 63 : octave_base_scalar<Complex> (c) { } |
| 2376 | 64 |
| 65 ~octave_complex (void) { } | |
| 66 | |
| 5759 | 67 octave_base_value *clone (void) const { return new octave_complex (*this); } |
| 4749 | 68 |
| 69 // We return an octave_complex_matrix object here instead of an | |
| 70 // octave_complex object so that in expressions like A(2,2,2) = 2 | |
| 71 // (for A previously undefined), A will be empty instead of a 1x1 | |
| 72 // object. | |
| 5759 | 73 octave_base_value *empty_clone (void) const |
| 4749 | 74 { return new octave_complex_matrix (); } |
| 2376 | 75 |
|
8345
c777f3ce02d8
smarter conversion lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
76 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
|
77 |
| 5759 | 78 octave_base_value *try_narrowing_conversion (void); |
| 2410 | 79 |
| 5885 | 80 octave_value do_index_op (const octave_value_list& idx, |
| 10313 | 81 bool resize_ok = false); |
| 2376 | 82 |
| 5110 | 83 octave_value any (int = 0) const |
| 84 { | |
| 85 return (scalar != Complex (0, 0) | |
| 10313 | 86 && ! (lo_ieee_isnan (std::real (scalar)) |
| 87 || lo_ieee_isnan (std::imag (scalar)))); | |
| 5110 | 88 } |
| 89 | |
| 9685 | 90 builtin_type_t builtin_type (void) const { return btyp_complex; } |
| 91 | |
| 2376 | 92 bool is_complex_scalar (void) const { return true; } |
| 93 | |
| 94 bool is_complex_type (void) const { return true; } | |
| 95 | |
| 5895 | 96 bool is_double_type (void) const { return true; } |
| 97 | |
| 7576 | 98 bool is_float_type (void) const { return true; } |
| 99 | |
| 2376 | 100 double double_value (bool = false) const; |
| 101 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
102 float float_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
103 |
| 3145 | 104 double scalar_value (bool frc_str_conv = false) const |
| 105 { return double_value (frc_str_conv); } | |
| 2916 | 106 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
107 float float_scalar_value (bool frc_str_conv = false) const |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
108 { return float_value (frc_str_conv); } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
109 |
| 2376 | 110 Matrix matrix_value (bool = false) const; |
| 111 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
112 FloatMatrix float_matrix_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
113 |
| 4569 | 114 NDArray array_value (bool = false) const; |
| 115 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
116 FloatNDArray float_array_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
117 |
| 5989 | 118 SparseMatrix sparse_matrix_value (bool = false) const |
| 119 { return SparseMatrix (matrix_value ()); } | |
| 120 | |
| 121 SparseComplexMatrix sparse_complex_matrix_value (bool = false) const | |
| 122 { return SparseComplexMatrix (complex_matrix_value ()); } | |
| 123 | |
| 5731 | 124 octave_value resize (const dim_vector& dv, bool fill = false) const; |
| 4915 | 125 |
| 2376 | 126 Complex complex_value (bool = false) const; |
| 127 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
128 FloatComplex float_complex_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
129 |
| 2376 | 130 ComplexMatrix complex_matrix_value (bool = false) const; |
| 131 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
132 FloatComplexMatrix float_complex_matrix_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
133 |
| 4569 | 134 ComplexNDArray complex_array_value (bool = false) const; |
| 135 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
136 FloatComplexNDArray float_complex_array_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
137 |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
138 bool bool_value (bool warn = false) const |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
139 { |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
140 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
|
141 gripe_nan_to_logical_conversion (); |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
142 else if (warn && scalar != 0.0 && scalar != 1.0) |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
143 gripe_logical_conversion (); |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
144 |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
145 return scalar != 0.0; |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
146 } |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
147 |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
148 boolNDArray bool_array_value (bool warn = false) const |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
149 { |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
150 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
|
151 gripe_nan_to_logical_conversion (); |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
152 else if (warn && scalar != 0.0 && scalar != 1.0) |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
153 gripe_logical_conversion (); |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
154 |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
155 return boolNDArray (dim_vector (1, 1), scalar != 0.0); |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
156 } |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
157 |
| 2376 | 158 void increment (void) { scalar += 1.0; } |
| 159 | |
| 160 void decrement (void) { scalar -= 1.0; } | |
| 161 | |
| 6974 | 162 bool save_ascii (std::ostream& os); |
| 4687 | 163 |
| 164 bool load_ascii (std::istream& is); | |
| 165 | |
| 166 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 167 | |
| 168 bool load_binary (std::istream& is, bool swap, | |
| 10313 | 169 oct_mach_info::float_format fmt); |
| 4687 | 170 |
| 171 #if defined (HAVE_HDF5) | |
| 172 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 173 | |
|
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9853
diff
changeset
|
174 bool load_hdf5 (hid_t loc_id, const char *name); |
| 4687 | 175 #endif |
| 176 | |
| 4944 | 177 int write (octave_stream& os, int block_size, |
| 10313 | 178 oct_data_conv::data_type output_type, int skip, |
| 179 oct_mach_info::float_format flt_fmt) const | |
| 4944 | 180 { |
| 181 // Yes, for compatibility, we drop the imaginary part here. | |
| 182 return os.write (array_value (true), block_size, output_type, | |
| 10313 | 183 skip, flt_fmt); |
| 4944 | 184 } |
| 185 | |
| 5900 | 186 mxArray *as_mxArray (void) const; |
| 187 | |
|
9812
f80c566bc751
improve unary mapper system
Jaroslav Hajek <highegg@gmail.com>
parents:
9685
diff
changeset
|
188 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
|
189 |
| 2376 | 190 private: |
| 191 | |
| 4612 | 192 DECLARE_OCTAVE_ALLOCATOR |
| 2477 | 193 |
| 4612 | 194 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
| 2376 | 195 }; |
| 196 | |
| 4953 | 197 typedef octave_complex octave_complex_scalar; |
| 198 | |
| 2376 | 199 #endif |