Mercurial > hg > octave-nkf
annotate src/ov-complex.h @ 9685:e793865ede63
implement builtin_type
author | Jaroslav Hajek <highegg@gmail.com> |
---|---|
date | Fri, 02 Oct 2009 08:27:44 +0200 |
parents | d865363208d6 |
children | f80c566bc751 |
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 | |
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 |
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, |
81 bool resize_ok = false); | |
2376 | 82 |
5110 | 83 octave_value any (int = 0) const |
84 { | |
85 return (scalar != Complex (0, 0) | |
6269 | 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 |
2376 | 138 void increment (void) { scalar += 1.0; } |
139 | |
140 void decrement (void) { scalar -= 1.0; } | |
141 | |
6974 | 142 bool save_ascii (std::ostream& os); |
4687 | 143 |
144 bool load_ascii (std::istream& is); | |
145 | |
146 bool save_binary (std::ostream& os, bool& save_as_floats); | |
147 | |
148 bool load_binary (std::istream& is, bool swap, | |
149 oct_mach_info::float_format fmt); | |
150 | |
151 #if defined (HAVE_HDF5) | |
152 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
153 | |
154 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); | |
155 #endif | |
156 | |
4944 | 157 int write (octave_stream& os, int block_size, |
158 oct_data_conv::data_type output_type, int skip, | |
159 oct_mach_info::float_format flt_fmt) const | |
160 { | |
161 // Yes, for compatibility, we drop the imaginary part here. | |
162 return os.write (array_value (true), block_size, output_type, | |
163 skip, flt_fmt); | |
164 } | |
165 | |
5900 | 166 mxArray *as_mxArray (void) const; |
167 | |
7667
fb3a6c53c2b2
Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
168 octave_value erf (void) const; |
fb3a6c53c2b2
Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
169 octave_value erfc (void) const; |
fb3a6c53c2b2
Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
170 octave_value gamma (void) const; |
fb3a6c53c2b2
Allow negative zero imaginary part to be treated as zero for erf, erfc, gamma and lgamma mapper function
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
171 octave_value lgamma (void) const; |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
172 octave_value abs (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
173 octave_value acos (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
174 octave_value acosh (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
175 octave_value angle (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
176 octave_value arg (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
177 octave_value asin (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
178 octave_value asinh (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
179 octave_value atan (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
180 octave_value atanh (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
181 octave_value ceil (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
182 octave_value conj (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
183 octave_value cos (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
184 octave_value cosh (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
185 octave_value exp (void) const; |
7638
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7636
diff
changeset
|
186 octave_value expm1 (void) const; |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
187 octave_value fix (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
188 octave_value floor (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
189 octave_value imag (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
190 octave_value log (void) const; |
7740 | 191 octave_value log2 (void) const; |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
192 octave_value log10 (void) const; |
7638
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7636
diff
changeset
|
193 octave_value log1p (void) const; |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
194 octave_value real (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
195 octave_value round (void) const; |
7636
99c410f7f0b0
implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents:
7576
diff
changeset
|
196 octave_value roundb (void) const; |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
197 octave_value signum (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
198 octave_value sin (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
199 octave_value sinh (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
200 octave_value sqrt (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
201 octave_value tan (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
202 octave_value tanh (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
203 octave_value finite (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
204 octave_value isinf (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
205 octave_value isna (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
206 octave_value isnan (void) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
207 |
2376 | 208 private: |
209 | |
4612 | 210 DECLARE_OCTAVE_ALLOCATOR |
2477 | 211 |
4612 | 212 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
2376 | 213 }; |
214 | |
4953 | 215 typedef octave_complex octave_complex_scalar; |
216 | |
2376 | 217 #endif |
218 | |
219 /* | |
220 ;;; Local Variables: *** | |
221 ;;; mode: C++ *** | |
222 ;;; End: *** | |
223 */ |