shark::blas::matrix_set< element_type > Class Template Reference

#include <shark/LinAlg/BLAS/matrix_set.hpp>

+ Inheritance diagram for shark::blas::matrix_set< element_type >:

Public Types

typedef array_type::const_reference const_reference
 
typedef array_type::reference reference
 
typedef value_type const * const_pointer
 
typedef value_type * pointer
 
typedef element_type::const_index_pointer const_index_pointer
 
typedef element_type::index_pointer index_pointer
 
typedef element_type::storage_category storage_category
 
typedef element_type::orientation orientation
 
typedef array_type::iterator iterator
 
typedef array_type::const_iterator const_iterator
 

Public Member Functions

 matrix_set ()
 Default matrix_set constructor. Make a dense matrix_set of size (0,0) More...
 
 matrix_set (size_type size)
 
 matrix_set (size_type size, value_type const &init)
 
template<class E >
 matrix_set (matrix_set_expression< E > const &e)
 
 matrix_set (size_type size, size_type size1, size_type size2)
 
size_type size () const
 Returns the number of matrices in the set. More...
 
size_type size1 () const
 Returns the first dimension of the matrices in the set. More...
 
size_type size2 () const
 Returns the second dimension of the matrices in the set. More...
 
void resize (size_type size)
 
const_reference operator() (index_type i) const
 Return a const reference to the element \(i\). More...
 
reference operator() (index_type i)
 Return a reference to the element \(i\). More...
 
const_reference operator[] (index_type i) const
 Return a const reference to the element \(i\). More...
 
reference operator[] (index_type i)
 Return a reference to the element \(i\). More...
 
reference front ()
 Returns the first element of the vector. More...
 
const_reference front () const
 Returns the first element of the vector. More...
 
reference back ()
 Returns the last element of the vector. More...
 
const_reference back () const
 Returns the last element of the vector. More...
 
const_iterator cbegin () const
 return a const iterator on the first element of the vector More...
 
const_iterator cend () const
 return a const iterator after the last element of the vector More...
 
const_iterator begin () const
 return an iterator on the first element of the vector More...
 
const_iterator end () const
 return an iterator after the last element of the vector More...
 
iterator begin ()
 Return an iterator on the first element of the vector. More...
 
iterator end ()
 Return an iterator at the end of the vector. More...
 
