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-re-sparse.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 2004-2015 David Bateman
4 Copyright (C) 1998-2004 Andy Adler
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_re_sparse_h)
25 #define octave_ov_re_sparse_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-typeinfo.h"
39 
40 #include "dSparse.h"
41 #include "MatrixType.h"
42 #include "ov-base-sparse.h"
43 #include "ov-cx-sparse.h"
44 
45 class octave_value_list;
46 
47 class tree_walker;
48 
49 class
52 {
53 public:
54 
57 
60 
63 
66 
68  : octave_base_sparse<SparseMatrix> (m, t) { }
69 
72 
74  : octave_base_sparse<SparseMatrix> (m, t) { }
75 
78 
81 
84 
86 
87  octave_base_value *clone (void) const
88  { return new octave_sparse_matrix (*this); }
90  { return new octave_sparse_matrix (); }
91 
92  octave_base_value *try_narrowing_conversion (void);
93 
94  idx_vector index_vector (bool require_integers = false) const;
95 
96  builtin_type_t builtin_type (void) const { return btyp_double; }
97 
98  bool is_real_matrix (void) const { return true; }
99 
100  bool is_real_type (void) const { return true; }
101 
102  bool is_double_type (void) const { return true; }
103 
104  bool is_float_type (void) const { return true; }
105 
106  double double_value (bool = false) const;
107 
108  double scalar_value (bool frc_str_conv = false) const
109  { return double_value (frc_str_conv); }
110 
111  Matrix matrix_value (bool = false) const;
112 
113  Complex complex_value (bool = false) const;
114 
115  boolNDArray bool_array_value (bool warn = false) const;
116 
117  charNDArray char_array_value (bool = false) const;
118 
119  ComplexMatrix complex_matrix_value (bool = false) const;
120 
121  ComplexNDArray complex_array_value (bool = false) const;
122 
123  NDArray array_value (bool = false) const;
124 
125  SparseMatrix sparse_matrix_value (bool = false) const
126  { return matrix; }
127 
129  { return SparseComplexMatrix (matrix); }
130 
131  SparseBoolMatrix sparse_bool_matrix_value (bool warn = false) const;
132 
133  octave_value convert_to_str_internal (bool pad, bool force, char type) const;
134 
135 #if 0
136  int write (octave_stream& os, int block_size,
137  oct_data_conv::data_type output_type, int skip,
138  oct_mach_info::float_format flt_fmt) const
139  { return os.write (matrix, block_size, output_type, skip, flt_fmt); }
140 #endif
141 
142  bool save_binary (std::ostream& os, bool& save_as_floats);
143 
144  bool load_binary (std::istream& is, bool swap,
146 
147  bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
148 
149  bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
150 
151  mxArray *as_mxArray (void) const;
152 
153  octave_value map (unary_mapper_t umap) const;
154 
155 private:
156  octave_value map (double (*fcn) (double)) const;
157 
158 
160 };
161 
162 #endif
SparseComplexMatrix sparse_complex_matrix_value(bool=false) const
Definition: ov-re-sparse.h:128
octave_sparse_matrix(const MSparse< double > &m, const MatrixType &t)
Definition: ov-re-sparse.h:73
octave_sparse_matrix(const Sparse< double > &m)
Definition: ov-re-sparse.h:76
SparseMatrix sparse_matrix_value(bool=false) const
Definition: ov-re-sparse.h:125
octave_sparse_matrix(const MSparse< double > &m)
Definition: ov-re-sparse.h:70
octave_base_value * empty_clone(void) const
Definition: ov-re-sparse.h:89
builtin_type_t builtin_type(void) const
Definition: ov-re-sparse.h:96
octave_sparse_matrix(const SparseMatrix &m)
Definition: ov-re-sparse.h:64
builtin_type_t
Definition: ov-base.h:59
bool is_real_type(void) const
Definition: ov-re-sparse.h:100
octave_sparse_matrix(const Sparse< double > &m, const MatrixType &t)
Definition: ov-re-sparse.h:79
bool is_float_type(void) const
Definition: ov-re-sparse.h:104
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
Definition: ov-base.h:142
#define OCTINTERP_API
Definition: mexproto.h:66
Definition: dMatrix.h:35
octave_sparse_matrix(const Matrix &m)
Definition: ov-re-sparse.h:58
octave_sparse_matrix(const NDArray &m)
Definition: ov-re-sparse.h:61
bool is_real_matrix(void) const
Definition: ov-re-sparse.h:98
double scalar_value(bool frc_str_conv=false) const
Definition: ov-re-sparse.h:108
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
octave_base_value * clone(void) const
Definition: ov-re-sparse.h:87
octave_sparse_matrix(const octave_sparse_matrix &m)
Definition: ov-re-sparse.h:82
octave_sparse_matrix(const SparseMatrix &m, const MatrixType &t)
Definition: ov-re-sparse.h:67
bool is_double_type(void) const
Definition: ov-re-sparse.h:102
std::complex< double > Complex
Definition: oct-cmplx.h:29