Classes | Functions
Field

Classes

class  field< oT >
 
class  field_aux
 
struct  field_prealloc_n_elem
 

Functions

arma_inline oT & field< oT >::at (const uword i)
 linear element accessor (treats the field as a vector); no bounds check More...
 
arma_inline const oT & field< oT >::at (const uword i) const
 linear element accessor (treats the field as a vector); no bounds check More...
 
arma_inline oT & field< oT >::at (const uword row, const uword col)
 element accessor; no bounds check More...
 
arma_inline const oT & field< oT >::at (const uword row, const uword col) const
 element accessor; no bounds check More...
 
iterator field< oT >::begin ()
 
const_iterator field< oT >::begin () const
 
subview_field< oT > field< oT >::col (const uword col_num)
 creation of subview_field (column of a field) More...
 
const subview_field< oT > field< oT >::col (const uword col_num) const
 creation of subview_field (column of a field) More...
 
subview_field< oT > field< oT >::cols (const uword in_col1, const uword in_col2)
 creation of subview_field (subfield comprised of specified columns) More...
 
const subview_field< oT > field< oT >::cols (const uword in_col1, const uword in_col2) const
 creation of subview_field (subfield comprised of specified columns) More...
 
 field< oT >::const_iterator::const_iterator (const field< oT > &in_M, const bool at_end=false)
 
template<typename oT2 >
void field< oT >::copy_size (const field< oT2 > &x)
 change the field to have the specified dimensions (data is not preserved) More...
 
void field< oT >::create_objects ()
 
void field< oT >::delete_objects ()
 
iterator field< oT >::end ()
 
const_iterator field< oT >::end () const
 
 field< oT >::field ()
 
 field< oT >::field (const field &x)
 construct a field from a given field More...
 
 field< oT >::field (const subview_field< oT > &x)
 construct a field from subview_field (e.g. construct a field from a delayed subfield operation) More...
 
 field< oT >::field (const uword n_elem_in)
 
 field< oT >::field (const uword n_rows_in, const uword n_cols_in)
 construct the field with the specified dimensions More...
 
void field< oT >::fill (const oT &x)
 fill the field with an object More...
 
arma_inline arma_warn_unused bool field< oT >::in_range (const uword i) const
 returns true if the given index is currently in range More...
 
arma_inline arma_warn_unused bool field< oT >::in_range (const span &x) const
 returns true if the given start and end indices are currently in range More...
 
arma_inline arma_warn_unused bool field< oT >::in_range (const uword in_row, const uword in_col) const
 returns true if the given location is currently in range More...
 
arma_inline arma_warn_unused bool field< oT >::in_range (const span &row_span, const uword in_col) const
 
arma_inline arma_warn_unused bool field< oT >::in_range (const uword in_row, const span &col_span) const
 
arma_inline arma_warn_unused bool field< oT >::in_range (const span &row_span, const span &col_span) const
 
void field< oT >::init (const field< oT > &x)
 construct a field from a given field More...
 
void field< oT >::init (const uword n_rows_in, const uword n_cols_in)
 internal field construction; if the requested size is small enough, memory from the stack is used. otherwise memory is allocated via 'new' More...
 
arma_inline bool field< oT >::is_empty () const
 returns true if the field has no objects More...
 
 field< oT >::iterator::iterator (field< oT > &in_M, const bool at_end=false)
 
bool field< oT >::load (const std::string name, const file_type type=auto_detect, const bool print_status=true)
 
bool field< oT >::load (std::istream &is, const file_type type=auto_detect, const bool print_status=true)
 
