field_bones.hpp
Go to the documentation of this file.
1 // Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
2 // Copyright (C) 2008-2011 Conrad Sanderson
3 // Copyright (C) 2009-2010 Ian Cullinan
4 //
5 // This file is part of the Armadillo C++ library.
6 // It is provided without any warranty of fitness
7 // for any purpose. You can redistribute this file
8 // and/or modify it under the terms of the GNU
9 // Lesser General Public License (LGPL) as published
10 // by the Free Software Foundation, either version 3
11 // of the License or (at your option) any later version.
12 // (see http://www.opensource.org/licenses for more info)
13 
14 
17 
18 
19 
20 struct field_prealloc_n_elem
21  {
22  static const uword val = 16;
23  };
24 
25 
26 
29 
30 template<typename oT>
31 class field
32  {
33  public:
34 
35  typedef oT object_type;
36 
37  const uword n_rows;
38  const uword n_cols;
39  const uword n_elem;
40 
41 
42  private:
43 
44  arma_aligned oT** mem;
45  arma_aligned oT* mem_local[ field_prealloc_n_elem::val ];
47 
48 
49  public:
50 
51  inline ~field();
52  inline field();
53 
54  inline field(const field& x);
55  inline const field& operator=(const field& x);
56 
57  inline field(const subview_field<oT>& x);
58  inline const field& operator=(const subview_field<oT>& x);
59 
60  inline explicit field(const uword n_elem_in);
61  inline field(const uword n_rows_in, const uword n_cols_in);
62 
63  inline void set_size(const uword n_obj_in);
64  inline void set_size(const uword n_rows_in, const uword n_cols_in);
65 
66  template<typename oT2>
67  inline void copy_size(const field<oT2>& x);
68 
69  arma_inline oT& operator[](const uword i);
70  arma_inline const oT& operator[](const uword i) const;
71 
72  arma_inline oT& at(const uword i);
73  arma_inline const oT& at(const uword i) const;
74 
75  arma_inline oT& operator()(const uword i);
76  arma_inline const oT& operator()(const uword i) const;
77 
78  arma_inline oT& at(const uword row, const uword col);
79  arma_inline const oT& at(const uword row, const uword col) const;
80 
81  arma_inline oT& operator()(const uword row, const uword col);
82  arma_inline const oT& operator()(const uword row, const uword col) const;
83 
84  inline field_injector<field> operator<<(const oT& val);
85  inline field_injector<field> operator<<(const injector_end_of_row& x);
86 
87 
88  inline subview_field<oT> row(const uword row_num);
89  inline const subview_field<oT> row(const uword row_num) const;
90 
91  inline subview_field<oT> col(const uword col_num);
92  inline const subview_field<oT> col(const uword col_num) const;
93 
94  inline subview_field<oT> rows(const uword in_row1, const uword in_row2);
95  inline const subview_field<oT> rows(const uword in_row1, const uword in_row2) const;
96 
97  inline subview_field<oT> cols(const uword in_col1, const uword in_col2);
98  inline const subview_field<oT> cols(const uword in_col1, const uword in_col2) const;
99 
100  inline subview_field<oT> subfield(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2);
101  inline const subview_field<oT> subfield(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const;
102 
103  inline subview_field<oT> subfield (const span& row_span, const span& col_span);
104  inline const subview_field<oT> subfield (const span& row_span, const span& col_span) const;
105 
106  inline subview_field<oT> operator()(const span& row_span, const span& col_span);
107  inline const subview_field<oT> operator()(const span& row_span, const span& col_span) const;
108 
109 
110  inline void print(const std::string extra_text = "") const;
111  inline void print(std::ostream& user_stream, const std::string extra_text = "") const;
112 
113  inline void fill(const oT& x);
114 
115  inline void reset();
116  inline void reset_objects();
117 
118  arma_inline bool is_empty() const;
119 
120  arma_inline arma_warn_unused bool in_range(const uword i) const;
121  arma_inline arma_warn_unused bool in_range(const span& x) const;
122 
123  arma_inline arma_warn_unused bool in_range(const uword in_row, const uword in_col ) const;
124  arma_inline arma_warn_unused bool in_range(const span& row_span, const uword in_col ) const;
125  arma_inline arma_warn_unused bool in_range(const uword in_row, const span& col_span) const;
126  arma_inline arma_warn_unused bool in_range(const span& row_span, const span& col_span) const;
127 
128  inline bool save(const std::string name, const file_type type = arma_binary, const bool print_status = true) const;
129  inline bool save( std::ostream& os, const file_type type = arma_binary, const bool print_status = true) const;
130 
131  inline bool load(const std::string name, const file_type type = auto_detect, const bool print_status = true);
132  inline bool load( std::istream& is, const file_type type = auto_detect, const bool print_status = true);
133 
134 
135  inline bool quiet_save(const std::string name, const file_type type = arma_binary) const;
136  inline bool quiet_save( std::ostream& os, const file_type type = arma_binary) const;
137 
138  inline bool quiet_load(const std::string name, const file_type type = auto_detect);
139  inline bool quiet_load( std::istream& is, const file_type type = auto_detect);
140 
141 
142  // iterators
143 
144  class iterator
145  {
146  public:
147 
148  inline iterator(field<oT>& in_M, const bool at_end = false);
149 
150  inline oT& operator* ();
151 
152  inline iterator& operator++();
153  inline void operator++(int);
154 
155  inline iterator& operator--();
156  inline void operator--(int);
157 
158  inline bool operator!=(const iterator& X) const;
159  inline bool operator==(const iterator& X) const;
160 
161  arma_aligned field<oT>& M;
162  arma_aligned uword i;
163  };
164 
165 
166  class const_iterator
167  {
168  public:
169 
170  const_iterator(const field<oT>& in_M, const bool at_end = false);
171  const_iterator(const iterator& X);
172 
173  inline const oT& operator*() const;
174 
175  inline const_iterator& operator++();
176  inline void operator++(int);
177 
178  inline const_iterator& operator--();
179  inline void operator--(int);
180 
181  inline bool operator!=(const const_iterator& X) const;
182  inline bool operator==(const const_iterator& X) const;
183 
184  arma_aligned const field<oT>& M;
185  arma_aligned uword i;
186  };
187 
188  inline iterator begin();
189  inline const_iterator begin() const;
190 
191  inline iterator end();
192  inline const_iterator end() const;
193 
194 
195  private:
196 
197  inline void init(const field<oT>& x);
198  inline void init(const uword n_rows_in, const uword n_cols_in);
199 
200  inline void delete_objects();
201  inline void create_objects();
202 
203  friend class field_aux;
204  friend class subview_field<oT>;
205 
206 
207  public:
208 
209  #ifdef ARMA_EXTRA_FIELD_PROTO
210  #include ARMA_INCFILE_WRAP(ARMA_EXTRA_FIELD_PROTO)
211  #endif
212  };
213 
214 
215 
216 class field_aux
217  {
218  public:
219 
220  template<typename oT> inline static void reset_objects(field< oT >& x);
221  template<typename eT> inline static void reset_objects(field< Mat<eT> >& x);
222  template<typename eT> inline static void reset_objects(field< Col<eT> >& x);
223  template<typename eT> inline static void reset_objects(field< Row<eT> >& x);
224  template<typename eT> inline static void reset_objects(field< Cube<eT> >& x);
225  inline static void reset_objects(field< std::string >& x);
226 
227 
228  template<typename oT> inline static bool save(const field< oT >& x, const std::string& name, const file_type type, std::string& err_msg);
229  template<typename oT> inline static bool save(const field< oT >& x, std::ostream& os, const file_type type, std::string& err_msg);
230  template<typename oT> inline static bool load( field< oT >& x, const std::string& name, const file_type type, std::string& err_msg);
231  template<typename oT> inline static bool load( field< oT >& x, std::istream& is, const file_type type, std::string& err_msg);
232 
233  template<typename eT> inline static bool save(const field< Mat<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
234  template<typename eT> inline static bool save(const field< Mat<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg);
235  template<typename eT> inline static bool load( field< Mat<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
236  template<typename eT> inline static bool load( field< Mat<eT> >& x, std::istream& is, const file_type type, std::string& err_msg);
237 
238  template<typename eT> inline static bool save(const field< Col<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
239  template<typename eT> inline static bool save(const field< Col<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg);
240  template<typename eT> inline static bool load( field< Col<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
241  template<typename eT> inline static bool load( field< Col<eT> >& x, std::istream& is, const file_type type, std::string& err_msg);
242 
243  template<typename eT> inline static bool save(const field< Row<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
244  template<typename eT> inline static bool save(const field< Row<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg);
245  template<typename eT> inline static bool load( field< Row<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
246  template<typename eT> inline static bool load( field< Row<eT> >& x, std::istream& is, const file_type type, std::string& err_msg);
247 
248  template<typename eT> inline static bool save(const field< Cube<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
249  template<typename eT> inline static bool save(const field< Cube<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg);
250  template<typename eT> inline static bool load( field< Cube<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
251  template<typename eT> inline static bool load( field< Cube<eT> >& x, std::istream& is, const file_type type, std::string& err_msg);
252 
253  inline static bool save(const field< std::string >& x, const std::string& name, const file_type type, std::string& err_msg);
254  inline static bool save(const field< std::string >& x, std::ostream& os, const file_type type, std::string& err_msg);
255  inline static bool load( field< std::string >& x, const std::string& name, const file_type type, std::string& err_msg);
256  inline static bool load( field< std::string >& x, std::istream& is, const file_type type, std::string& err_msg);
257 
258  };
259 
260 
operator==
const mtGlueCube< uword, T1, T2, glue_rel_eq > operator==(const BaseCube< typename T1::elem_type, T1 > &X, const BaseCube< typename T1::elem_type, T2 > &Y)
Definition: operator_cube_relational.hpp:84
subview_field
Definition: forward_bones.hpp:29
field::n_rows
const uword n_rows
number of rows in the field (read-only)
Definition: field_bones.hpp:37
field::n_cols
const uword n_cols
number of columns in the field (read-only)
Definition: field_bones.hpp:38
span
Definition: span.hpp:35
operator!=
const mtGlueCube< uword, T1, T2, glue_rel_noteq > operator!=(const BaseCube< typename T1::elem_type, T1 > &X, const BaseCube< typename T1::elem_type, T2 > &Y)
Definition: operator_cube_relational.hpp:97
field_prealloc_n_elem
Definition: field_bones.hpp:20
operator*
arma_inline const eOpCube< T1, eop_scalar_times > operator*(const BaseCube< typename T1::elem_type, T1 > &X, const typename T1::elem_type k)
BaseCube * scalar.
Definition: operator_cube_times.hpp:26
field::mem
arma_aligned oT ** mem
pointer to memory used by the object
Definition: field_bones.hpp:44
field::iterator::i
arma_aligned uword i
Definition: field_bones.hpp:162
uword
u32 uword
Definition: typedef.hpp:85
Col
Class for column vectors (matrices with only one column)
Definition: Col_bones.hpp:20
injector_end_of_row
Definition: forward_bones.hpp:118
file_type
file_type
Definition: forward_bones.hpp:132
Cube
Dense cube class.
Definition: Cube_bones.hpp:30
field::const_iterator
Definition: field_bones.hpp:166
arma_binary
Armadillo binary format, with information about matrix type and size.
Definition: forward_bones.hpp:140
field::iterator::M
arma_aligned field< oT > & M
Definition: field_bones.hpp:161
field::object_type
oT object_type
Definition: field_bones.hpp:35
Row
Class for row vectors (matrices with only one row)
Definition: forward_bones.hpp:21
arma_aligned
#define arma_aligned
Definition: compiler_setup.hpp:20
field::const_iterator::M
arma_aligned const field< oT > & M
Definition: field_bones.hpp:184
arma_warn_unused
#define arma_warn_unused
Definition: compiler_setup.hpp:21
field_aux
Definition: field_bones.hpp:216
field_prealloc_n_elem::val
static const uword val
Definition: field_bones.hpp:22
Mat
Dense matrix class.
Definition: forward_bones.hpp:19
arma_inline
#define arma_inline
Definition: compiler_setup.hpp:19
field_injector
Definition: injector_bones.hpp:87
arma_boost::operator<<
std::ostream & operator<<(std::ostream &o, const basic_format< T1, T2 > &X)
Definition: format_wrap.hpp:483
field::n_elem
const uword n_elem
number of elements in the field (read-only)
Definition: field_bones.hpp:39
field::const_iterator::i
arma_aligned uword i
Definition: field_bones.hpp:185
auto_detect
Automatically detect the file type (file must be one of the following types)
Definition: forward_bones.hpp:135

armadillo_matrix
Author(s):
autogenerated on Fri Apr 16 2021 02:31:57