Classes | |
| class | Cube< eT > |
| Dense cube class. More... | |
| class | Cube_aux |
| struct | Cube_prealloc |
Functions | |
| arma_inline arma_warn_unused eT & | Cube< eT >::at (const uword i) |
| linear element accessor (treats the cube as a vector); no bounds check. More... | |
| arma_inline arma_warn_unused eT | Cube< eT >::at (const uword i) const |
| linear element accessor (treats the cube as a vector); no bounds check More... | |
| arma_inline arma_warn_unused eT & | Cube< eT >::at (const uword in_row, const uword in_col, const uword in_slice) |
| element accessor; no bounds check More... | |
| arma_inline arma_warn_unused eT | Cube< eT >::at (const uword in_row, const uword in_col, const uword in_slice) const |
| element accessor; no bounds check More... | |
| iterator | Cube< eT >::begin () |
| const_iterator | Cube< eT >::begin () const |
| slice_iterator | Cube< eT >::begin_slice (const uword slice_num) |
| const_slice_iterator | Cube< eT >::begin_slice (const uword slice_num) const |
| template<typename eT2 > | |
| void | Cube< eT >::copy_size (const Cube< eT2 > &m) |
| change the cube (without preserving data) to have the same dimensions as the given cube More... | |
| void | Cube< eT >::create_mat () |
| Cube< eT >::Cube () | |
| Cube< eT >::Cube (const uword in_rows, const uword in_cols, const uword in_slices) | |
| construct the cube to have user specified dimensions More... | |
| Cube< eT >::Cube (eT *aux_mem, const uword aux_n_rows, const uword aux_n_cols, const uword aux_n_slices, const bool copy_aux_mem=true, const bool strict=true) | |
| Cube< eT >::Cube (const eT *aux_mem, const uword aux_n_rows, const uword aux_n_cols, const uword aux_n_slices) | |
| Cube< eT >::Cube (const Cube &m) | |
| construct a cube from a given cube More... | |
| Cube< eT >::Cube (const subview_cube< eT > &X) | |
| construct a cube from a subview_cube instance (e.g. construct a cube from a delayed subcube operation) More... | |
| template<typename gen_type > | |
| Cube< eT >::Cube (const GenCube< eT, gen_type > &X) | |
| create a cube from OpCube, i.e. run the previously delayed unary operations More... | |
| template<typename T1 , typename op_type > | |
| Cube< eT >::Cube (const OpCube< T1, op_type > &X) | |
| create a cube from OpCube, i.e. run the previously delayed unary operations More... | |
| template<typename T1 , typename eop_type > | |
| Cube< eT >::Cube (const eOpCube< T1, eop_type > &X) | |
| create a cube from eOpCube, i.e. run the previously delayed unary operations More... | |
| template<typename T1 , typename op_type > | |
| Cube< eT >::Cube (const mtOpCube< eT, T1, op_type > &X) | |
| EXPERIMENTAL. More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| Cube< eT >::Cube (const GlueCube< T1, T2, glue_type > &X) | |
| create a cube from Glue, i.e. run the previously delayed binary operations More... | |
| template<typename T1 , typename T2 , typename eglue_type > | |
| Cube< eT >::Cube (const eGlueCube< T1, T2, eglue_type > &X) | |
| create a cube from eGlue, i.e. run the previously delayed binary operations More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| Cube< eT >::Cube (const mtGlueCube< eT, T1, T2, glue_type > &X) | |
| EXPERIMENTAL. More... | |
| template<typename T1 , typename T2 > | |
| Cube< eT >::Cube (const BaseCube< typename Cube< eT >::pod_type, T1 > &A, const BaseCube< typename Cube< eT >::pod_type, T2 > &B) | |
| for constructing a complex cube out of two non-complex cubes More... | |
| void | Cube< eT >::delete_mat () |
| iterator | Cube< eT >::end () |
| const_iterator | Cube< eT >::end () const |
| slice_iterator | Cube< eT >::end_slice (const uword slice_num) |
| const_slice_iterator | Cube< eT >::end_slice (const uword slice_num) const |
| const Cube & | Cube< eT >::fill (const eT val) |
| fill the cube with the specified value More... | |
| void | Cube< eT >::impl_print (const std::string &extra_text) const |
| void | Cube< eT >::impl_print (std::ostream &user_stream, const std::string &extra_text) const |
| void | Cube< eT >::impl_raw_print (const std::string &extra_text) const |
| void | Cube< eT >::impl_raw_print (std::ostream &user_stream, const std::string &extra_text) const |
| arma_inline arma_warn_unused bool | Cube< eT >::in_range (const uword i) const |
| returns true if the given index is currently in range More... | |
| arma_inline arma_warn_unused bool | Cube< eT >::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 | Cube< eT >::in_range (const uword in_row, const uword in_col, const uword in_slice) const |
| returns true if the given location is currently in range More... | |
| arma_warn_unused bool | Cube< eT >::in_range (const span &row_span, const span &col_span, const span &slice_span) const |
| template<typename T1 , typename T2 > | |
| void | Cube< eT >::init (const BaseCube< typename Cube< eT >::pod_type, T1 > &A, const BaseCube< typename Cube< eT >::pod_type, T2 > &B) |
| for constructing a complex cube out of two non-complex cubes More... | |
| void | Cube< eT >::init_cold () |
| void | Cube< eT >::init_warm (const uword in_rows, const uword in_cols, const uword in_slices) |
| void | Cube< eT >::insert_slices (const uword slice_num, const uword N, const bool set_to_zero=true) |
| template<typename T1 > | |
| void | Cube< eT >::insert_slices (const uword row_num, const BaseCube< eT, T1 > &X) |
| arma_inline arma_warn_unused bool | Cube< eT >::is_empty () const |
| returns true if the cube has no elements More... | |
| arma_inline arma_warn_unused bool | Cube< eT >::is_finite () const |
| returns true if all of the elements are finite More... | |
| bool | Cube< eT >::load (const std::string name, const file_type type=auto_detect, const bool print_status=true) |
| load a cube from a file More... | |
| bool | Cube< eT >::load (std::istream &is, const file_type type=auto_detect, const bool print_status=true) |
| load a cube from a stream More... | |
| arma_warn_unused eT | Cube< eT >::max () const |
| eT | Cube< eT >::max (uword &index_of_max_val) const |
| eT | Cube< eT >::max (uword &row_of_max_val, uword &col_of_max_val, uword &slice_of_max_val) const |
| arma_inline void | Cube< eT >::fixed< fixed_n_rows, fixed_n_cols, fixed_n_slices >::mem_setup () |
| arma_inline arma_warn_unused eT * | Cube< eT >::memptr () |
| returns a pointer to array of eTs used by the cube More... | |
| arma_inline arma_warn_unused const eT * | Cube< eT >::memptr () const |
| returns a pointer to array of eTs used by the cube More... | |
| arma_warn_unused eT | Cube< eT >::min () const |
| eT | Cube< eT >::min (uword &index_of_min_val) const |
| eT | Cube< eT >::min (uword &row_of_min_val, uword &col_of_min_val, uword &slice_of_min_val) const |
| const Cube & | Cube< eT >::ones () |
| const Cube & | Cube< eT >::ones (const uword in_rows, const uword in_cols, const uword in_slices) |
| const Cube & | Cube< eT >::operator%= (const Cube &m) |
| in-place element-wise cube multiplication More... | |
| const Cube & | Cube< eT >::operator%= (const subview_cube< eT > &X) |
| in-place element-wise cube mutiplication (using a subcube on the right-hand-side) More... | |
| template<typename gen_type > | |
| const Cube< eT > & | Cube< eT >::operator%= (const GenCube< eT, gen_type > &X) |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator%= (const OpCube< T1, op_type > &X) |
| in-place cube element-wise multiplication, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename eop_type > | |
| const Cube< eT > & | Cube< eT >::operator%= (const eOpCube< T1, eop_type > &X) |
| in-place cube element-wise multiplication, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator%= (const mtOpCube< eT, T1, op_type > &X) |
| EXPERIMENTAL. More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator%= (const GlueCube< T1, T2, glue_type > &X) |
| in-place cube element-wise multiplication, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename eglue_type > | |
| const Cube< eT > & | Cube< eT >::operator%= (const eGlueCube< T1, T2, eglue_type > &X) |
| in-place cube element-wise multiplication, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator%= (const mtGlueCube< eT, T1, T2, glue_type > &X) |
| EXPERIMENTAL. More... | |
| subview_cube< eT > | Cube< eT >::operator() (const span &row_span, const span &col_span, const span &slice_span) |
| const subview_cube< eT > | Cube< eT >::operator() (const span &row_span, const span &col_span, const span &slice_span) const |
| arma_inline arma_warn_unused eT & | Cube< eT >::operator() (const uword i) |
| linear element accessor (treats the cube as a vector); bounds checking not done when ARMA_NO_DEBUG is defined More... | |
| arma_inline arma_warn_unused eT | Cube< eT >::operator() (const uword i) const |
| linear element accessor (treats the cube as a vector); bounds checking not done when ARMA_NO_DEBUG is defined More... | |
| arma_inline arma_warn_unused eT & | Cube< eT >::operator() (const uword in_row, const uword in_col, const uword in_slice) |
| element accessor; bounds checking not done when ARMA_NO_DEBUG is defined More... | |
| arma_inline arma_warn_unused eT | Cube< eT >::operator() (const uword in_row, const uword in_col, const uword in_slice) const |
| element accessor; bounds checking not done when ARMA_NO_DEBUG is defined More... | |
| arma_inline const Cube & | Cube< eT >::operator*= (const eT val) |
| In-place multiplication of all elements of the cube with a scalar. More... | |
| arma_inline const Cube & | Cube< eT >::operator++ () |
| prefix ++ More... | |
| arma_inline void | Cube< eT >::operator++ (int) |
| postfix ++ (must not return the object by reference) More... | |
| arma_inline const Cube & | Cube< eT >::operator+= (const eT val) |
| In-place addition of a scalar to all elements of the cube. More... | |
| const Cube & | Cube< eT >::operator+= (const Cube &m) |
| in-place cube addition More... | |
| const Cube & | Cube< eT >::operator+= (const subview_cube< eT > &X) |
| in-place cube addition (using a subcube on the right-hand-side) More... | |
| template<typename gen_type > | |
| const Cube< eT > & | Cube< eT >::operator+= (const GenCube< eT, gen_type > &X) |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator+= (const OpCube< T1, op_type > &X) |
| in-place cube addition, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename eop_type > | |
| const Cube< eT > & | Cube< eT >::operator+= (const eOpCube< T1, eop_type > &X) |
| in-place cube addition, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator+= (const mtOpCube< eT, T1, op_type > &X) |
| EXPERIMENTAL. More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator+= (const GlueCube< T1, T2, glue_type > &X) |
| in-place cube addition, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename eglue_type > | |
| const Cube< eT > & | Cube< eT >::operator+= (const eGlueCube< T1, T2, eglue_type > &X) |
| in-place cube addition, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator+= (const mtGlueCube< eT, T1, T2, glue_type > &X) |
| EXPERIMENTAL. More... | |
| arma_inline const Cube & | Cube< eT >::operator-- () |
| prefix – More... | |
| arma_inline void | Cube< eT >::operator-- (int) |
| postfix – (must not return the object by reference) More... | |
| arma_inline const Cube & | Cube< eT >::operator-= (const eT val) |
| In-place subtraction of a scalar from all elements of the cube. More... | |
| const Cube & | Cube< eT >::operator-= (const Cube &m) |
| in-place cube subtraction More... | |
| const Cube & | Cube< eT >::operator-= (const subview_cube< eT > &X) |
| in-place cube subtraction (using a subcube on the right-hand-side) More... | |
| template<typename gen_type > | |
| const Cube< eT > & | Cube< eT >::operator-= (const GenCube< eT, gen_type > &X) |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator-= (const OpCube< T1, op_type > &X) |
| in-place cube subtraction, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename eop_type > | |
| const Cube< eT > & | Cube< eT >::operator-= (const eOpCube< T1, eop_type > &X) |
| in-place cube subtraction, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator-= (const mtOpCube< eT, T1, op_type > &X) |
| EXPERIMENTAL. More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator-= (const GlueCube< T1, T2, glue_type > &X) |
| in-place cube subtraction, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename eglue_type > | |
| const Cube< eT > & | Cube< eT >::operator-= (const eGlueCube< T1, T2, eglue_type > &X) |
| in-place cube subtraction, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator-= (const mtGlueCube< eT, T1, T2, glue_type > &X) |
| EXPERIMENTAL. More... | |
| arma_inline const Cube & | Cube< eT >::operator/= (const eT val) |
| In-place division of all elements of the cube with a scalar. More... | |
| const Cube & | Cube< eT >::operator/= (const Cube &m) |
| in-place element-wise cube division More... | |
| const Cube & | Cube< eT >::operator/= (const subview_cube< eT > &X) |
| in-place element-wise cube division (using a subcube on the right-hand-side) More... | |
| template<typename gen_type > | |
| const Cube< eT > & | Cube< eT >::operator/= (const GenCube< eT, gen_type > &X) |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator/= (const OpCube< T1, op_type > &X) |
| in-place cube element-wise division, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename eop_type > | |
| const Cube< eT > & | Cube< eT >::operator/= (const eOpCube< T1, eop_type > &X) |
| in-place cube element-wise division, with the right-hand-side operand having delayed operations More... | |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator/= (const mtOpCube< eT, T1, op_type > &X) |
| EXPERIMENTAL. More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator/= (const GlueCube< T1, T2, glue_type > &X) |
| in-place cube element-wise division, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename eglue_type > | |
| const Cube< eT > & | Cube< eT >::operator/= (const eGlueCube< T1, T2, eglue_type > &X) |
| in-place cube element-wise division, with the right-hand-side operands having delayed operations More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator/= (const mtGlueCube< eT, T1, T2, glue_type > &X) |
| EXPERIMENTAL. More... | |
| arma_inline const Cube & | Cube< eT >::operator= (const eT val) |
| const Cube & | Cube< eT >::operator= (const Cube &m) |
| construct a cube from a given cube More... | |
| const Cube & | Cube< eT >::operator= (const subview_cube< eT > &X) |
| construct a cube from a subview_cube instance (e.g. construct a cube from a delayed subcube operation) More... | |
| template<typename gen_type > | |
| const Cube< eT > & | Cube< eT >::operator= (const GenCube< eT, gen_type > &X) |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator= (const OpCube< T1, op_type > &X) |
| create a cube from OpCube, i.e. run the previously delayed unary operations More... | |
| template<typename T1 , typename eop_type > | |
| const Cube< eT > & | Cube< eT >::operator= (const eOpCube< T1, eop_type > &X) |
| create a cube from eOpCube, i.e. run the previously delayed unary operations More... | |
| template<typename T1 , typename op_type > | |
| const Cube< eT > & | Cube< eT >::operator= (const mtOpCube< eT, T1, op_type > &X) |
| EXPERIMENTAL. More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator= (const GlueCube< T1, T2, glue_type > &X) |
| create a cube from Glue, i.e. run the previously delayed binary operations More... | |
| template<typename T1 , typename T2 , typename eglue_type > | |
| const Cube< eT > & | Cube< eT >::operator= (const eGlueCube< T1, T2, eglue_type > &X) |
| create a cube from Glue, i.e. run the previously delayed binary operations More... | |
| template<typename T1 , typename T2 , typename glue_type > | |
| const Cube< eT > & | Cube< eT >::operator= (const mtGlueCube< eT, T1, T2, glue_type > &X) |
| EXPERIMENTAL. More... | |
| arma_inline arma_warn_unused eT & | Cube< eT >::operator[] (const uword i) |
| linear element accessor (treats the cube as a vector); no bounds check. More... | |
| arma_inline arma_warn_unused eT | Cube< eT >::operator[] (const uword i) const |
| linear element accessor (treats the cube as a vector); no bounds check More... | |
| template<typename eT > | |
| static arma_inline void | Cube_aux::postfix_mm (Cube< eT > &x) |
| postfix – More... | |
| template<typename T > | |
| static arma_inline void | Cube_aux::postfix_mm (Cube< std::complex< T > > &x) |
| postfix ++ for complex numbers (work around for limitations of the std::complex class) More... | |
| template<typename eT > | |
| static arma_inline void | Cube_aux::postfix_pp (Cube< eT > &x) |
| postfix ++ More... | |
| template<typename T > | |
| static arma_inline void | Cube_aux::postfix_pp (Cube< std::complex< T > > &x) |
| postfix ++ for complex numbers (work around for limitations of the std::complex class) More... | |
| template<typename eT > | |
| static arma_inline void | Cube_aux::prefix_mm (Cube< eT > &x) |
| prefix – More... | |
| template<typename T > | |
| static arma_inline void | Cube_aux::prefix_mm (Cube< std::complex< T > > &x) |
| prefix – for complex numbers (work around for limitations of the std::complex class) More... | |
| template<typename eT > | |
| static arma_inline void | Cube_aux::prefix_pp (Cube< eT > &x) |
| prefix ++ More... | |
| template<typename T > | |
| static arma_inline void | Cube_aux::prefix_pp (Cube< std::complex< T > > &x) |
| prefix ++ for complex numbers (work around for limitations of the std::complex class) More... | |
| bool | Cube< eT >::quiet_load (const std::string name, const file_type type=auto_detect) |
| load a cube from a file, without printing any error messages More... | |
| bool | Cube< eT >::quiet_load (std::istream &is, const file_type type=auto_detect) |
| load a cube from a stream, without printing any error messages More... | |
| bool | Cube< eT >::quiet_save (const std::string name, const file_type type=arma_binary) const |
| save the cube to a file, without printing any error messages More... | |
| bool | Cube< eT >::quiet_save (std::ostream &os, const file_type type=arma_binary) const |
| save the cube to a stream, without printing any error messages More... | |
| const Cube & | Cube< eT >::randn () |
| const Cube & | Cube< eT >::randn (const uword in_rows, const uword in_cols, const uword in_slices) |
| const Cube & | Cube< eT >::randu () |
| const Cube & | Cube< eT >::randu (const uword in_rows, const uword in_cols, const uword in_slices) |
| void | Cube< eT >::reset () |
| void | Cube< eT >::reshape (const uword in_rows, const uword in_cols, const uword in_slices, const uword dim=0) |
| change the cube to have user specified dimensions (data is preserved) More... | |
| void | Cube< eT >::resize (const uword in_rows, const uword in_cols, const uword in_slices) |
| change the cube to have user specified dimensions (data is preserved) More... | |
| bool | Cube< eT >::save (const std::string name, const file_type type=arma_binary, const bool print_status=true) const |
| save the cube to a file More... | |
| bool | Cube< eT >::save (std::ostream &os, const file_type type=arma_binary, const bool print_status=true) const |
| save the cube to a stream More... | |
| template<typename eT , typename T1 > | |
| static void | Cube_aux::set_imag (Cube< eT > &out, const BaseCube< eT, T1 > &X) |
| template<typename T , typename T1 > | |
| static void | Cube_aux::set_imag (Cube< std::complex< T > > &out, const BaseCube< T, T1 > &X) |
| template<typename T1 > | |
| void | Cube< eT >::set_imag (const BaseCube< typename Cube< eT >::pod_type, T1 > &X) |
| template<typename eT , typename T1 > | |
| static void | Cube_aux::set_real (Cube< eT > &out, const BaseCube< eT, T1 > &X) |
| template<typename T , typename T1 > | |
| static void | Cube_aux::set_real (Cube< std::complex< T > > &out, const BaseCube< T, T1 > &X) |
| template<typename T1 > | |
| void | Cube< eT >::set_real (const BaseCube< typename Cube< eT >::pod_type, T1 > &X) |
| void | Cube< eT >::set_size (const uword in_rows, const uword in_cols, const uword in_slices) |
| change the cube to have user specified dimensions (data is not preserved) More... | |
| void | Cube< eT >::shed_slice (const uword slice_num) |
| remove specified slice More... | |
| void | Cube< eT >::shed_slices (const uword in_slice1, const uword in_slice2) |
| remove specified slices More... | |
| arma_inline Mat< eT > & | Cube< eT >::slice (const uword in_slice) |
| provide the reference to the matrix representing a single slice More... | |
| arma_inline const Mat< eT > & | Cube< eT >::slice (const uword in_slice) const |
| provide the reference to the matrix representing a single slice More... | |
| arma_inline arma_warn_unused eT * | Cube< eT >::slice_colptr (const uword in_slice, const uword in_col) |
| returns a pointer to array of eTs used by the specified slice in the cube More... | |
| arma_inline arma_warn_unused const eT * | Cube< eT >::slice_colptr (const uword in_slice, const uword in_col) const |
| returns a pointer to array of eTs used by the specified slice in the cube More... | |
| arma_inline arma_warn_unused eT * | Cube< eT >::slice_memptr (const uword slice) |
| returns a pointer to array of eTs used by the specified slice in the cube More... | |
| arma_inline arma_warn_unused const eT * | Cube< eT >::slice_memptr (const uword slice) const |
| returns a pointer to array of eTs used by the specified slice in the cube More... | |
| arma_inline subview_cube< eT > | Cube< eT >::slices (const uword in_slice1, const uword in_slice2) |
| creation of subview_cube (subcube comprised of specified slices) More... | |
| arma_inline const subview_cube< eT > | Cube< eT >::slices (const uword in_slice1, const uword in_slice2) const |
| creation of subview_cube (subcube comprised of specified slices) More... | |
| void | Cube< eT >::steal_mem (Cube &X) |
| arma_inline subview_cube< eT > | Cube< eT >::subcube (const uword in_row1, const uword in_col1, const uword in_slice1, const uword in_row2, const uword in_col2, const uword in_slice2) |
| creation of subview_cube (generic subcube) More... | |
| arma_inline const subview_cube< eT > | Cube< eT >::subcube (const uword in_row1, const uword in_col1, const uword in_slice1, const uword in_row2, const uword in_col2, const uword in_slice2) const |
| creation of subview_cube (generic subcube) More... | |
| subview_cube< eT > | Cube< eT >::subcube (const span &row_span, const span &col_span, const span &slice_span) |
| creation of subview_cube (generic subcube) More... | |
| const subview_cube< eT > | Cube< eT >::subcube (const span &row_span, const span &col_span, const span &slice_span) const |
| creation of subview_cube (generic subcube) More... | |
| const Cube & | Cube< eT >::zeros () |
| const Cube & | Cube< eT >::zeros (const uword in_rows, const uword in_cols, const uword in_slices) |
| Cube< eT >::~Cube () | |
| arma_inline arma_warn_unused eT & Cube< eT >::at | ( | const uword | i | ) |
linear element accessor (treats the cube as a vector); no bounds check.
Definition at line 2024 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT Cube< eT >::at | ( | const uword | i | ) | const |
linear element accessor (treats the cube as a vector); no bounds check
Definition at line 2036 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT & Cube< eT >::at | ( | const uword | in_row, |
| const uword | in_col, | ||
| const uword | in_slice | ||
| ) |
element accessor; no bounds check
Definition at line 2090 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT Cube< eT >::at | ( | const uword | in_row, |
| const uword | in_col, | ||
| const uword | in_slice | ||
| ) | const |
element accessor; no bounds check
Definition at line 2102 of file Cube_meat.hpp.
Definition at line 3026 of file Cube_meat.hpp.
Definition at line 3038 of file Cube_meat.hpp.
|
inline |
Definition at line 3074 of file Cube_meat.hpp.
|
inline |
Definition at line 3088 of file Cube_meat.hpp.
|
inline |
change the cube (without preserving data) to have the same dimensions as the given cube
Definition at line 2454 of file Cube_meat.hpp.
|
inlineprotected |
Definition at line 387 of file Cube_meat.hpp.
Definition at line 56 of file Cube_meat.hpp.
|
inline |
construct the cube to have user specified dimensions
Definition at line 74 of file Cube_meat.hpp.
|
inline |
construct a cube from a given auxiliary array of eTs. if copy_aux_mem is true, new memory is allocated and the array is copied. if copy_aux_mem is false, the auxiliary array is used directly (without allocating memory and copying). note that in the latter case the default is to copy the array.
Definition at line 540 of file Cube_meat.hpp.
|
inline |
construct a cube from a given auxiliary read-only array of eTs. the array is copied.
Definition at line 570 of file Cube_meat.hpp.
construct a cube from a given cube
Definition at line 492 of file Cube_meat.hpp.
|
inline |
construct a cube from a subview_cube instance (e.g. construct a cube from a delayed subcube operation)
Definition at line 685 of file Cube_meat.hpp.
|
inline |
create a cube from OpCube, i.e. run the previously delayed unary operations
Definition at line 1183 of file Cube_meat.hpp.
|
inline |
create a cube from OpCube, i.e. run the previously delayed unary operations
Definition at line 1283 of file Cube_meat.hpp.
|
inline |
create a cube from eOpCube, i.e. run the previously delayed unary operations
Definition at line 1396 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1524 of file Cube_meat.hpp.
|
inline |
create a cube from Glue, i.e. run the previously delayed binary operations
Definition at line 1625 of file Cube_meat.hpp.
|
inline |
create a cube from eGlue, i.e. run the previously delayed binary operations
Definition at line 1739 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1873 of file Cube_meat.hpp.
|
inline |
for constructing a complex cube out of two non-complex cubes
Definition at line 662 of file Cube_meat.hpp.
|
inlineprotected |
Definition at line 364 of file Cube_meat.hpp.
Definition at line 3050 of file Cube_meat.hpp.
Definition at line 3062 of file Cube_meat.hpp.
|
inline |
Definition at line 3102 of file Cube_meat.hpp.
|
inline |
Definition at line 3116 of file Cube_meat.hpp.
fill the cube with the specified value
Definition at line 2467 of file Cube_meat.hpp.
|
inline |
print contents of the cube (to the cout stream), optionally preceding with a user specified line of text. the precision and cell width are modified. on return, the stream's state are restored to their original values.
Definition at line 2334 of file Cube_meat.hpp.
|
inline |
print contents of the cube to a user specified stream, optionally preceding with a user specified line of text. the precision and cell width are modified. on return, the stream's state are restored to their original values.
Definition at line 2354 of file Cube_meat.hpp.
|
inline |
print contents of the cube (to the cout stream), optionally preceding with a user specified line of text. the stream's state are used as is and are not modified (i.e. the precision and cell width are not modified).
Definition at line 2375 of file Cube_meat.hpp.
|
inline |
print contents of the cube to a user specified stream, optionally preceding with a user specified line of text. the stream's state are used as is and are not modified. (i.e. the precision and cell width are not modified).
Definition at line 2396 of file Cube_meat.hpp.
| arma_inline arma_warn_unused bool Cube< eT >::in_range | ( | const uword | i | ) | const |
returns true if the given index is currently in range
Definition at line 2184 of file Cube_meat.hpp.
| arma_inline arma_warn_unused bool Cube< eT >::in_range | ( | const span & | x | ) | const |
returns true if the given start and end indices are currently in range
Definition at line 2196 of file Cube_meat.hpp.
| arma_inline arma_warn_unused bool Cube< eT >::in_range | ( | const uword | in_row, |
| const uword | in_col, | ||
| const uword | in_slice | ||
| ) | const |
returns true if the given location is currently in range
Definition at line 2220 of file Cube_meat.hpp.
|
inline |
Definition at line 2231 of file Cube_meat.hpp.
|
inline |
for constructing a complex cube out of two non-complex cubes
< compile-time abort if eT isn't std::complex
< compile-time abort if T is std::complex
< compile-time abort if types are not compatible
Definition at line 269 of file Cube_meat.hpp.
|
inlineprotected |
Definition at line 94 of file Cube_meat.hpp.
|
inlineprotected |
internal cube construction; if the requested size is small enough, memory from the stack is used. otherwise memory is allocated via 'new'
Definition at line 146 of file Cube_meat.hpp.
|
inline |
insert N slices at the specified slice position, optionally setting the elements of the inserted slices to zero
Definition at line 1086 of file Cube_meat.hpp.
|
inline |
insert the given object at the specified slice position; the given object must have the same number of rows and columns as the cube
Definition at line 1134 of file Cube_meat.hpp.
| arma_inline arma_warn_unused bool Cube< eT >::is_empty | ( | ) | const |
returns true if the cube has no elements
Definition at line 2172 of file Cube_meat.hpp.
| arma_inline arma_warn_unused bool Cube< eT >::is_finite | ( | ) | const |
returns true if all of the elements are finite
Definition at line 2160 of file Cube_meat.hpp.
|
inline |
load a cube from a file
Definition at line 2846 of file Cube_meat.hpp.
|
inline |
load a cube from a stream
Definition at line 2910 of file Cube_meat.hpp.
|
inline |
Definition at line 2663 of file Cube_meat.hpp.
Definition at line 2691 of file Cube_meat.hpp.
|
inline |
Definition at line 2731 of file Cube_meat.hpp.
|
private |
Definition at line 3131 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT * Cube< eT >::memptr | ( | ) |
returns a pointer to array of eTs used by the cube
Definition at line 2260 of file Cube_meat.hpp.
| arma_inline arma_warn_unused const eT * Cube< eT >::memptr | ( | ) | const |
returns a pointer to array of eTs used by the cube
Definition at line 2272 of file Cube_meat.hpp.
|
inline |
Definition at line 2648 of file Cube_meat.hpp.
Definition at line 2677 of file Cube_meat.hpp.
|
inline |
Definition at line 2705 of file Cube_meat.hpp.
Definition at line 2507 of file Cube_meat.hpp.
|
inline |
Definition at line 2519 of file Cube_meat.hpp.
in-place element-wise cube multiplication
Definition at line 627 of file Cube_meat.hpp.
|
inline |
in-place element-wise cube mutiplication (using a subcube on the right-hand-side)
Definition at line 766 of file Cube_meat.hpp.
|
inline |
Definition at line 1253 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise multiplication, with the right-hand-side operand having delayed operations
Definition at line 1361 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise multiplication, with the right-hand-side operand having delayed operations
Definition at line 1489 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1594 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise multiplication, with the right-hand-side operands having delayed operations
Definition at line 1702 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise multiplication, with the right-hand-side operands having delayed operations
Definition at line 1836 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1943 of file Cube_meat.hpp.
|
inline |
Definition at line 1011 of file Cube_meat.hpp.
|
inline |
Definition at line 1023 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT & Cube< eT >::operator() | ( | const uword | i | ) |
linear element accessor (treats the cube as a vector); bounds checking not done when ARMA_NO_DEBUG is defined
Definition at line 1975 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT Cube< eT >::operator() | ( | const uword | i | ) | const |
linear element accessor (treats the cube as a vector); bounds checking not done when ARMA_NO_DEBUG is defined
Definition at line 1988 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT & Cube< eT >::operator() | ( | const uword | in_row, |
| const uword | in_col, | ||
| const uword | in_slice | ||
| ) |
element accessor; bounds checking not done when ARMA_NO_DEBUG is defined
Definition at line 2048 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT Cube< eT >::operator() | ( | const uword | in_row, |
| const uword | in_col, | ||
| const uword | in_slice | ||
| ) | const |
element accessor; bounds checking not done when ARMA_NO_DEBUG is defined
Definition at line 2069 of file Cube_meat.hpp.
| arma_inline const Cube< eT > & Cube< eT >::operator*= | ( | const eT | val | ) |
In-place multiplication of all elements of the cube with a scalar.
Definition at line 463 of file Cube_meat.hpp.
| arma_inline const Cube< eT > & Cube< eT >::operator++ | ( | ) |
prefix ++
Definition at line 2113 of file Cube_meat.hpp.
| arma_inline void Cube< eT >::operator++ | ( | int | ) |
postfix ++ (must not return the object by reference)
Definition at line 2125 of file Cube_meat.hpp.
| arma_inline const Cube< eT > & Cube< eT >::operator+= | ( | const eT | val | ) |
In-place addition of a scalar to all elements of the cube.
Definition at line 433 of file Cube_meat.hpp.
in-place cube addition
Definition at line 593 of file Cube_meat.hpp.
|
inline |
in-place cube addition (using a subcube on the right-hand-side)
Definition at line 736 of file Cube_meat.hpp.
|
inline |
Definition at line 1223 of file Cube_meat.hpp.
|
inline |
in-place cube addition, with the right-hand-side operand having delayed operations
Definition at line 1325 of file Cube_meat.hpp.
|
inline |
in-place cube addition, with the right-hand-side operand having delayed operations
Definition at line 1453 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1562 of file Cube_meat.hpp.
|
inline |
in-place cube addition, with the right-hand-side operands having delayed operations
Definition at line 1664 of file Cube_meat.hpp.
|
inline |
in-place cube addition, with the right-hand-side operands having delayed operations
Definition at line 1798 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1911 of file Cube_meat.hpp.
| arma_inline const Cube< eT > & Cube< eT >::operator-- | ( | ) |
prefix –
Definition at line 2136 of file Cube_meat.hpp.
| arma_inline void Cube< eT >::operator-- | ( | int | ) |
postfix – (must not return the object by reference)
Definition at line 2148 of file Cube_meat.hpp.
| arma_inline const Cube< eT > & Cube< eT >::operator-= | ( | const eT | val | ) |
In-place subtraction of a scalar from all elements of the cube.
Definition at line 448 of file Cube_meat.hpp.
in-place cube subtraction
Definition at line 610 of file Cube_meat.hpp.
|
inline |
in-place cube subtraction (using a subcube on the right-hand-side)
Definition at line 751 of file Cube_meat.hpp.
|
inline |
Definition at line 1238 of file Cube_meat.hpp.
|
inline |
in-place cube subtraction, with the right-hand-side operand having delayed operations
Definition at line 1343 of file Cube_meat.hpp.
|
inline |
in-place cube subtraction, with the right-hand-side operand having delayed operations
Definition at line 1471 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1578 of file Cube_meat.hpp.
|
inline |
in-place cube subtraction, with the right-hand-side operands having delayed operations
Definition at line 1683 of file Cube_meat.hpp.
|
inline |
in-place cube subtraction, with the right-hand-side operands having delayed operations
Definition at line 1817 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1927 of file Cube_meat.hpp.
| arma_inline const Cube< eT > & Cube< eT >::operator/= | ( | const eT | val | ) |
In-place division of all elements of the cube with a scalar.
Definition at line 478 of file Cube_meat.hpp.
in-place element-wise cube division
Definition at line 644 of file Cube_meat.hpp.
|
inline |
in-place element-wise cube division (using a subcube on the right-hand-side)
Definition at line 781 of file Cube_meat.hpp.
|
inline |
Definition at line 1268 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise division, with the right-hand-side operand having delayed operations
Definition at line 1379 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise division, with the right-hand-side operand having delayed operations
Definition at line 1507 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1610 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise division, with the right-hand-side operands having delayed operations
Definition at line 1721 of file Cube_meat.hpp.
|
inline |
in-place cube element-wise division, with the right-hand-side operands having delayed operations
Definition at line 1855 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1959 of file Cube_meat.hpp.
| arma_inline const Cube< eT > & Cube< eT >::operator= | ( | const eT | val | ) |
Set the cube to be equal to the specified scalar. NOTE: the size of the cube will be 1x1x1
Definition at line 418 of file Cube_meat.hpp.
construct a cube from a given cube
Definition at line 516 of file Cube_meat.hpp.
|
inline |
construct a cube from a subview_cube instance (e.g. construct a cube from a delayed subcube operation)
Definition at line 708 of file Cube_meat.hpp.
|
inline |
Definition at line 1206 of file Cube_meat.hpp.
|
inline |
create a cube from OpCube, i.e. run the previously delayed unary operations
Definition at line 1307 of file Cube_meat.hpp.
|
inline |
create a cube from eOpCube, i.e. run the previously delayed unary operations
Definition at line 1422 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1546 of file Cube_meat.hpp.
|
inline |
create a cube from Glue, i.e. run the previously delayed binary operations
Definition at line 1646 of file Cube_meat.hpp.
|
inline |
create a cube from Glue, i.e. run the previously delayed binary operations
Definition at line 1766 of file Cube_meat.hpp.
|
inline |
EXPERIMENTAL.
Definition at line 1895 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT & Cube< eT >::operator[] | ( | const uword | i | ) |
linear element accessor (treats the cube as a vector); no bounds check.
Definition at line 2000 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT Cube< eT >::operator[] | ( | const uword | i | ) | const |
linear element accessor (treats the cube as a vector); no bounds check
Definition at line 2012 of file Cube_meat.hpp.
|
static |
postfix –
Definition at line 3276 of file Cube_meat.hpp.
|
static |
postfix ++ for complex numbers (work around for limitations of the std::complex class)
Definition at line 3301 of file Cube_meat.hpp.
|
static |
postfix ++
Definition at line 3204 of file Cube_meat.hpp.
|
static |
postfix ++ for complex numbers (work around for limitations of the std::complex class)
Definition at line 3229 of file Cube_meat.hpp.
|
static |
prefix –
Definition at line 3240 of file Cube_meat.hpp.
|
static |
prefix – for complex numbers (work around for limitations of the std::complex class)
Definition at line 3265 of file Cube_meat.hpp.
|
static |
prefix ++
Definition at line 3168 of file Cube_meat.hpp.
|
static |
prefix ++ for complex numbers (work around for limitations of the std::complex class)
Definition at line 3193 of file Cube_meat.hpp.
|
inline |
load a cube from a file, without printing any error messages
Definition at line 3001 of file Cube_meat.hpp.
|
inline |
load a cube from a stream, without printing any error messages
Definition at line 3014 of file Cube_meat.hpp.
|
inline |
save the cube to a file, without printing any error messages
Definition at line 2975 of file Cube_meat.hpp.
|
inline |
save the cube to a stream, without printing any error messages
Definition at line 2988 of file Cube_meat.hpp.
Definition at line 2575 of file Cube_meat.hpp.
|
inline |
Definition at line 2595 of file Cube_meat.hpp.
Definition at line 2533 of file Cube_meat.hpp.
|
inline |
Definition at line 2561 of file Cube_meat.hpp.
|
inline |
Definition at line 2609 of file Cube_meat.hpp.
|
inline |
change the cube to have user specified dimensions (data is preserved)
Definition at line 2427 of file Cube_meat.hpp.
|
inline |
change the cube to have user specified dimensions (data is preserved)
Definition at line 2440 of file Cube_meat.hpp.
|
inline |
save the cube to a file
Definition at line 2758 of file Cube_meat.hpp.
|
inline |
save the cube to a stream
Definition at line 2802 of file Cube_meat.hpp.
|
inlinestatic |
Definition at line 3328 of file Cube_meat.hpp.
|
inlinestatic |
Definition at line 3370 of file Cube_meat.hpp.
|
inline |
Definition at line 2635 of file Cube_meat.hpp.
|
inlinestatic |
Definition at line 3311 of file Cube_meat.hpp.
|
inlinestatic |
Definition at line 3338 of file Cube_meat.hpp.
|
inline |
Definition at line 2622 of file Cube_meat.hpp.
|
inline |
change the cube to have user specified dimensions (data is not preserved)
Definition at line 2414 of file Cube_meat.hpp.
remove specified slice
Definition at line 1036 of file Cube_meat.hpp.
|
inline |
remove specified slices
Definition at line 1051 of file Cube_meat.hpp.
| arma_inline Mat< eT > & Cube< eT >::slice | ( | const uword | in_slice | ) |
provide the reference to the matrix representing a single slice
Definition at line 796 of file Cube_meat.hpp.
| arma_inline const Mat< eT > & Cube< eT >::slice | ( | const uword | in_slice | ) | const |
provide the reference to the matrix representing a single slice
Definition at line 815 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT * Cube< eT >::slice_colptr | ( | const uword | in_slice, |
| const uword | in_col | ||
| ) |
returns a pointer to array of eTs used by the specified slice in the cube
Definition at line 2308 of file Cube_meat.hpp.
| arma_inline arma_warn_unused const eT * Cube< eT >::slice_colptr | ( | const uword | in_slice, |
| const uword | in_col | ||
| ) | const |
returns a pointer to array of eTs used by the specified slice in the cube
Definition at line 2320 of file Cube_meat.hpp.
| arma_inline arma_warn_unused eT * Cube< eT >::slice_memptr | ( | const uword | slice | ) |
returns a pointer to array of eTs used by the specified slice in the cube
Definition at line 2284 of file Cube_meat.hpp.
| arma_inline arma_warn_unused const eT * Cube< eT >::slice_memptr | ( | const uword | slice | ) | const |
returns a pointer to array of eTs used by the specified slice in the cube
Definition at line 2296 of file Cube_meat.hpp.
| arma_inline subview_cube< eT > Cube< eT >::slices | ( | const uword | in_slice1, |
| const uword | in_slice2 | ||
| ) |
creation of subview_cube (subcube comprised of specified slices)
Definition at line 834 of file Cube_meat.hpp.
| arma_inline const subview_cube< eT > Cube< eT >::slices | ( | const uword | in_slice1, |
| const uword | in_slice2 | ||
| ) | const |
creation of subview_cube (subcube comprised of specified slices)
Definition at line 855 of file Cube_meat.hpp.
try to steal the memory from a given cube; if memory can't be stolen, copy the given cube
Definition at line 310 of file Cube_meat.hpp.
| arma_inline subview_cube< eT > Cube< eT >::subcube | ( | const uword | in_row1, |
| const uword | in_col1, | ||
| const uword | in_slice1, | ||
| const uword | in_row2, | ||
| const uword | in_col2, | ||
| const uword | in_slice2 | ||
| ) |
creation of subview_cube (generic subcube)
Definition at line 876 of file Cube_meat.hpp.
| arma_inline const subview_cube< eT > Cube< eT >::subcube | ( | const uword | in_row1, |
| const uword | in_col1, | ||
| const uword | in_slice1, | ||
| const uword | in_row2, | ||
| const uword | in_col2, | ||
| const uword | in_slice2 | ||
| ) | const |
creation of subview_cube (generic subcube)
Definition at line 900 of file Cube_meat.hpp.
|
inline |
creation of subview_cube (generic subcube)
Definition at line 924 of file Cube_meat.hpp.
|
inline |
creation of subview_cube (generic subcube)
Definition at line 968 of file Cube_meat.hpp.
Definition at line 2481 of file Cube_meat.hpp.
|
inline |
Definition at line 2493 of file Cube_meat.hpp.
Definition at line 20 of file Cube_meat.hpp.