|
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_complex_h) |
|
|
25 #define octave_complex_h 1 |
|
|
26 |
|
|
27 #include <cstdlib> |
|
|
28 |
|
3503
|
29 #include <iostream> |
|
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 |
|
|
37 #include "error.h" |
|
|
38 #include "ov-base.h" |
|
4749
|
39 #include "ov-cx-mat.h" |
|
3223
|
40 #include "ov-base-scalar.h" |
|
2376
|
41 #include "ov-typeinfo.h" |
|
|
42 |
|
|
43 class Octave_map; |
|
|
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 |
|
5759
|
76 octave_base_value *try_narrowing_conversion (void); |
|
2410
|
77 |
|
5885
|
78 octave_value do_index_op (const octave_value_list& idx, |
|
|
79 bool resize_ok = false); |
|
2376
|
80 |
|
5110
|
81 octave_value any (int = 0) const |
|
|
82 { |
|
|
83 return (scalar != Complex (0, 0) |
|
6269
|
84 && ! (lo_ieee_isnan (std::real (scalar)) |
|
|
85 || lo_ieee_isnan (std::imag (scalar)))); |
|
5110
|
86 } |
|
|
87 |
|
2376
|
88 bool is_complex_scalar (void) const { return true; } |
|
|
89 |
|
|
90 bool is_complex_type (void) const { return true; } |
|
|
91 |
|
5895
|
92 bool is_double_type (void) const { return true; } |
|
|
93 |
|
5775
|
94 // FIXME ??? |
|
2376
|
95 bool valid_as_scalar_index (void) const { return false; } |
|
|
96 bool valid_as_zero_index (void) const { return false; } |
|
|
97 |
|
|
98 double double_value (bool = false) const; |
|
|
99 |
|
3145
|
100 double scalar_value (bool frc_str_conv = false) const |
|
|
101 { return double_value (frc_str_conv); } |
|
2916
|
102 |
|
2376
|
103 Matrix matrix_value (bool = false) const; |
|
|
104 |
|
4569
|
105 NDArray array_value (bool = false) const; |
|
|
106 |
|
5989
|
107 SparseMatrix sparse_matrix_value (bool = false) const |
|
|
108 { return SparseMatrix (matrix_value ()); } |
|
|
109 |
|
|
110 SparseComplexMatrix sparse_complex_matrix_value (bool = false) const |
|
|
111 { return SparseComplexMatrix (complex_matrix_value ()); } |
|
|
112 |
|
5731
|
113 octave_value resize (const dim_vector& dv, bool fill = false) const; |
|
4915
|
114 |
|
2376
|
115 Complex complex_value (bool = false) const; |
|
|
116 |
|
|
117 ComplexMatrix complex_matrix_value (bool = false) const; |
|
|
118 |
|
4569
|
119 ComplexNDArray complex_array_value (bool = false) const; |
|
|
120 |
|
2376
|
121 void increment (void) { scalar += 1.0; } |
|
|
122 |
|
|
123 void decrement (void) { scalar -= 1.0; } |
|
|
124 |
|
6974
|
125 bool save_ascii (std::ostream& os); |
|
4687
|
126 |
|
|
127 bool load_ascii (std::istream& is); |
|
|
128 |
|
|
129 bool save_binary (std::ostream& os, bool& save_as_floats); |
|
|
130 |
|
|
131 bool load_binary (std::istream& is, bool swap, |
|
|
132 oct_mach_info::float_format fmt); |
|
|
133 |
|
|
134 #if defined (HAVE_HDF5) |
|
|
135 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); |
|
|
136 |
|
|
137 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); |
|
|
138 #endif |
|
|
139 |
|
4944
|
140 int write (octave_stream& os, int block_size, |
|
|
141 oct_data_conv::data_type output_type, int skip, |
|
|
142 oct_mach_info::float_format flt_fmt) const |
|
|
143 { |
|
|
144 // Yes, for compatibility, we drop the imaginary part here. |
|
|
145 return os.write (array_value (true), block_size, output_type, |
|
|
146 skip, flt_fmt); |
|
|
147 } |
|
|
148 |
|
5900
|
149 mxArray *as_mxArray (void) const; |
|
|
150 |
|
2376
|
151 private: |
|
|
152 |
|
4612
|
153 DECLARE_OCTAVE_ALLOCATOR |
|
2477
|
154 |
|
4612
|
155 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
|
2376
|
156 }; |
|
|
157 |
|
4953
|
158 typedef octave_complex octave_complex_scalar; |
|
|
159 |
|
2376
|
160 #endif |
|
|
161 |
|
|
162 /* |
|
|
163 ;;; Local Variables: *** |
|
|
164 ;;; mode: C++ *** |
|
|
165 ;;; End: *** |
|
|
166 */ |
