Dense matrix class. More...

#include <forward_bones.hpp>

Inheritance diagram for Mat< eT >:

[legend]

Classes
class	const_row_iterator

class	fixed

class	row_iterator

Public Types
typedef eT *	col_iterator

typedef const eT *	const_col_iterator

typedef const eT *	const_iterator

typedef eT	elem_type
	the type of elements stored in the matrix More...

typedef eT *	iterator

typedef get_pod_type< eT >::result	pod_type
	if eT is non-complex, pod_type is same as eT. otherwise, pod_type is the underlying type used by std::complex More...

typedef uword	size_type

typedef eT	value_type

Public Member Functions
arma_inline arma_warn_unused eT &	at (const uword i)
	linear element accessor (treats the matrix as a vector); no bounds check. More...

arma_inline arma_warn_unused eT	at (const uword i) const
	linear element accessor (treats the matrix as a vector); no bounds check More...

arma_inline arma_warn_unused eT &	at (const uword in_row, const uword in_col)
	element accessor; no bounds check More...

arma_inline arma_warn_unused eT	at (const uword in_row, const uword in_col) const
	element accessor; no bounds check More...

iterator	begin ()

const_iterator	begin () const

col_iterator	begin_col (const uword col_num)

const_col_iterator	begin_col (const uword col_num) const

row_iterator	begin_row (const uword row_num)

const_row_iterator	begin_row (const uword row_num) const

void	clear ()
	resets this matrix to an empty matrix More...

arma_inline subview_col< eT >	col (const uword col_num)
	creation of subview (column vector) More...

arma_inline const subview_col< eT >	col (const uword col_num) const
	creation of subview (column vector) More...

arma_inline arma_warn_unused eT *	colptr (const uword in_col)
	returns a pointer to array of eTs for a specified column; no bounds check More...

arma_inline arma_warn_unused const eT *	colptr (const uword in_col) const
	returns a pointer to array of eTs for a specified column; no bounds check More...

arma_inline subview< eT >	cols (const uword in_col1, const uword in_col2)
	creation of subview (submatrix comprised of specified column vectors) More...

arma_inline const subview< eT >	cols (const uword in_col1, const uword in_col2) const
	creation of subview (submatrix comprised of specified column vectors) More...

template<typename eT2 >
void	copy_size (const Mat< eT2 > &m)
	change the matrix (without preserving data) to have the same dimensions as the given matrix More...

arma_inline diagview< eT >	diag (const sword in_id=0)
	creation of diagview (diagonal) More...

arma_inline const diagview< eT >	diag (const sword in_id=0) const
	creation of diagview (diagonal) More...

template<typename T1 >
arma_inline subview_elem1< eT, T1 >	elem (const Base< uword, T1 > &a)

template<typename T1 >
arma_inline const subview_elem1< eT, T1 >	elem (const Base< uword, T1 > &a) const

bool	empty () const
	returns true if the matrix has no elements More...

iterator	end ()

const_iterator	end () const

col_iterator	end_col (const uword col_num)

const_col_iterator	end_col (const uword col_num) const

row_iterator	end_row (const uword row_num)

const_row_iterator	end_row (const uword row_num) const

const Mat &	eye ()

const Mat &	eye (const uword in_rows, const uword in_cols)

arma_hot const Mat &	fill (const eT val)
	fill the matrix with the specified value More...

void	impl_print (const std::string &extra_text) const

void	impl_print (std::ostream &user_stream, const std::string &extra_text) const

void	impl_print_trans (const std::string &extra_text) const
	DEPRECATED FUNCTION. More...

void	impl_print_trans (std::ostream &user_stream, const std::string &extra_text) const
	DEPRECATED FUNCTION. More...

void	impl_raw_print (const std::string &extra_text) const

void	impl_raw_print (std::ostream &user_stream, const std::string &extra_text) const

void	impl_raw_print_trans (const std::string &extra_text) const
	DEPRECATED FUNCTION. More...

void	impl_raw_print_trans (std::ostream &user_stream, const std::string &extra_text) const
	DEPRECATED FUNCTION. More...

arma_inline arma_warn_unused bool	in_range (const uword i) const
	returns true if the given index is currently in range More...

arma_inline arma_warn_unused bool	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	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	in_range (const span &row_span, const uword in_col) const

arma_inline arma_warn_unused bool	in_range (const uword in_row, const span &col_span) const

arma_inline arma_warn_unused bool	in_range (const span &row_span, const span &col_span) const

template<typename T1 , typename T2 >
void	init (const Base< typename Mat< eT >::pod_type, T1 > &A, const Base< typename Mat< eT >::pod_type, T2 > &B)
	for constructing a complex matrix out of two non-complex matrices More...

void	insert_cols (const uword col_num, const uword N, const bool set_to_zero=true)

