GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ov-flt-cx-mat.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2013 John W. Eaton
4 Copyright (C) 2009-2010 VZLU Prague
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
10 Free Software Foundation; either version 3 of the License, or (at your
11 option) any later version.
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
19 along with Octave; see the file COPYING. If not, see
20 <http://www.gnu.org/licenses/>.
21 
22 */
23 
24 #if !defined (octave_ov_flt_cx_mat_h)
25 #define octave_ov_flt_cx_mat_h 1
26 
27 #include <cstdlib>
28 
29 #include <iosfwd>
30 #include <string>
31 
32 #include "mx-base.h"
33 #include "oct-alloc.h"
34 #include "str-vec.h"
35 
36 #include "error.h"
37 #include "oct-stream.h"
38 #include "ov-base.h"
39 #include "ov-base-mat.h"
40 #include "ov-typeinfo.h"
41 
42 #include "MatrixType.h"
43 
44 class octave_value_list;
45 
46 class tree_walker;
47 
48 // Complex matrix values.
49 
50 class
53 {
54 public:
55 
58 
61 
64 
67 
70 
73 
76 
79 
82 
84 
85  octave_base_value *clone (void) const
86  { return new octave_float_complex_matrix (*this); }
87  octave_base_value *empty_clone (void) const
88  { return new octave_float_complex_matrix (); }
89 
90  octave_base_value *try_narrowing_conversion (void);
91 
93 
94  bool is_complex_matrix (void) const { return true; }
95 
96  bool is_complex_type (void) const { return true; }
97 
98  bool is_single_type (void) const { return true; }
99 
100  bool is_float_type (void) const { return true; }
101 
102  double double_value (bool = false) const;
103 
104  float float_value (bool = false) const;
105 
106  double scalar_value (bool frc_str_conv = false) const
107  { return double_value (frc_str_conv); }
108 
109  float float_scalar_value (bool frc_str_conv = false) const
110  { return float_value (frc_str_conv); }
111 
112  Matrix matrix_value (bool = false) const;
113 
114  FloatMatrix float_matrix_value (bool = false) const;
115 
116  Complex complex_value (bool = false) const;
117 
118  FloatComplex float_complex_value (bool = false) const;
119 
120  ComplexMatrix complex_matrix_value (bool = false) const;
121 
122  FloatComplexMatrix float_complex_matrix_value (bool = false) const;
123 
124  ComplexNDArray complex_array_value (bool = false) const { return matrix; }
125 
126  FloatComplexNDArray float_complex_array_value (bool = false) const;
127 
128  boolNDArray bool_array_value (bool warn = false) const;
129 
130  charNDArray char_array_value (bool frc_str_conv = false) const;
131 
132  SparseMatrix sparse_matrix_value (bool = false) const;
133 
134  SparseComplexMatrix sparse_complex_matrix_value (bool = false) const;
135 
136  octave_value diag (octave_idx_type k = 0) const;
137 
138  octave_value diag (octave_idx_type m, octave_idx_type n) const;
139 
140  void increment (void) { matrix += FloatComplex (1.0); }
141 
142  void decrement (void) { matrix -= FloatComplex (1.0); }
143 
144  void changesign (void) { matrix.changesign (); }
145 
146  bool save_ascii (std::ostream& os);
147 
148  bool load_ascii (std::istream& is);
149 
150  bool save_binary (std::ostream& os, bool& save_as_floats);
151 
152  bool load_binary (std::istream& is, bool swap,
154 
155 #if defined (HAVE_HDF5)
156  bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats);
157 
158  bool load_hdf5 (hid_t loc_id, const char *name);
159 #endif
160 
161  int write (octave_stream& os, int block_size,
162  oct_data_conv::data_type output_type, int skip,
163  oct_mach_info::float_format flt_fmt) const
164  {
165  // Yes, for compatibility, we drop the imaginary part here.
166  return os.write (matrix_value (true), block_size, output_type,
167  skip, flt_fmt);
168  }
169 
170  void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
171 
172  mxArray *as_mxArray (void) const;
173 
174  octave_value map (unary_mapper_t umap) const;
175 
176 private:
177 
179 
181 };
182 
183 #endif