template<typename oT >
static bool field_aux::load (field< oT > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename oT >
static bool field_aux::load (field< oT > &x, std::istream &is, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Mat< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Mat< eT > > &x, std::istream &is, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Col< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Col< eT > > &x, std::istream &is, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Row< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Row< eT > > &x, std::istream &is, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Cube< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::load (field< Cube< eT > > &x, std::istream &is, const file_type type, std::string &err_msg)
 
static bool field_aux::load (field< std::string > &x, const std::string &name, const file_type type, std::string &err_msg)
 
static bool field_aux::load (field< std::string > &x, std::istream &is, const file_type type, std::string &err_msg)
 
bool field< oT >::iterator::operator!= (const iterator &X) const
 
bool field< oT >::const_iterator::operator!= (const const_iterator &X) const
 
arma_inline oT & field< oT >::operator() (const uword i)
 linear element accessor (treats the field as a vector); bounds checking not done when ARMA_NO_DEBUG is defined More...
 
arma_inline const oT & field< oT >::operator() (const uword i) const
 linear element accessor (treats the field as a vector); bounds checking not done when ARMA_NO_DEBUG is defined More...
 
arma_inline oT & field< oT >::operator() (const uword row, const uword col)
 element accessor; bounds checking not done when ARMA_NO_DEBUG is defined More...
 
arma_inline const oT & field< oT >::operator() (const uword row, const uword col) const
 element accessor; bounds checking not done when ARMA_NO_DEBUG is defined More...
 
subview_field< oT > field< oT >::operator() (const span &row_span, const span &col_span)
 
const subview_field< oT > field< oT >::operator() (const span &row_span, const span &col_span) const
 
oT & field< oT >::iterator::operator* ()
 
const oT & field< oT >::const_iterator::operator* () const
 
iterator & field< oT >::iterator::operator++ ()
 
void field< oT >::iterator::operator++ (int)
 
const_iterator & field< oT >::const_iterator::operator++ ()
 
void field< oT >::const_iterator::operator++ (int)
 
iterator & field< oT >::iterator::operator-- ()
 
void field< oT >::iterator::operator-- (int)
 
const_iterator & field< oT >::const_iterator::operator-- ()
 
void field< oT >::const_iterator::operator-- (int)
 
field_injector< field > field< oT >::operator<< (const oT &val)
 
field_injector< field > field< oT >::operator<< (const injector_end_of_row &x)
 
const field & field< oT >::operator= (const field &x)
 construct a field from a given field More...
 
const field & field< oT >::operator= (const subview_field< oT > &x)
 construct a field from subview_field (e.g. construct a field from a delayed subfield operation) More...
 
bool field< oT >::iterator::operator== (const iterator &X) const
 
bool field< oT >::const_iterator::operator== (const const_iterator &X) const
 
arma_inline oT & field< oT >::operator[] (const uword i)
 linear element accessor (treats the field as a vector); no bounds check More...
 
arma_inline const oT & field< oT >::operator[] (const uword i) const
 linear element accessor (treats the field as a vector); no bounds check More...
 
void field< oT >::print (const std::string extra_text="") const
 
void field< oT >::print (std::ostream &user_stream, const std::string extra_text="") const
 
bool field< oT >::quiet_load (const std::string name, const file_type type=auto_detect)
 
bool field< oT >::quiet_load (std::istream &is, const file_type type=auto_detect)
 
bool field< oT >::quiet_save (const std::string name, const file_type type=arma_binary) const
 
bool field< oT >::quiet_save (std::ostream &os, const file_type type=arma_binary) const
 
void field< oT >::reset ()
 reset the field to an empty state (i.e. the field will have no objects) More...
 
void field< oT >::reset_objects ()
 reset each object More...
 
template<typename oT >
static void field_aux::reset_objects (field< oT > &x)
 
template<typename eT >
static void field_aux::reset_objects (field< Mat< eT > > &x)
 
template<typename eT >
static void field_aux::reset_objects (field< Col< eT > > &x)
 
template<typename eT >
static void field_aux::reset_objects (field< Row< eT > > &x)
 
template<typename eT >
static void field_aux::reset_objects (field< Cube< eT > > &x)
 
static void field_aux::reset_objects (field< std::string > &x)
 
subview_field< oT > field< oT >::row (const uword row_num)
 creation of subview_field (row of a field) More...
 
const subview_field< oT > field< oT >::row (const uword row_num) const
 creation of subview_field (row of a field) More...
 
subview_field< oT > field< oT >::rows (const uword in_row1, const uword in_row2)
 creation of subview_field (subfield comprised of specified rows) More...
 
const subview_field< oT > field< oT >::rows (const uword in_row1, const uword in_row2) const
 creation of subview_field (subfield comprised of specified rows) More...
 
bool field< oT >::save (const std::string name, const file_type type=arma_binary, const bool print_status=true) const
 
bool field< oT >::save (std::ostream &os, const file_type type=arma_binary, const bool print_status=true) const
 
template<typename oT >
static bool field_aux::save (const field< oT > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename oT >
static bool field_aux::save (const field< oT > &x, std::ostream &os, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Mat< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Mat< eT > > &x, std::ostream &os, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Col< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Col< eT > > &x, std::ostream &os, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Row< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Row< eT > > &x, std::ostream &os, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Cube< eT > > &x, const std::string &name, const file_type type, std::string &err_msg)
 
template<typename eT >
static bool field_aux::save (const field< Cube< eT > > &x, std::ostream &os, const file_type type, std::string &err_msg)
 
static bool field_aux::save (const field< std::string > &x, const std::string &name, const file_type type, std::string &err_msg)
 
static bool field_aux::save (const field< std::string > &x, std::ostream &os, const file_type type, std::string &err_msg)
 
void field< oT >::set_size (const uword n_obj_in)
 
void field< oT >::set_size (const uword n_rows_in, const uword n_cols_in)
 change the field to have the specified dimensions (data is not preserved) More...
 
subview_field< oT > field< oT >::subfield (const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2)
 creation of subview_field (subfield with arbitrary dimensions) More...
 
const subview_field< oT > field< oT >::subfield (const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const
 creation of subview_field (subfield with arbitrary dimensions) More...
 
subview_field< oT > field< oT >::subfield (const span &row_span, const span &col_span)
 creation of subview_field (subfield with arbitrary dimensions) More...
 
const subview_field< oT > field< oT >::subfield (const span &row_span, const span &col_span) const
 creation of subview_field (subfield with arbitrary dimensions) More...
 
 field< oT >::~field ()
 

Detailed Description

Function Documentation

template<typename oT >
arma_inline oT & field< oT >::at ( const uword  i)

linear element accessor (treats the field as a vector); no bounds check

Definition at line 217 of file field_meat.hpp.

template<typename oT >
arma_inline const oT & field< oT >::at ( const uword  i) const

linear element accessor (treats the field as a vector); no bounds check

Definition at line 228 of file field_meat.hpp.

template<typename oT >
arma_inline oT & field< oT >::at ( const uword  row,
const uword  col 
)

element accessor; no bounds check

Definition at line 287 of file field_meat.hpp.

template<typename oT >
arma_inline const oT & field< oT >::at ( const uword  row,
const uword  col 
) const

element accessor; no bounds check

Definition at line 298 of file field_meat.hpp.

template<typename oT >
field< oT >::iterator field< oT >::begin ( )
inline

Definition at line 1314 of file field_meat.hpp.

template<typename oT >
field< oT >::const_iterator field< oT >::begin ( ) const
inline

Definition at line 1326 of file field_meat.hpp.

template<typename oT >
subview_field< oT > field< oT >::col ( const uword  col_num)
inline

creation of subview_field (column of a field)

Definition at line 359 of file field_meat.hpp.

template<typename oT >
const subview_field< oT > field< oT >::col ( const uword  col_num) const
inline

creation of subview_field (column of a field)

Definition at line 374 of file field_meat.hpp.

template<typename oT >
subview_field< oT > field< oT >::cols ( const uword  in_col1,
const uword  in_col2 
)
inline

creation of subview_field (subfield comprised of specified columns)

Definition at line 431 of file field_meat.hpp.

template<typename oT >
const subview_field< oT > field< oT >::cols ( const uword  in_col1,
const uword  in_col2 
) const
inline

creation of subview_field (subfield comprised of specified columns)

Definition at line 452 of file field_meat.hpp.

template<typename oT>
field< oT >::const_iterator::const_iterator ( const field< oT > &  in_M,
const bool  at_end = false 
)
inline

Definition at line 1214 of file field_meat.hpp.

template<typename oT >
template<typename oT2 >
void field< oT >::copy_size ( const field< oT2 > &  x)
inline

change the field to have the specified dimensions (data is not preserved)

Definition at line 182 of file field_meat.hpp.

template<typename oT >
void field< oT >::create_objects ( )
inlineprivate

Definition at line 1111 of file field_meat.hpp.

template<typename oT >
void field< oT >::delete_objects ( )
inlineprivate

Definition at line 1091 of file field_meat.hpp.

template<typename oT >
field< oT >::iterator field< oT >::end ( )
inline

Definition at line 1338 of file field_meat.hpp.

template<typename oT >
field< oT >::const_iterator field< oT >::end ( ) const
inline

Definition at line 1350 of file field_meat.hpp.

template<typename oT >
field< oT >::field ( )
inline

Definition at line 46 of file field_meat.hpp.

template<typename oT >
field< oT >::field ( const field< oT > &  x)
inline

construct a field from a given field

Definition at line 60 of file field_meat.hpp.

template<typename oT>
field< oT >::field ( const subview_field< oT > &  x)
inline

construct a field from subview_field (e.g. construct a field from a delayed subfield operation)

Definition at line 90 of file field_meat.hpp.

template<typename oT>
field< oT >::field ( const uword  n_elem_in)
inlineexplicit

construct the field with the specified number of elements, assuming a column-major layout

Definition at line 121 of file field_meat.hpp.

template<typename oT>
field< oT >::field ( const uword  n_rows_in,
const uword  n_cols_in 
)
inline

construct the field with the specified dimensions

Definition at line 137 of file field_meat.hpp.

template<typename oT>
void field< oT >::fill ( const oT &  x)
inline

fill the field with an object

Definition at line 673 of file field_meat.hpp.

template<typename oT >
arma_inline arma_warn_unused bool field< oT >::in_range ( const uword  i) const

returns true if the given index is currently in range

Definition at line 729 of file field_meat.hpp.

template<typename oT >
arma_inline arma_warn_unused bool field< oT >::in_range ( const span &  x) const

returns true if the given start and end indices are currently in range

Definition at line 741 of file field_meat.hpp.

template<typename oT >
arma_inline arma_warn_unused bool field< oT >::in_range ( const uword  in_row,
const uword  in_col 
) const

returns true if the given location is currently in range

Definition at line 765 of file field_meat.hpp.

template<typename oT >
arma_inline arma_warn_unused bool field< oT >::in_range ( const span &  row_span,
const uword  in_col 
) const

Definition at line 776 of file field_meat.hpp.

template<typename oT >
arma_inline arma_warn_unused bool field< oT >::in_range ( const uword  in_row,
const span &  col_span 
) const

Definition at line 799 of file field_meat.hpp.

template<typename oT >
arma_inline arma_warn_unused bool field< oT >::in_range ( const span &  row_span,
const span &  col_span 
) const

Definition at line 822 of file field_meat.hpp.

template<typename oT>
void field< oT >::init ( const field< oT > &  x)
inlineprivate

construct a field from a given field

Definition at line 1010 of file field_meat.hpp.

template<typename oT>
void field< oT >::init ( const uword  n_rows_in,
const uword  n_cols_in 
)
inlineprivate

internal field construction; if the requested size is small enough, memory from the stack is used. otherwise memory is allocated via 'new'

Definition at line 1035 of file field_meat.hpp.

template<typename oT >
arma_inline bool field< oT >::is_empty ( ) const

returns true if the field has no objects

Definition at line 717 of file field_meat.hpp.

template<typename oT>
field< oT >::iterator::iterator ( field< oT > &  in_M,
const bool  at_end = false 
)
inline

Definition at line 1126 of file field_meat.hpp.

template<typename oT >
bool field< oT >::load ( const std::string  name,
const file_type  type = auto_detect,
const bool  print_status = true 
)
inline

Definition at line 897 of file field_meat.hpp.

template<typename oT >
bool field< oT >::load ( std::istream &  is,
const file_type  type = auto_detect,
const bool  print_status = true 
)
inline

Definition at line 929 of file field_meat.hpp.

template<typename oT >
bool field_aux::load ( field< oT > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1489 of file field_meat.hpp.

template<typename oT >
bool field_aux::load ( field< oT > &  x,
std::istream &  is,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1503 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Mat< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1567 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Mat< eT > > &  x,
std::istream &  is,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1596 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Col< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1675 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Col< eT > > &  x,
std::istream &  is,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1704 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Row< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1783 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Row< eT > > &  x,
std::istream &  is,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1812 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Cube< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1891 of file field_meat.hpp.

template<typename eT >
bool field_aux::load ( field< Cube< eT > > &  x,
std::istream &  is,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1920 of file field_meat.hpp.

bool field_aux::load ( field< std::string > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1978 of file field_meat.hpp.

bool field_aux::load ( field< std::string > &  x,
std::istream &  is,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1991 of file field_meat.hpp.

template<typename oT>
bool field< oT >::iterator::operator!= ( const iterator &  X) const
inline

Definition at line 1195 of file field_meat.hpp.

template<typename oT>
bool field< oT >::const_iterator::operator!= ( const const_iterator &  X) const
inline

Definition at line 1294 of file field_meat.hpp.

template<typename oT >
arma_inline oT & field< oT >::operator() ( const uword  i)

linear element accessor (treats the field as a vector); bounds checking not done when ARMA_NO_DEBUG is defined

Definition at line 239 of file field_meat.hpp.

template<typename oT >
arma_inline const oT & field< oT >::operator() ( const uword  i) const

linear element accessor (treats the field as a vector); bounds checking not done when ARMA_NO_DEBUG is defined

Definition at line 251 of file field_meat.hpp.

template<typename oT >
arma_inline oT & field< oT >::operator() ( const uword  row,
const uword  col 
)

element accessor; bounds checking not done when ARMA_NO_DEBUG is defined

Definition at line 263 of file field_meat.hpp.

template<typename oT >
arma_inline const oT & field< oT >::operator() ( const uword  row,
const uword  col 
) const

element accessor; bounds checking not done when ARMA_NO_DEBUG is defined

Definition at line 275 of file field_meat.hpp.

template<typename oT >
subview_field< oT > field< oT >::operator() ( const span &  row_span,
const span &  col_span 
)
inline

Definition at line 588 of file field_meat.hpp.

template<typename oT >
const subview_field< oT > field< oT >::operator() ( const span &  row_span,
const span &  col_span 
) const
inline

Definition at line 600 of file field_meat.hpp.

template<typename oT >
oT & field< oT >::iterator::operator* ( )
inline

Definition at line 1138 of file field_meat.hpp.

template<typename oT >
const oT & field< oT >::const_iterator::operator* ( ) const
inline

Definition at line 1237 of file field_meat.hpp.

template<typename oT >
field< oT >::iterator & field< oT >::iterator::operator++ ( )
inline

Definition at line 1148 of file field_meat.hpp.

template<typename oT >
void field< oT >::iterator::operator++ ( int  )
inline

Definition at line 1160 of file field_meat.hpp.

template<typename oT >
field< oT >::const_iterator & field< oT >::const_iterator::operator++ ( )
inline

Definition at line 1247 of file field_meat.hpp.

template<typename oT >
void field< oT >::const_iterator::operator++ ( int  )
inline

Definition at line 1259 of file field_meat.hpp.

template<typename oT >
field< oT >::iterator & field< oT >::iterator::operator-- ( )
inline

Definition at line 1170 of file field_meat.hpp.

template<typename oT >
void field< oT >::iterator::operator-- ( int  )
inline

Definition at line 1185 of file field_meat.hpp.

template<typename oT >
field< oT >::const_iterator & field< oT >::const_iterator::operator-- ( )
inline

Definition at line 1269 of file field_meat.hpp.

template<typename oT >
void field< oT >::const_iterator::operator-- ( int  )
inline

Definition at line 1284 of file field_meat.hpp.

template<typename oT>
field_injector< field< oT > > field< oT >::operator<< ( const oT &  val)
inline

Definition at line 308 of file field_meat.hpp.

template<typename oT>
field_injector< field< oT > > field< oT >::operator<< ( const injector_end_of_row &  x)
inline

Definition at line 318 of file field_meat.hpp.

template<typename oT >
const field< oT > & field< oT >::operator= ( const field< oT > &  x)
inline

construct a field from a given field

Definition at line 77 of file field_meat.hpp.

template<typename oT>
const field< oT > & field< oT >::operator= ( const subview_field< oT > &  x)
inline

construct a field from subview_field (e.g. construct a field from a delayed subfield operation)

Definition at line 107 of file field_meat.hpp.

template<typename oT>
bool field< oT >::iterator::operator== ( const iterator &  X) const
inline

Definition at line 1205 of file field_meat.hpp.

template<typename oT>
bool field< oT >::const_iterator::operator== ( const const_iterator &  X) const
inline

Definition at line 1304 of file field_meat.hpp.

template<typename oT >
arma_inline oT & field< oT >::operator[] ( const uword  i)

linear element accessor (treats the field as a vector); no bounds check

Definition at line 195 of file field_meat.hpp.

template<typename oT >
arma_inline const oT & field< oT >::operator[] ( const uword  i) const

linear element accessor (treats the field as a vector); no bounds check

Definition at line 206 of file field_meat.hpp.

template<typename oT >
void field< oT >::print ( const std::string  extra_text = "") const
inline

print contents of the field (to the cout stream), optionally preceding with a user specified line of text. the field class preserves the stream's flags but the associated operator<< function for type oT may still modify the stream's parameters. NOTE: this function assumes that type oT can be printed, i.e. the function "std::ostream& operator<< (std::ostream&, const oT&)" has been defined.

Definition at line 621 of file field_meat.hpp.

template<typename oT >
void field< oT >::print ( std::ostream &  user_stream,
const std::string  extra_text = "" 
) const
inline

print contents of the field to a user specified stream, optionally preceding with a user specified line of text. the field class preserves the stream's flags but the associated operator<< function for type oT may still modify the stream's parameters. NOTE: this function assumes that type oT can be printed, i.e. the function "std::ostream& operator<< (std::ostream&, const oT&)" has been defined.

Definition at line 651 of file field_meat.hpp.

template<typename oT >
bool field< oT >::quiet_load ( const std::string  name,
const file_type  type = auto_detect 
)
inline

Definition at line 985 of file field_meat.hpp.

template<typename oT >
bool field< oT >::quiet_load ( std::istream &  is,
const file_type  type = auto_detect 
)
inline

Definition at line 997 of file field_meat.hpp.

template<typename oT >
bool field< oT >::quiet_save ( const std::string  name,
const file_type  type = arma_binary 
) const
inline

Definition at line 961 of file field_meat.hpp.

template<typename oT >
bool field< oT >::quiet_save ( std::ostream &  os,
const file_type  type = arma_binary 
) const
inline

Definition at line 973 of file field_meat.hpp.

template<typename oT >
void field< oT >::reset ( )
inline

reset the field to an empty state (i.e. the field will have no objects)

Definition at line 691 of file field_meat.hpp.

template<typename oT >
void field< oT >::reset_objects ( )
inline

reset each object

Definition at line 704 of file field_meat.hpp.

template<typename oT >
void field_aux::reset_objects ( field< oT > &  x)
inlinestatic

Definition at line 1368 of file field_meat.hpp.

template<typename eT >
void field_aux::reset_objects ( field< Mat< eT > > &  x)
inlinestatic

Definition at line 1381 of file field_meat.hpp.

template<typename eT >
void field_aux::reset_objects ( field< Col< eT > > &  x)
inlinestatic

Definition at line 1396 of file field_meat.hpp.

template<typename eT >
void field_aux::reset_objects ( field< Row< eT > > &  x)
inlinestatic

Definition at line 1411 of file field_meat.hpp.

template<typename eT >
void field_aux::reset_objects ( field< Cube< eT > > &  x)
inlinestatic

Definition at line 1426 of file field_meat.hpp.

void field_aux::reset_objects ( field< std::string > &  x)
inlinestatic

Definition at line 1440 of file field_meat.hpp.

template<typename oT >
subview_field< oT > field< oT >::row ( const uword  row_num)
inline

creation of subview_field (row of a field)

Definition at line 329 of file field_meat.hpp.

template<typename oT >
const subview_field< oT > field< oT >::row ( const uword  row_num) const
inline

creation of subview_field (row of a field)

Definition at line 344 of file field_meat.hpp.

template<typename oT >
subview_field< oT > field< oT >::rows ( const uword  in_row1,
const uword  in_row2 
)
inline

creation of subview_field (subfield comprised of specified rows)

Definition at line 389 of file field_meat.hpp.

template<typename oT >
const subview_field< oT > field< oT >::rows ( const uword  in_row1,
const uword  in_row2 
) const
inline

creation of subview_field (subfield comprised of specified rows)

Definition at line 410 of file field_meat.hpp.

template<typename oT >
bool field< oT >::save ( const std::string  name,
const file_type  type = arma_binary,
const bool  print_status = true 
) const
inline

Definition at line 843 of file field_meat.hpp.

template<typename oT >
bool field< oT >::save ( std::ostream &  os,
const file_type  type = arma_binary,
const bool  print_status = true 
) const
inline

Definition at line 870 of file field_meat.hpp.

template<typename oT >
bool field_aux::save ( const field< oT > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1461 of file field_meat.hpp.

template<typename oT >
bool field_aux::save ( const field< oT > &  x,
std::ostream &  os,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1475 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Mat< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1517 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Mat< eT > > &  x,
std::ostream &  os,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1542 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Col< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1625 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Col< eT > > &  x,
std::ostream &  os,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1650 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Row< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1733 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Row< eT > > &  x,
std::ostream &  os,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1758 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Cube< eT > > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1841 of file field_meat.hpp.

template<typename eT >
bool field_aux::save ( const field< Cube< eT > > &  x,
std::ostream &  os,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1866 of file field_meat.hpp.

bool field_aux::save ( const field< std::string > &  x,
const std::string &  name,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1948 of file field_meat.hpp.

bool field_aux::save ( const field< std::string > &  x,
std::ostream &  os,
const file_type  type,
std::string &  err_msg 
)
inlinestatic

Definition at line 1963 of file field_meat.hpp.

template<typename oT >
void field< oT >::set_size ( const uword  n_elem_in)
inline

change the field to have the specified number of elements, assuming a column-major layout (data is not preserved)

Definition at line 155 of file field_meat.hpp.

template<typename oT >
void field< oT >::set_size ( const uword  n_rows_in,
const uword  n_cols_in 
)
inline

change the field to have the specified dimensions (data is not preserved)

Definition at line 168 of file field_meat.hpp.

template<typename oT >
subview_field< oT > field< oT >::subfield ( const uword  in_row1,
const uword  in_col1,
const uword  in_row2,
const uword  in_col2 
)
inline

creation of subview_field (subfield with arbitrary dimensions)

Definition at line 473 of file field_meat.hpp.

template<typename oT >
const subview_field< oT > field< oT >::subfield ( const uword  in_row1,
const uword  in_col1,
const uword  in_row2,
const uword  in_col2 
) const
inline

creation of subview_field (subfield with arbitrary dimensions)

Definition at line 495 of file field_meat.hpp.

template<typename oT >
subview_field< oT > field< oT >::subfield ( const span &  row_span,
const span &  col_span 
)
inline

creation of subview_field (subfield with arbitrary dimensions)

Definition at line 517 of file field_meat.hpp.

template<typename oT >
const subview_field< oT > field< oT >::subfield ( const span &  row_span,
const span &  col_span 
) const
inline

creation of subview_field (subfield with arbitrary dimensions)

Definition at line 553 of file field_meat.hpp.

template<typename oT >
field< oT >::~field ( )
inline

Definition at line 21 of file field_meat.hpp.


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