GNU Octave  4.0.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-re-mat.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2015 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_re_mat_h)
25 #define octave_ov_flt_re_mat_h 1
26 
27 #include <cstdlib>
28 
29 #include <iosfwd>
30 #include <string>
31 
32 #include "mx-base.h"
33 #include "str-vec.h"
34 
35 #include "error.h"
36 #include "oct-stream.h"
37 #include "ov-base.h"
38 #include "ov-base-mat.h"
39 #include "ov-typeinfo.h"
40 
41 #include "MatrixType.h"
42 
43 class octave_value_list;
44 
45 class tree_walker;
46 
47 // Real matrix values.
48 
49 class
52 {
53 public:
54 
57 
60 
62  : octave_base_matrix<FloatNDArray> (m, t) { }
63 
65  : octave_base_matrix<FloatNDArray> (nda) { }
66 
69 
72 
75 
78 
81 
83 
84  octave_base_value *clone (void) const
85  { return new octave_float_matrix (*this); }
87  { return new octave_float_matrix (); }
88 
89  octave_base_value *try_narrowing_conversion (void);
90 
91  idx_vector index_vector (bool /* require_integers */ = false) const
92  {
93  return idx_cache ? *idx_cache : set_idx_cache (idx_vector (matrix));
94  }
95 
96  builtin_type_t builtin_type (void) const { return btyp_float; }
97 
98  bool is_real_matrix (void) const { return true; }
99 
100  bool is_real_type (void) const { return true; }
101 
102  bool is_single_type (void) const { return true; }
103 
104  bool is_float_type (void) const { return true; }
105 
107  int8_array_value (void) const { return int8NDArray (matrix); }
108 
110  int16_array_value (void) const { return int16NDArray (matrix); }
111 
113  int32_array_value (void) const { return int32NDArray (matrix); }
114 
116  int64_array_value (void) const { return int64NDArray (matrix); }
117 
119  uint8_array_value (void) const { return uint8NDArray (matrix); }
120 
122  uint16_array_value (void) const { return uint16NDArray (matrix); }
123 
125  uint32_array_value (void) const { return uint32NDArray (matrix); }
126 
128  uint64_array_value (void) const { return uint64NDArray (matrix); }
129 
130  double double_value (bool = false) const;
131 
132  float float_value (bool = false) const;
133 
134  double scalar_value (bool frc_str_conv = false) const
135  { return double_value (frc_str_conv); }
136 
137  float float_scalar_value (bool frc_str_conv = false) const
138  { return float_value (frc_str_conv); }
139 
140  Matrix matrix_value (bool = false) const;
141 
142  FloatMatrix float_matrix_value (bool = false) const;
143 
144  Complex complex_value (bool = false) const;
145 
146  FloatComplex float_complex_value (bool = false) const;
147 
148  ComplexMatrix complex_matrix_value (bool = false) const;
149 
150  FloatComplexMatrix float_complex_matrix_value (bool = false) const;
151 
152  ComplexNDArray complex_array_value (bool = false) const;
153 
154  FloatComplexNDArray float_complex_array_value (bool = false) const;
155 
156  boolNDArray bool_array_value (bool warn = false) const;
157 
158  charNDArray char_array_value (bool = false) const;
159 
160  NDArray array_value (bool = false) const;
161 
162  FloatNDArray float_array_value (bool = false) const { return matrix; }
163 
164  SparseMatrix sparse_matrix_value (bool = false) const;
165 
166  SparseComplexMatrix sparse_complex_matrix_value (bool = false) const;
167 
168  octave_value diag (octave_idx_type k = 0) const;
169 
170  octave_value diag (octave_idx_type m, octave_idx_type n) const;
171 
172  // Use matrix_ref here to clear index cache.
173  void increment (void) { matrix_ref () += 1.0; }
174 
175  void decrement (void) { matrix_ref () -= 1.0; }
176 
177  void changesign (void) { matrix_ref ().changesign (); }
178 
179  octave_value convert_to_str_internal (bool pad, bool force, char type) const;
180 
181  void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
182 
183  bool save_ascii (std::ostream& os);
184 
185  bool load_ascii (std::istream& is);
186 
187  bool save_binary (std::ostream& os, bool& save_as_floats);
188 
189  bool load_binary (std::istream& is, bool swap,
191 
192  bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
193 
194  bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
195 
196  int write (octave_stream& os, int block_size,
197  oct_data_conv::data_type output_type, int skip,
198  oct_mach_info::float_format flt_fmt) const
199  { return os.write (matrix, block_size, output_type, skip, flt_fmt); }
200 
201  // Unsafe. This function exists to support the MEX interface.
202  // You should not use it anywhere else.
203  void *mex_get_data (void) const { return matrix.mex_get_data (); }
204 
205  mxArray *as_mxArray (void) const;
206 
207  octave_value map (unary_mapper_t umap) const;
208 
209 private:
210 
212 };
213 
214 #endif
int write(octave_stream &os, int block_size, oct_data_conv::data_type output_type, int skip, oct_mach_info::float_format flt_fmt) const
intNDArray< octave_int64 > int64NDArray
Definition: int64NDArray.h:31
octave_float_matrix(const FloatMatrix &m)
Definition: ov-flt-re-mat.h:58
intNDArray< octave_uint32 > uint32NDArray
Definition: uint32NDArray.h:31
intNDArray< octave_uint8 > uint8NDArray
Definition: uint8NDArray.h:31
intNDArray< octave_uint16 > uint16NDArray
Definition: uint16NDArray.h:31
int8NDArray int8_array_value(void) const
octave_base_value * clone(void) const
Definition: ov-flt-re-mat.h:84
octave_float_matrix(const FloatNDArray &nda)
Definition: ov-flt-re-mat.h:64
int16NDArray int16_array_value(void) const
intNDArray< octave_int16 > int16NDArray
Definition: int16NDArray.h:31
builtin_type_t
Definition: ov-base.h:59
F77_RET_T const double const double double * d
uint8NDArray uint8_array_value(void) const
bool is_single_type(void) const
octave_base_value * empty_clone(void) const
Definition: ov-flt-re-mat.h:86
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
Definition: ov-base.h:142
octave_float_matrix(const FloatRowVector &v)
Definition: ov-flt-re-mat.h:73
#define OCTINTERP_API
Definition: mexproto.h:66
octave_float_matrix(const octave_float_matrix &m)
Definition: ov-flt-re-mat.h:79
intNDArray< octave_int8 > int8NDArray
Definition: int8NDArray.h:31
uint16NDArray uint16_array_value(void) const
idx_vector index_vector(bool=false) const
Definition: ov-flt-re-mat.h:91
void * mex_get_data(void) const
uint64NDArray uint64_array_value(void) const
bool is_real_matrix(void) const
Definition: ov-flt-re-mat.h:98
octave_float_matrix(const FloatDiagMatrix &d)
Definition: ov-flt-re-mat.h:70
uint32NDArray uint32_array_value(void) const
FloatNDArray float_array_value(bool=false) const
Definition: dMatrix.h:35
int64NDArray int64_array_value(void) const
octave_float_matrix(const FloatColumnVector &v)
Definition: ov-flt-re-mat.h:76
intNDArray< octave_int32 > int32NDArray
Definition: int32NDArray.h:31
builtin_type_t builtin_type(void) const
Definition: ov-flt-re-mat.h:96
double scalar_value(bool frc_str_conv=false) const
octave_idx_type write(const octave_value &data, octave_idx_type block_size, oct_data_conv::data_type output_type, octave_idx_type skip, oct_mach_info::float_format flt_fmt)
Definition: oct-stream.cc:3546
int32NDArray int32_array_value(void) const
octave_float_matrix(const FloatMatrix &m, const MatrixType &t)
Definition: ov-flt-re-mat.h:61
std::complex< float > FloatComplex
Definition: oct-cmplx.h:30
bool is_real_type(void) const
std::complex< double > Complex
Definition: oct-cmplx.h:29
octave_float_matrix(const Array< float > &m)
Definition: ov-flt-re-mat.h:67
float float_scalar_value(bool frc_str_conv=false) const
bool is_float_type(void) const
intNDArray< octave_uint64 > uint64NDArray
Definition: uint64NDArray.h:31