template<class E >
matrix_setassign (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setplus_assign (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setminus_assign (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setmultiply_assign (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setdivide_assign (matrix_set_expression< E > const &e)
 
matrix_setoperator= (matrix_set m)
 
template<class E >
matrix_setoperator= (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setoperator+= (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setoperator-= (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setoperator*= (matrix_set_expression< E > const &e)
 
template<class E >
matrix_setoperator/= (matrix_set_expression< E > const &e)
 
matrix_setoperator*= (scalar_type t)
 
matrix_setoperator/= (scalar_type t)
 
void swap (matrix_set &m)
 
void clear ()
 
template<class Archive >
void serialize (Archive &ar, const unsigned int)
 

Detailed Description

template<class element_type>
class shark::blas::matrix_set< element_type >

Definition at line 39 of file matrix_set.hpp.

Member Typedef Documentation

§ const_index_pointer

template<class element_type>
typedef element_type::const_index_pointer shark::blas::matrix_set< element_type >::const_index_pointer

Definition at line 55 of file matrix_set.hpp.

§ const_iterator

template<class element_type>
typedef array_type::const_iterator shark::blas::matrix_set< element_type >::const_iterator

Definition at line 161 of file matrix_set.hpp.

§ const_pointer

template<class element_type>
typedef value_type const* shark::blas::matrix_set< element_type >::const_pointer

Definition at line 51 of file matrix_set.hpp.

§ const_reference

template<class element_type>
typedef array_type::const_reference shark::blas::matrix_set< element_type >::const_reference

Definition at line 49 of file matrix_set.hpp.

§ index_pointer

template<class element_type>
typedef element_type::index_pointer shark::blas::matrix_set< element_type >::index_pointer

Definition at line 56 of file matrix_set.hpp.

§ iterator

template<class element_type>
typedef array_type::iterator shark::blas::matrix_set< element_type >::iterator

Definition at line 160 of file matrix_set.hpp.

§ orientation

template<class element_type>
typedef element_type::orientation shark::blas::matrix_set< element_type >::orientation

Definition at line 61 of file matrix_set.hpp.

§ pointer

template<class element_type>
typedef value_type* shark::blas::matrix_set< element_type >::pointer

Definition at line 52 of file matrix_set.hpp.

§ reference

template<class element_type>
typedef array_type::reference shark::blas::matrix_set< element_type >::reference

Definition at line 50 of file matrix_set.hpp.

§ storage_category

template<class element_type>
typedef element_type::storage_category shark::blas::matrix_set< element_type >::storage_category

Definition at line 60 of file matrix_set.hpp.

Constructor & Destructor Documentation

§ matrix_set() [1/5]

template<class element_type>
shark::blas::matrix_set< element_type >::matrix_set ( )
inline

Default matrix_set constructor. Make a dense matrix_set of size (0,0)

Definition at line 66 of file matrix_set.hpp.

§ matrix_set() [2/5]

template<class element_type>
shark::blas::matrix_set< element_type >::matrix_set ( size_type  size)
inline

matrix_set constructor with defined size

Parameters
sizenumber of element matrices

Definition at line 71 of file matrix_set.hpp.

§ matrix_set() [3/5]

template<class element_type>
shark::blas::matrix_set< element_type >::matrix_set ( size_type  size,
value_type const &  init 
)
inline

matrix_set constructor with defined size

Parameters
sizenumber of element matrices
initinitial value for matrices

Definition at line 77 of file matrix_set.hpp.

§ matrix_set() [4/5]

template<class element_type>
template<class E >
shark::blas::matrix_set< element_type >::matrix_set ( matrix_set_expression< E > const &  e)
inline

Copy-constructor of a dense matrix_set from a matrix_set expression

Parameters
eis a matrix_set expression

Definition at line 83 of file matrix_set.hpp.

§ matrix_set() [5/5]

template<class element_type>
shark::blas::matrix_set< element_type >::matrix_set ( size_type  size,
size_type  size1,
size_type  size2 
)
inline

Definition at line 87 of file matrix_set.hpp.

Member Function Documentation

§ assign()

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::assign ( matrix_set_expression< E > const &  e)
inline

Definition at line 196 of file matrix_set.hpp.

Referenced by shark::blas::matrix_set< RealMatrix >::matrix_set().

§ back() [1/2]

template<class element_type>
reference shark::blas::matrix_set< element_type >::back ( )
inline

Returns the last element of the vector.

Definition at line 149 of file matrix_set.hpp.

§ back() [2/2]

template<class element_type>
const_reference shark::blas::matrix_set< element_type >::back ( ) const
inline

Returns the last element of the vector.

Definition at line 153 of file matrix_set.hpp.

§ begin() [1/2]

template<class element_type>
const_iterator shark::blas::matrix_set< element_type >::begin ( ) const
inline

return an iterator on the first element of the vector

Definition at line 174 of file matrix_set.hpp.

§ begin() [2/2]

template<class element_type>
iterator shark::blas::matrix_set< element_type >::begin ( )
inline

Return an iterator on the first element of the vector.

Definition at line 184 of file matrix_set.hpp.

§ cbegin()

template<class element_type>
const_iterator shark::blas::matrix_set< element_type >::cbegin ( ) const
inline

return a const iterator on the first element of the vector

Definition at line 164 of file matrix_set.hpp.

§ cend()

template<class element_type>
const_iterator shark::blas::matrix_set< element_type >::cend ( ) const
inline

return a const iterator after the last element of the vector

Definition at line 169 of file matrix_set.hpp.

§ clear()

template<class element_type>
void shark::blas::matrix_set< element_type >::clear ( )
inline

§ divide_assign()

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::divide_assign ( matrix_set_expression< E > const &  e)
inline

Definition at line 229 of file matrix_set.hpp.

§ end() [1/2]

template<class element_type>
const_iterator shark::blas::matrix_set< element_type >::end ( ) const
inline

return an iterator after the last element of the vector

Definition at line 179 of file matrix_set.hpp.

§ end() [2/2]

template<class element_type>
iterator shark::blas::matrix_set< element_type >::end ( )
inline

Return an iterator at the end of the vector.

Definition at line 189 of file matrix_set.hpp.

§ front() [1/2]

template<class element_type>
reference shark::blas::matrix_set< element_type >::front ( )
inline

Returns the first element of the vector.

Definition at line 141 of file matrix_set.hpp.

§ front() [2/2]

template<class element_type>
const_reference shark::blas::matrix_set< element_type >::front ( ) const
inline

Returns the first element of the vector.

Definition at line 145 of file matrix_set.hpp.

§ minus_assign()

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::minus_assign ( matrix_set_expression< E > const &  e)
inline

Definition at line 212 of file matrix_set.hpp.

§ multiply_assign()

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::multiply_assign ( matrix_set_expression< E > const &  e)
inline

Definition at line 221 of file matrix_set.hpp.

§ operator()() [1/2]

template<class element_type>
const_reference shark::blas::matrix_set< element_type >::operator() ( index_type  i) const
inline

Return a const reference to the element \(i\).

Definition at line 121 of file matrix_set.hpp.

§ operator()() [2/2]

template<class element_type>
reference shark::blas::matrix_set< element_type >::operator() ( index_type  i)
inline

Return a reference to the element \(i\).

Definition at line 126 of file matrix_set.hpp.

§ operator*=() [1/2]

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::operator*= ( matrix_set_expression< E > const &  e)
inline

Definition at line 267 of file matrix_set.hpp.

§ operator*=() [2/2]

template<class element_type>
matrix_set& shark::blas::matrix_set< element_type >::operator*= ( scalar_type  t)
inline

Definition at line 284 of file matrix_set.hpp.

§ operator+=()

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::operator+= ( matrix_set_expression< E > const &  e)
inline

Definition at line 249 of file matrix_set.hpp.

§ operator-=()

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::operator-= ( matrix_set_expression< E > const &  e)
inline

Definition at line 258 of file matrix_set.hpp.

§ operator/=() [1/2]

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::operator/= ( matrix_set_expression< E > const &  e)
inline

Definition at line 276 of file matrix_set.hpp.

§ operator/=() [2/2]

template<class element_type>
matrix_set& shark::blas::matrix_set< element_type >::operator/= ( scalar_type  t)
inline

Definition at line 290 of file matrix_set.hpp.

§ operator=() [1/2]

template<class element_type>
matrix_set& shark::blas::matrix_set< element_type >::operator= ( matrix_set< element_type >  m)
inline
Note
"pass by value" the key idea to enable move semantics

Definition at line 238 of file matrix_set.hpp.

§ operator=() [2/2]

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::operator= ( matrix_set_expression< E > const &  e)
inline

Definition at line 243 of file matrix_set.hpp.

§ operator[]() [1/2]

template<class element_type>
const_reference shark::blas::matrix_set< element_type >::operator[] ( index_type  i) const
inline

Return a const reference to the element \(i\).

Definition at line 131 of file matrix_set.hpp.

§ operator[]() [2/2]

template<class element_type>
reference shark::blas::matrix_set< element_type >::operator[] ( index_type  i)
inline

Return a reference to the element \(i\).

Definition at line 136 of file matrix_set.hpp.

§ plus_assign()

template<class element_type>
template<class E >
matrix_set& shark::blas::matrix_set< element_type >::plus_assign ( matrix_set_expression< E > const &  e)
inline

Definition at line 204 of file matrix_set.hpp.

§ resize()

template<class element_type>
void shark::blas::matrix_set< element_type >::resize ( size_type  size)
inline

Resize a matrix_set to new dimensions. If resizing is performed, the data is not preserved.

Parameters
sizethe new number of elements

Definition at line 112 of file matrix_set.hpp.

§ serialize()

template<class element_type>
template<class Archive >
void shark::blas::matrix_set< element_type >::serialize ( Archive &  ar,
const unsigned  int 
)
inline

Definition at line 312 of file matrix_set.hpp.

§ size()

§ size1()

§ size2()

§ swap()

template<class element_type>
void shark::blas::matrix_set< element_type >::swap ( matrix_set< element_type > &  m)
inline

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