template<typename T1 >
void	insert_cols (const uword col_num, const Base< eT, T1 > &X)

void	insert_rows (const uword row_num, const uword N, const bool set_to_zero=true)

template<typename T1 >
void	insert_rows (const uword row_num, const Base< eT, T1 > &X)

arma_inline arma_warn_unused bool	is_colvec () const
	returns true if the object can be interpreted as a column vector More...

arma_inline arma_warn_unused bool	is_empty () const
	returns true if the matrix has no elements More...

arma_warn_unused bool	is_finite () const
	returns true if all of the elements are finite More...

arma_inline arma_warn_unused bool	is_rowvec () const
	returns true if the object can be interpreted as a row vector More...

arma_inline arma_warn_unused bool	is_square () const
	returns true if the object has the same number of non-zero rows and columnns More...

arma_inline arma_warn_unused bool	is_vec () const
	returns true if the object can be interpreted as a column or row vector More...

bool	load (const std::string name, const file_type type=auto_detect, const bool print_status=true)
	load a matrix from a file More...

bool	load (std::istream &is, const file_type type=auto_detect, const bool print_status=true)
	load a matrix from a stream More...

	Mat ()

	Mat (const uword in_rows, const uword in_cols)
	construct the matrix to have user specified dimensions More...

	Mat (const char *text)
	create the matrix from a textual description More...

	Mat (const std::string &text)
	create the matrix from a textual description More...

	Mat (eT *aux_mem, const uword aux_n_rows, const uword aux_n_cols, const bool copy_aux_mem=true, const bool strict=true)

	Mat (const eT *aux_mem, const uword aux_n_rows, const uword aux_n_cols)

	Mat (const Mat &m)
	construct a matrix from a given matrix More...

template<typename T1 >
	Mat (const BaseCube< eT, T1 > &X)

template<typename T1 , typename T2 >
	Mat (const Base< pod_type, T1 > &A, const Base< pod_type, T2 > &B)

	Mat (const subview< eT > &X)
	construct a matrix from subview (e.g. construct a matrix from a delayed submatrix operation) More...

	Mat (const subview_cube< eT > &X)
	construct a matrix from a subview_cube instance More...

	Mat (const diagview< eT > &X)
	construct a matrix from diagview (e.g. construct a matrix from a delayed diag operation) More...

