Mercurial > hg > octave-nkf
annotate libinterp/octave-value/ov-complex.h @ 20071:17d647821d61
maint: More cleanup of C++ code to follow Octave coding conventions.
* gl-select.cc, betainc.cc, bitfcns.cc, bsxfun.cc, gl-render.cc,
graphics.cc, load-save.cc, ls-mat-ascii.cc, ls-mat5.cc, lu.cc,
oct-stream.cc, symtab.cc, variables.cc, __eigs__.cc,
__magick_read__.cc, chol.cc, ov-base-sparse.cc, ov-class.cc,
ov-classdef.cc, ov-fcn-inline.cc, ov-perm.cc, ov.cc, CMatrix.cc,
CSparse.cc, MSparse.cc, MatrixType.cc, MatrixType.h, dMatrix.cc,
dSparse.cc, fCMatrix.cc, fMatrix.cc, eigs-base.cc, lo-sysdep.cc,
kpse.cc: Break long lines before && and ||.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Thu, 26 Feb 2015 13:07:04 -0500 |
| parents | 09ed6f7538dd |
| children | dd6345fd8a97 |
| rev | line source |
|---|---|
| 2376 | 1 /* |
| 2 | |
|
19898
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19795
diff
changeset
|
3 Copyright (C) 1996-2015 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_complex_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_complex_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" |
| 2376 | 32 #include "mx-base.h" |
| 33 #include "str-vec.h" | |
| 34 | |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
35 #include "gripes.h" |
| 2376 | 36 #include "error.h" |
| 37 #include "ov-base.h" | |
| 4749 | 38 #include "ov-cx-mat.h" |
| 3223 | 39 #include "ov-base-scalar.h" |
| 2376 | 40 #include "ov-typeinfo.h" |
| 41 | |
| 42 class octave_value_list; | |
| 43 | |
| 44 class tree_walker; | |
| 45 | |
| 2477 | 46 // Complex scalar values. |
| 2376 | 47 |
| 48 class | |
| 6693 | 49 OCTINTERP_API |
| 3223 | 50 octave_complex : public octave_base_scalar<Complex> |
| 2376 | 51 { |
| 52 public: | |
| 53 | |
| 54 octave_complex (void) | |
| 3223 | 55 : octave_base_scalar<Complex> () { } |
| 2376 | 56 |
| 57 octave_complex (const Complex& c) | |
| 3223 | 58 : octave_base_scalar<Complex> (c) { } |
| 2376 | 59 |
| 60 octave_complex (const octave_complex& c) | |
| 3223 | 61 : octave_base_scalar<Complex> (c) { } |
| 2376 | 62 |
| 63 ~octave_complex (void) { } | |
| 64 | |
| 5759 | 65 octave_base_value *clone (void) const { return new octave_complex (*this); } |
| 4749 | 66 |
| 67 // We return an octave_complex_matrix object here instead of an | |
| 68 // octave_complex object so that in expressions like A(2,2,2) = 2 | |
| 69 // (for A previously undefined), A will be empty instead of a 1x1 | |
| 70 // object. | |
| 5759 | 71 octave_base_value *empty_clone (void) const |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
72 { return new octave_complex_matrix (); } |
| 2376 | 73 |
|
8345
c777f3ce02d8
smarter conversion lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
74 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
|
75 |
| 5759 | 76 octave_base_value *try_narrowing_conversion (void); |
| 2410 | 77 |
| 5885 | 78 octave_value do_index_op (const octave_value_list& idx, |
| 10313 | 79 bool resize_ok = false); |
| 2376 | 80 |
|
14127
b5e819930fd5
Give friendlier error message when indexing with default i or j (bug #35157)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11586
diff
changeset
|
81 // Use this to give a more specific error message |
|
18129
e473c4853afc
enable non-integer ranges as indices by default and deprecate preference
John W. Eaton <jwe@octave.org>
parents:
17822
diff
changeset
|
82 idx_vector index_vector (bool /* require_integers */ = false) const |
|
14127
b5e819930fd5
Give friendlier error message when indexing with default i or j (bug #35157)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11586
diff
changeset
|
83 { |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
84 error ("attempted to use a complex scalar as an index\n" |
|
14127
b5e819930fd5
Give friendlier error message when indexing with default i or j (bug #35157)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11586
diff
changeset
|
85 " (forgot to initialize i or j?)"); |
|
b5e819930fd5
Give friendlier error message when indexing with default i or j (bug #35157)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11586
diff
changeset
|
86 return idx_vector (); |
|
b5e819930fd5
Give friendlier error message when indexing with default i or j (bug #35157)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11586
diff
changeset
|
87 } |
|
b5e819930fd5
Give friendlier error message when indexing with default i or j (bug #35157)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11586
diff
changeset
|
88 |
| 5110 | 89 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
|
90 { |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
91 return (scalar != Complex (0, 0) |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
92 && ! (lo_ieee_isnan (std::real (scalar)) |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
93 || lo_ieee_isnan (std::imag (scalar)))); |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
94 } |
| 5110 | 95 |
| 9685 | 96 builtin_type_t builtin_type (void) const { return btyp_complex; } |
| 97 | |
| 2376 | 98 bool is_complex_scalar (void) const { return true; } |
| 99 | |
| 100 bool is_complex_type (void) const { return true; } | |
| 101 | |
| 5895 | 102 bool is_double_type (void) const { return true; } |
| 103 | |
| 7576 | 104 bool is_float_type (void) const { return true; } |
| 105 | |
| 2376 | 106 double double_value (bool = false) const; |
| 107 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
108 float float_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
109 |
| 3145 | 110 double scalar_value (bool frc_str_conv = false) const |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
111 { return double_value (frc_str_conv); } |
| 2916 | 112 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
113 float float_scalar_value (bool frc_str_conv = false) const |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
114 { return float_value (frc_str_conv); } |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
115 |
| 2376 | 116 Matrix matrix_value (bool = false) const; |
| 117 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
118 FloatMatrix float_matrix_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
119 |
| 4569 | 120 NDArray array_value (bool = false) const; |
| 121 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
122 FloatNDArray float_array_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
123 |
| 5989 | 124 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
|
125 { return SparseMatrix (matrix_value ()); } |
| 5989 | 126 |
| 127 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
|
128 { return SparseComplexMatrix (complex_matrix_value ()); } |
| 5989 | 129 |
| 5731 | 130 octave_value resize (const dim_vector& dv, bool fill = false) const; |
| 4915 | 131 |
| 2376 | 132 Complex complex_value (bool = false) const; |
| 133 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
134 FloatComplex float_complex_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
135 |
| 2376 | 136 ComplexMatrix complex_matrix_value (bool = false) const; |
| 137 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
138 FloatComplexMatrix float_complex_matrix_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
139 |
| 4569 | 140 ComplexNDArray complex_array_value (bool = false) const; |
| 141 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
142 FloatComplexNDArray float_complex_array_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
143 |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
144 bool bool_value (bool warn = false) const |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
145 { |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
146 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
|
147 gripe_nan_to_logical_conversion (); |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
148 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
|
149 gripe_logical_conversion (); |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
150 |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
151 return scalar != 0.0; |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
152 } |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
153 |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
154 boolNDArray bool_array_value (bool warn = false) const |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
155 { |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
156 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
|
157 gripe_nan_to_logical_conversion (); |
|
9853
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
158 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
|
159 gripe_logical_conversion (); |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
160 |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
161 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
|
162 } |
|
8d9e4752441a
implement complex built-in logical conversions
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
163 |
|
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
|
164 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
|
165 |
| 2376 | 166 void increment (void) { scalar += 1.0; } |
| 167 | |
| 168 void decrement (void) { scalar -= 1.0; } | |
| 169 | |
| 6974 | 170 bool save_ascii (std::ostream& os); |
| 4687 | 171 |
| 172 bool load_ascii (std::istream& is); | |
| 173 | |
| 174 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 175 | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
176 bool load_binary (std::istream& is, bool swap, |
| 10313 | 177 oct_mach_info::float_format fmt); |
| 4687 | 178 |
|
20070
09ed6f7538dd
avoid needing to include hdf5 in public header files (bug #44370, #43180)
John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org>
parents:
19898
diff
changeset
|
179 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); |
| 4687 | 180 |
|
20070
09ed6f7538dd
avoid needing to include hdf5 in public header files (bug #44370, #43180)
John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org>
parents:
19898
diff
changeset
|
181 bool load_hdf5 (octave_hdf5_id loc_id, const char *name); |
| 4687 | 182 |
| 4944 | 183 int write (octave_stream& os, int block_size, |
| 10313 | 184 oct_data_conv::data_type output_type, int skip, |
| 185 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
|
186 { |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
187 // Yes, for compatibility, we drop the imaginary part here. |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
188 return os.write (array_value (true), block_size, output_type, |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
189 skip, flt_fmt); |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
190 } |
| 4944 | 191 |
| 5900 | 192 mxArray *as_mxArray (void) const; |
| 193 | |
|
9812
f80c566bc751
improve unary mapper system
Jaroslav Hajek <highegg@gmail.com>
parents:
9685
diff
changeset
|
194 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
|
195 |
| 2376 | 196 private: |
| 197 | |
| 2477 | 198 |
| 4612 | 199 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
| 2376 | 200 }; |
| 201 | |
| 4953 | 202 typedef octave_complex octave_complex_scalar; |
| 203 | |
| 2376 | 204 #endif |