template<typename T1 >
	Mat (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
	Mat (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
	Mat (const Op< T1, op_type > &X)
	create a matrix from Op, i.e. run the previously delayed unary operations More...

template<typename T1 , typename eop_type >
	Mat (const eOp< T1, eop_type > &X)
	create a matrix from eOp, i.e. run the previously delayed unary operations More...

template<typename T1 , typename op_type >
	Mat (const mtOp< eT, T1, op_type > &X)
	EXPERIMENTAL. More...

template<typename T1 , typename T2 , typename glue_type >
	Mat (const Glue< T1, T2, glue_type > &X)
	create a matrix from Glue, i.e. run the previously delayed binary operations More...

template<typename T1 , typename T2 , typename eglue_type >
	Mat (const eGlue< T1, T2, eglue_type > &X)
	create a matrix from eGlue, i.e. run the previously delayed binary operations More...

template<typename T1 , typename T2 , typename glue_type >
	Mat (const mtGlue< eT, T1, T2, glue_type > &X)
	EXPERIMENTAL: create a matrix from mtGlue, i.e. run the previously delayed binary operations. More...

template<typename T1 , typename T2 >
	Mat (const Base< typename Mat< eT >::pod_type, T1 > &A, const Base< typename Mat< eT >::pod_type, T2 > &B)
	for constructing a complex matrix out of two non-complex matrices More...

arma_warn_unused eT	max () const

eT	max (uword &index_of_max_val) const

eT	max (uword &row_of_max_val, uword &col_of_max_val) const

arma_inline arma_warn_unused eT *	memptr ()
	returns a pointer to array of eTs used by the matrix More...

arma_inline arma_warn_unused const eT *	memptr () const
	returns a pointer to array of eTs used by the matrix More...

arma_warn_unused eT	min () const

eT	min (uword &index_of_min_val) const

eT	min (uword &row_of_min_val, uword &col_of_min_val) const

const Mat &	ones ()

const Mat &	ones (const uword in_elem)

const Mat &	ones (const uword in_rows, const uword in_cols)

const Mat &	operator%= (const Mat &m)
	in-place element-wise matrix multiplication More...

template<typename T1 >
const Mat &	operator%= (const BaseCube< eT, T1 > &X)

const Mat &	operator%= (const subview< eT > &X)
	in-place element-wise matrix mutiplication (using a submatrix on the right-hand-side) More...

const Mat &	operator%= (const subview_cube< eT > &X)
	in-place element-wise matrix mutiplication (using a single-slice subcube on the right-hand-side) More...

const Mat &	operator%= (const diagview< eT > &X)
	in-place element-wise matrix mutiplication (using a diagview on the right-hand-side) More...

template<typename T1 >
const Mat &	operator%= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat &	operator%= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator%= (const Op< T1, op_type > &X)

template<typename T1 , typename eop_type >
const Mat &	operator%= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator%= (const mtOp< eT, T1, op_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator%= (const Glue< T1, T2, glue_type > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat &	operator%= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator%= (const mtGlue< eT, T1, T2, glue_type > &X)

template<typename T1 >
const Mat< eT > &	operator%= (const BaseCube< eT, T1 > &X)

template<typename T1 >
const Mat< eT > &	operator%= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat< eT > &	operator%= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator%= (const Op< T1, op_type > &X)
	in-place matrix element-wise multiplication, with the right-hand-side operand having delayed operations More...

template<typename T1 , typename eop_type >
const Mat< eT > &	operator%= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator%= (const mtOp< eT, T1, op_type > &X)
	EXPERIMENTAL. More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator%= (const Glue< T1, T2, glue_type > &X)
	in-place matrix element-wise multiplication, with the right-hand-side operands having delayed operations More...

template<typename T1 , typename T2 , typename eglue_type >
const Mat< eT > &	operator%= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator%= (const mtGlue< eT, T1, T2, glue_type > &X)
	EXPERIMENTAL: in-place matrix element-wise multiplication, with the right-hand-side operands having delayed operations. More...

subview_row< eT >	operator() (const uword row_num, const span &col_span)

const subview_row< eT >	operator() (const uword row_num, const span &col_span) const

subview_col< eT >	operator() (const span &row_span, const uword col_num)

const subview_col< eT >	operator() (const span &row_span, const uword col_num) const

subview< eT >	operator() (const span &row_span, const span &col_span)

const subview< eT >	operator() (const span &row_span, const span &col_span) const

arma_inline arma_warn_unused eT &	operator() (const uword i)
	linear element accessor (treats the matrix as a vector); bounds checking not done when ARMA_NO_DEBUG is defined More...

arma_inline arma_warn_unused eT	operator() (const uword i) const
	linear element accessor (treats the matrix as a vector); bounds checking not done when ARMA_NO_DEBUG is defined More...

arma_inline arma_warn_unused eT &	operator() (const uword in_row, const uword in_col)
	element accessor; bounds checking not done when ARMA_NO_DEBUG is defined More...

arma_inline arma_warn_unused eT	operator() (const uword in_row, const uword in_col) const
	element accessor; bounds checking not done when ARMA_NO_DEBUG is defined More...

arma_inline const Mat &	operator*= (const eT val)
	In-place multiplication of all elements of the matrix with a scalar. More...

const Mat &	operator*= (const Mat &m)
	in-place matrix multiplication More...

template<typename T1 >
const Mat &	operator*= (const BaseCube< eT, T1 > &X)

const Mat &	operator*= (const subview< eT > &X)
	in-place matrix mutiplication (using a submatrix on the right-hand-side) More...

const Mat &	operator*= (const subview_cube< eT > &X)
	in-place matrix mutiplication (using a single-slice subcube on the right-hand-side) More...

const Mat &	operator*= (const diagview< eT > &X)
	in-place matrix mutiplication (using a diagview on the right-hand-side) More...

template<typename T1 >
const Mat &	operator*= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat &	operator*= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator*= (const Op< T1, op_type > &X)

template<typename T1 , typename eop_type >
const Mat &	operator*= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator*= (const mtOp< eT, T1, op_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator*= (const Glue< T1, T2, glue_type > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat &	operator*= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator*= (const mtGlue< eT, T1, T2, glue_type > &X)

template<typename T1 >
const Mat< eT > &	operator*= (const BaseCube< eT, T1 > &X)

template<typename T1 >
const Mat< eT > &	operator*= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat< eT > &	operator*= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator*= (const Op< T1, op_type > &X)
	in-place matrix multiplication, with the right-hand-side operand having delayed operations More...

template<typename T1 , typename eop_type >
const Mat< eT > &	operator*= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator*= (const mtOp< eT, T1, op_type > &X)
	EXPERIMENTAL. More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator*= (const Glue< T1, T2, glue_type > &X)
	in-place matrix multiplications, with the right-hand-side operands having delayed operations More...

template<typename T1 , typename T2 , typename eglue_type >
const Mat< eT > &	operator*= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator*= (const mtGlue< eT, T1, T2, glue_type > &X)
	EXPERIMENTAL: in-place matrix multiplications, with the right-hand-side operands having delayed operations. More...

arma_inline const Mat &	operator++ ()
	prefix ++ More...

arma_inline void	operator++ (int)
	postfix ++ (must not return the object by reference) More...

arma_inline const Mat &	operator+= (const eT val)
	In-place addition of a scalar to all elements of the matrix. More...

const Mat &	operator+= (const Mat &m)
	in-place matrix addition More...

template<typename T1 >
const Mat &	operator+= (const BaseCube< eT, T1 > &X)

const Mat &	operator+= (const subview< eT > &X)
	in-place matrix addition (using a submatrix on the right-hand-side) More...

const Mat &	operator+= (const subview_cube< eT > &X)
	in-place matrix addition (using a single-slice subcube on the right-hand-side) More...

const Mat &	operator+= (const diagview< eT > &X)
	in-place matrix addition (using a diagview on the right-hand-side) More...

template<typename T1 >
const Mat &	operator+= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat &	operator+= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator+= (const Op< T1, op_type > &X)

template<typename T1 , typename eop_type >
const Mat &	operator+= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator+= (const mtOp< eT, T1, op_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator+= (const Glue< T1, T2, glue_type > &X)

template<typename T1 , typename T2 >
const Mat &	operator+= (const Glue< T1, T2, glue_times > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat &	operator+= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator+= (const mtGlue< eT, T1, T2, glue_type > &X)

template<typename T1 >
const Mat< eT > &	operator+= (const BaseCube< eT, T1 > &X)

template<typename T1 >
const Mat< eT > &	operator+= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat< eT > &	operator+= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator+= (const Op< T1, op_type > &X)
	in-place matrix addition, with the right-hand-side operand having delayed operations More...

template<typename T1 , typename eop_type >
const Mat< eT > &	operator+= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator+= (const mtOp< eT, T1, op_type > &X)
	EXPERIMENTAL. More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator+= (const Glue< T1, T2, glue_type > &X)
	in-place matrix addition, with the right-hand-side operands having delayed operations More...

template<typename T1 , typename T2 >
const Mat< eT > &	operator+= (const Glue< T1, T2, glue_times > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat< eT > &	operator+= (const eGlue< T1, T2, eglue_type > &X)
	in-place matrix addition, with the right-hand-side operands having delayed operations More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator+= (const mtGlue< eT, T1, T2, glue_type > &X)
	EXPERIMENTAL: in-place matrix addition, with the right-hand-side operands having delayed operations. More...

arma_inline const Mat &	operator-- ()
	prefix – More...

arma_inline void	operator-- (int)
	postfix – (must not return the object by reference) More...

arma_inline const Mat &	operator-= (const eT val)
	In-place subtraction of a scalar from all elements of the matrix. More...

const Mat &	operator-= (const Mat &m)
	in-place matrix subtraction More...

template<typename T1 >
const Mat &	operator-= (const BaseCube< eT, T1 > &X)

const Mat &	operator-= (const subview< eT > &X)
	in-place matrix subtraction (using a submatrix on the right-hand-side) More...

const Mat &	operator-= (const subview_cube< eT > &X)
	in-place matrix subtraction (using a single-slice subcube on the right-hand-side) More...

const Mat &	operator-= (const diagview< eT > &X)
	in-place matrix subtraction (using a diagview on the right-hand-side) More...

template<typename T1 >
const Mat &	operator-= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat &	operator-= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator-= (const Op< T1, op_type > &X)

template<typename T1 , typename eop_type >
const Mat &	operator-= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator-= (const mtOp< eT, T1, op_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator-= (const Glue< T1, T2, glue_type > &X)

template<typename T1 , typename T2 >
const Mat &	operator-= (const Glue< T1, T2, glue_times > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat &	operator-= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator-= (const mtGlue< eT, T1, T2, glue_type > &X)

template<typename T1 >
const Mat< eT > &	operator-= (const BaseCube< eT, T1 > &X)

template<typename T1 >
const Mat< eT > &	operator-= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat< eT > &	operator-= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator-= (const Op< T1, op_type > &X)
	in-place matrix subtraction, with the right-hand-side operand having delayed operations More...

template<typename T1 , typename eop_type >
const Mat< eT > &	operator-= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator-= (const mtOp< eT, T1, op_type > &X)
	EXPERIMENTAL. More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator-= (const Glue< T1, T2, glue_type > &X)
	in-place matrix subtraction, with the right-hand-side operands having delayed operations More...

template<typename T1 , typename T2 >
const Mat< eT > &	operator-= (const Glue< T1, T2, glue_times > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat< eT > &	operator-= (const eGlue< T1, T2, eglue_type > &X)
	in-place matrix subtraction, with the right-hand-side operands having delayed operations More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator-= (const mtGlue< eT, T1, T2, glue_type > &X)
	EXPERIMENTAL: in-place matrix subtraction, with the right-hand-side operands having delayed operations. More...

arma_inline const Mat &	operator/= (const eT val)
	In-place division of all elements of the matrix with a scalar. More...

const Mat &	operator/= (const Mat &m)
	in-place element-wise matrix division More...

template<typename T1 >
const Mat &	operator/= (const BaseCube< eT, T1 > &X)

const Mat &	operator/= (const subview< eT > &X)
	in-place element-wise matrix division (using a submatrix on the right-hand-side) More...

const Mat &	operator/= (const subview_cube< eT > &X)
	in-place element-wise matrix division (using a single-slice subcube on the right-hand-side) More...

const Mat &	operator/= (const diagview< eT > &X)
	in-place element-wise matrix division (using a diagview on the right-hand-side) More...

template<typename T1 >
const Mat &	operator/= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat &	operator/= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator/= (const Op< T1, op_type > &X)

template<typename T1 , typename eop_type >
const Mat &	operator/= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator/= (const mtOp< eT, T1, op_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator/= (const Glue< T1, T2, glue_type > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat &	operator/= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator/= (const mtGlue< eT, T1, T2, glue_type > &X)

template<typename T1 >
const Mat< eT > &	operator/= (const BaseCube< eT, T1 > &X)

template<typename T1 >
const Mat< eT > &	operator/= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat< eT > &	operator/= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator/= (const Op< T1, op_type > &X)
	in-place matrix element-wise division, with the right-hand-side operand having delayed operations More...

template<typename T1 , typename eop_type >
const Mat< eT > &	operator/= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator/= (const mtOp< eT, T1, op_type > &X)
	EXPERIMENTAL. More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator/= (const Glue< T1, T2, glue_type > &X)
	in-place matrix element-wise division, with the right-hand-side operands having delayed operations More...

template<typename T1 , typename T2 , typename eglue_type >
const Mat< eT > &	operator/= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator/= (const mtGlue< eT, T1, T2, glue_type > &X)
	EXPERIMENTAL: in-place matrix element-wise division, with the right-hand-side operands having delayed operations. More...

mat_injector< Mat >	operator<< (const injector_end_of_row &x)

mat_injector< Mat >	operator<< (const eT val)

const Mat &	operator= (const char *text)
	create the matrix from a textual description More...

const Mat &	operator= (const std::string &text)
	create the matrix from a textual description More...

arma_inline const Mat &	operator= (const eT val)

const Mat &	operator= (const Mat &m)
	construct a matrix from a given matrix More...

template<typename T1 >
const Mat &	operator= (const BaseCube< eT, T1 > &X)

const Mat &	operator= (const subview< eT > &X)
	construct a matrix from subview (e.g. construct a matrix from a delayed submatrix operation) More...

const Mat &	operator= (const subview_cube< eT > &X)
	construct a matrix from a subview_cube instance More...

const Mat &	operator= (const diagview< eT > &X)
	construct a matrix from diagview (e.g. construct a matrix from a delayed diag operation) More...

template<typename T1 >
const Mat &	operator= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat &	operator= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator= (const Op< T1, op_type > &X)

template<typename T1 , typename eop_type >
const Mat &	operator= (const eOp< T1, eop_type > &X)

template<typename T1 , typename op_type >
const Mat &	operator= (const mtOp< eT, T1, op_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator= (const Glue< T1, T2, glue_type > &X)

template<typename T1 , typename T2 , typename eglue_type >
const Mat &	operator= (const eGlue< T1, T2, eglue_type > &X)

template<typename T1 , typename T2 , typename glue_type >
const Mat &	operator= (const mtGlue< eT, T1, T2, glue_type > &X)

template<typename T1 >
const Mat< eT > &	operator= (const BaseCube< eT, T1 > &X)

template<typename T1 >
const Mat< eT > &	operator= (const subview_elem1< eT, T1 > &X)

template<typename gen_type >
const Mat< eT > &	operator= (const Gen< eT, gen_type > &X)

template<typename T1 , typename op_type >
const Mat< eT > &	operator= (const Op< T1, op_type > &X)
	create a matrix from Op, i.e. run the previously delayed unary operations More...

template<typename T1 , typename eop_type >
const Mat< eT > &	operator= (const eOp< T1, eop_type > &X)
	create a matrix from eOp, i.e. run the previously delayed unary operations More...

template<typename T1 , typename op_type >
const Mat< eT > &	operator= (const mtOp< eT, T1, op_type > &X)
	EXPERIMENTAL. More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator= (const Glue< T1, T2, glue_type > &X)
	create a matrix from Glue, i.e. run the previously delayed binary operations More...

template<typename T1 , typename T2 , typename eglue_type >
const Mat< eT > &	operator= (const eGlue< T1, T2, eglue_type > &X)
	create a matrix from eGlue, i.e. run the previously delayed binary operations More...

template<typename T1 , typename T2 , typename glue_type >
const Mat< eT > &	operator= (const mtGlue< eT, T1, T2, glue_type > &X)
	EXPERIMENTAL: create a matrix from Glue, i.e. run the previously delayed binary operations. More...

arma_inline arma_warn_unused eT &	operator[] (const uword i)
	linear element accessor (treats the matrix as a vector); no bounds check. More...

arma_inline arma_warn_unused eT	operator[] (const uword i) const
	linear element accessor (treats the matrix as a vector); no bounds check More...

bool	quiet_load (const std::string name, const file_type type=auto_detect)
	load a matrix from a file, without printing any error messages More...

bool	quiet_load (std::istream &is, const file_type type=auto_detect)
	load a matrix from a stream, without printing any error messages More...

bool	quiet_save (const std::string name, const file_type type=arma_binary) const
	save the matrix to a file, without printing any error messages More...

bool	quiet_save (std::ostream &os, const file_type type=arma_binary) const
	save the matrix to a stream, without printing any error messages More...

const Mat &	randn ()

const Mat &	randn (const uword in_elem)

const Mat &	randn (const uword in_rows, const uword in_cols)

const Mat &	randu ()

const Mat &	randu (const uword in_elem)

const Mat &	randu (const uword in_rows, const uword in_cols)

void	reset ()

void	reshape (const uword in_rows, const uword in_cols, const uword dim=0)
	change the matrix to have user specified dimensions (data is preserved) More...

void	resize (const uword in_elem)
	change the matrix to have user specified dimensions (data is preserved) More...

void	resize (const uword in_rows, const uword in_cols)
	change the matrix to have user specified dimensions (data is preserved) More...

arma_inline subview_row< eT >	row (const uword row_num)
	creation of subview (row vector) More...

arma_inline const subview_row< eT >	row (const uword row_num) const
	creation of subview (row vector) More...

arma_inline subview< eT >	rows (const uword in_row1, const uword in_row2)
	creation of subview (submatrix comprised of specified row vectors) More...

arma_inline const subview< eT >	rows (const uword in_row1, const uword in_row2) const
	creation of subview (submatrix comprised of specified row vectors) More...

bool	save (const std::string name, const file_type type=arma_binary, const bool print_status=true) const
	save the matrix to a file More...

bool	save (std::ostream &os, const file_type type=arma_binary, const bool print_status=true) const
	save the matrix to a stream More...

template<typename T1 >
void	set_imag (const Base< pod_type, T1 > &X)

template<typename T1 >
void	set_imag (const Base< typename Mat< eT >::pod_type, T1 > &X)

template<typename T1 >
void	set_real (const Base< pod_type, T1 > &X)

template<typename T1 >
void	set_real (const Base< typename Mat< eT >::pod_type, T1 > &X)

void	set_size (const uword in_elem)
	change the matrix to have user specified dimensions (data is not preserved) More...

void	set_size (const uword in_rows, const uword in_cols)
	change the matrix to have user specified dimensions (data is not preserved) More...

void	shed_col (const uword col_num)
	remove specified column More...

void	shed_cols (const uword in_col1, const uword in_col2)
	remove specified columns More...

void	shed_row (const uword row_num)
	remove specified row More...

void	shed_rows (const uword in_row1, const uword in_row2)
	remove specified rows More...

uword	size () const
	returns the number of elements in this matrix More...

arma_inline subview< eT >	submat (const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2)
	creation of subview (submatrix) More...

arma_inline const subview< eT >	submat (const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const
	creation of subview (generic submatrix) More...

subview< eT >	submat (const span &row_span, const span &col_span)
	creation of subview (submatrix) More...

const subview< eT >	submat (const span &row_span, const span &col_span) const
	creation of subview (generic submatrix) More...

void	swap_cols (const uword in_col1, const uword in_col2)

void	swap_rows (const uword in_row1, const uword in_row2)

Col< eT >	unsafe_col (const uword col_num)

const Col< eT >	unsafe_col (const uword col_num) const

const Mat &	zeros ()

const Mat &	zeros (const uword in_elem)

const Mat &	zeros (const uword in_rows, const uword in_cols)

	~Mat ()

Public Member Functions inherited from Base< eT, Mat< eT > >
arma_inline const Mat< eT > &	get_ref () const

void	print (const std::string extra_text="") const

void	print (std::ostream &user_stream, const std::string extra_text="") const

arma_deprecated void	print_trans (const std::string extra_text="") const

arma_deprecated void	print_trans (std::ostream &user_stream, const std::string extra_text="") const

void	raw_print (const std::string extra_text="") const

void	raw_print (std::ostream &user_stream, const std::string extra_text="") const

arma_deprecated void	raw_print_trans (const std::string extra_text="") const

arma_deprecated void	raw_print_trans (std::ostream &user_stream, const std::string extra_text="") const

arma_inline const Op< Mat< eT >, op_strans >	st () const

arma_inline const Op< Mat< eT >, op_htrans >	t () const

Public Attributes
arma_aligned const eT *const	mem
	pointer to the memory used by the matrix (memory is read-only) More...

const uhword	mem_state

const uword	n_cols
	number of columns in the matrix (read-only) More...

const uword	n_elem
	number of elements in the matrix (read-only) More...

const uword	n_rows
	number of rows in the matrix (read-only) More...

const uhword	vec_state
	0: matrix layout; 1: column vector layout; 2: row vector layout More...

Protected Member Functions
void	init (const std::string &text)
	internal function to create the matrix from a textual description More...

template<typename T1 , typename T2 >
void	init (const Base< pod_type, T1 > &A, const Base< pod_type, T2 > &B)

void	init_cold ()

void	init_warm (uword in_rows, uword in_cols)
	internal matrix construction; if the requested size is small enough, memory from the stack is used. otherwise memory is allocated via 'new' More...

	Mat (const char junk, const eT *aux_mem, const uword aux_n_rows, const uword aux_n_cols)

void	steal_mem (Mat &X)

Protected Attributes
arma_aligned eT	mem_local [arma_config::mat_prealloc]

Friends
class	Cube< eT >

class	glue_join

class	op_htrans

class	op_resize

class	op_strans

Detailed Description

template<typename eT>
class Mat< eT >

Dense matrix class.

Definition at line 19 of file forward_bones.hpp.

Member Typedef Documentation

template<typename eT>

typedef eT* Mat< eT >::col_iterator

Definition at line 375 of file Mat_bones.hpp.

template<typename eT>

typedef const eT* Mat< eT >::const_col_iterator

Definition at line 376 of file Mat_bones.hpp.

template<typename eT>

typedef const eT* Mat< eT >::const_iterator

Definition at line 373 of file Mat_bones.hpp.

template<typename eT>

typedef eT Mat< eT >::elem_type

the type of elements stored in the matrix

Definition at line 26 of file Mat_bones.hpp.

template<typename eT>

typedef eT* Mat< eT >::iterator

Definition at line 372 of file Mat_bones.hpp.

template<typename eT>

typedef get_pod_type<eT>::result Mat< eT >::pod_type

if eT is non-complex, pod_type is same as eT. otherwise, pod_type is the underlying type used by std::complex

Definition at line 27 of file Mat_bones.hpp.

template<typename eT>

typedef uword Mat< eT >::size_type

Definition at line 370 of file Mat_bones.hpp.

template<typename eT>

typedef eT Mat< eT >::value_type

Definition at line 369 of file Mat_bones.hpp.

Constructor & Destructor Documentation

template<typename eT>

template<typename T1 , typename T2 >

Mat< eT >::Mat	(	const Base< pod_type, T1 > &	A,
		const Base< pod_type, T2 > &	B
	)

inlineexplicit

Member Function Documentation

template<typename eT>

template<typename T1 , typename T2 >

void Mat< eT >::init	(	const Base< pod_type, T1 > &	A,
		const Base< pod_type, T2 > &	B
	)

inlineprotected

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator%= ( const BaseCube< eT, T1 > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator%= ( const subview_elem1< eT, T1 > & X )

inline

template<typename eT>

template<typename gen_type >

const Mat& Mat< eT >::operator%= ( const Gen< eT, gen_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator%= ( const Op< T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename eop_type >

const Mat& Mat< eT >::operator%= ( const eOp< T1, eop_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator%= ( const mtOp< eT, T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator%= ( const Glue< T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename eglue_type >

const Mat& Mat< eT >::operator%= ( const eGlue< T1, T2, eglue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator%= ( const mtGlue< eT, T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator*= ( const BaseCube< eT, T1 > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator*= ( const subview_elem1< eT, T1 > & X )

inline

template<typename eT>

template<typename gen_type >

const Mat& Mat< eT >::operator*= ( const Gen< eT, gen_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator*= ( const Op< T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename eop_type >

const Mat& Mat< eT >::operator*= ( const eOp< T1, eop_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator*= ( const mtOp< eT, T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator*= ( const Glue< T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename eglue_type >

const Mat& Mat< eT >::operator*= ( const eGlue< T1, T2, eglue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator*= ( const mtGlue< eT, T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator+= ( const BaseCube< eT, T1 > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator+= ( const subview_elem1< eT, T1 > & X )

inline

template<typename eT>

template<typename gen_type >

const Mat& Mat< eT >::operator+= ( const Gen< eT, gen_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator+= ( const Op< T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename eop_type >

const Mat& Mat< eT >::operator+= ( const eOp< T1, eop_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator+= ( const mtOp< eT, T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator+= ( const Glue< T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 >

const Mat& Mat< eT >::operator+= ( const Glue< T1, T2, glue_times > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename eglue_type >

const Mat& Mat< eT >::operator+= ( const eGlue< T1, T2, eglue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator+= ( const mtGlue< eT, T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator-= ( const BaseCube< eT, T1 > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator-= ( const subview_elem1< eT, T1 > & X )

inline

template<typename eT>

template<typename gen_type >

const Mat& Mat< eT >::operator-= ( const Gen< eT, gen_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator-= ( const Op< T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename eop_type >

const Mat& Mat< eT >::operator-= ( const eOp< T1, eop_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator-= ( const mtOp< eT, T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator-= ( const Glue< T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 >

const Mat& Mat< eT >::operator-= ( const Glue< T1, T2, glue_times > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename eglue_type >

const Mat& Mat< eT >::operator-= ( const eGlue< T1, T2, eglue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator-= ( const mtGlue< eT, T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator/= ( const BaseCube< eT, T1 > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator/= ( const subview_elem1< eT, T1 > & X )

inline

template<typename eT>

template<typename gen_type >

const Mat& Mat< eT >::operator/= ( const Gen< eT, gen_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator/= ( const Op< T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename eop_type >

const Mat& Mat< eT >::operator/= ( const eOp< T1, eop_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator/= ( const mtOp< eT, T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator/= ( const Glue< T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename eglue_type >

const Mat& Mat< eT >::operator/= ( const eGlue< T1, T2, eglue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator/= ( const mtGlue< eT, T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator= ( const BaseCube< eT, T1 > & X )

inline

template<typename eT>

template<typename T1 >

const Mat& Mat< eT >::operator= ( const subview_elem1< eT, T1 > & X )

inline

template<typename eT>

template<typename gen_type >

const Mat& Mat< eT >::operator= ( const Gen< eT, gen_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator= ( const Op< T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename eop_type >

const Mat& Mat< eT >::operator= ( const eOp< T1, eop_type > & X )

inline

template<typename eT>

template<typename T1 , typename op_type >

const Mat& Mat< eT >::operator= ( const mtOp< eT, T1, op_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator= ( const Glue< T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename eglue_type >

const Mat& Mat< eT >::operator= ( const eGlue< T1, T2, eglue_type > & X )

inline

template<typename eT>

template<typename T1 , typename T2 , typename glue_type >

const Mat& Mat< eT >::operator= ( const mtGlue< eT, T1, T2, glue_type > & X )

inline

template<typename eT>

template<typename T1 >

void Mat< eT >::set_imag ( const Base< pod_type, T1 > & X )

inline

template<typename eT>

template<typename T1 >

void Mat< eT >::set_real ( const Base< pod_type, T1 > & X )

inline

Friends And Related Function Documentation

template<typename eT>

friend class Cube< eT >

friend

Definition at line 534 of file Mat_bones.hpp.

template<typename eT>

friend class glue_join

friend

Definition at line 535 of file Mat_bones.hpp.

template<typename eT>

friend class op_htrans

friend

Definition at line 537 of file Mat_bones.hpp.

template<typename eT>

friend class op_resize

friend

Definition at line 538 of file Mat_bones.hpp.

template<typename eT>

friend class op_strans

friend

Definition at line 536 of file Mat_bones.hpp.

Member Data Documentation

template<typename eT>

arma_aligned const eT* const Mat< eT >::mem

pointer to the memory used by the matrix (memory is read-only)

Definition at line 40 of file Mat_bones.hpp.

template<typename eT>

arma_aligned eT Mat< eT >::mem_local[arma_config::mat_prealloc]

protected

Definition at line 43 of file Mat_bones.hpp.

template<typename eT>

const uhword Mat< eT >::mem_state

Definition at line 33 of file Mat_bones.hpp.

template<typename eT>

const uword Mat< eT >::n_cols

number of columns in the matrix (read-only)

Definition at line 30 of file Mat_bones.hpp.

template<typename eT>

const uword Mat< eT >::n_elem

number of elements in the matrix (read-only)

Definition at line 31 of file Mat_bones.hpp.

template<typename eT>

const uword Mat< eT >::n_rows

number of rows in the matrix (read-only)

Definition at line 29 of file Mat_bones.hpp.

template<typename eT>

const uhword Mat< eT >::vec_state

0: matrix layout; 1: column vector layout; 2: row vector layout

Definition at line 32 of file Mat_bones.hpp.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<typename eT> class Mat< eT >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename eT>
class Mat< eT >