shark::blas::diagonal_matrix< VectorType > Class Template Reference

An diagonal matrix with values stored inside a diagonal vector. More...

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

+ Inheritance diagram for shark::blas::diagonal_matrix< VectorType >:

Classes

class  const_row_iterator
 

Public Types

typedef VectorType::const_reference const_reference
 
typedef VectorType::reference reference
 
typedef VectorType::pointer pointer
 
typedef VectorType::const_pointer const_pointer
 
typedef index_type const * const_index_pointer
 
typedef index_type index_pointer
 
typedef sparse_tag storage_category
 
typedef elementwise_tag evaluation_category
 
typedef row_major orientation
 
typedef const_row_iterator const_column_iterator
 
typedef const_row_iterator row_iterator
 
typedef const_column_iterator column_iterator
 

Public Member Functions

 diagonal_matrix ()
 
 diagonal_matrix (VectorType const &diagonal)
 
size_type size1 () const
 
size_type size2 () const
 
const_reference operator() (index_type i, index_type j) const
 
void set_element (size_type i, size_type j, value_type t)
 
diagonal_matrixoperator= (diagonal_matrix const &m)
 
void swap (diagonal_matrix &m)
 
const_row_iterator row_begin (index_type i) const
 
const_row_iterator row_end (index_type i) const
 
const_column_iterator column_begin (index_type i) const
 
const_column_iterator column_end (index_type i) const
 
- Public Member Functions inherited from shark::blas::matrix_container< diagonal_matrix< VectorType > >
const container_type & operator() () const
 
container_type & operator() ()
 
- Public Member Functions inherited from shark::blas::matrix_expression< E >
const expression_type & operator() () const
 
expression_type & operator() ()
 

Friends

void swap (diagonal_matrix &m1, diagonal_matrix &m2)
 

Detailed Description

template<class VectorType>
class shark::blas::diagonal_matrix< VectorType >

An diagonal matrix with values stored inside a diagonal vector.

the matrix stores a Vector representing the diagonal.

Definition at line 345 of file matrix.hpp.

Member Typedef Documentation

§ column_iterator

Definition at line 459 of file matrix.hpp.

§ const_column_iterator

Definition at line 457 of file matrix.hpp.

§ const_index_pointer

template<class VectorType>
typedef index_type const* shark::blas::diagonal_matrix< VectorType >::const_index_pointer

Definition at line 358 of file matrix.hpp.

§ const_pointer

template<class VectorType>
typedef VectorType::const_pointer shark::blas::diagonal_matrix< VectorType >::const_pointer

Definition at line 355 of file matrix.hpp.

§ const_reference

template<class VectorType>
typedef VectorType::const_reference shark::blas::diagonal_matrix< VectorType >::const_reference

Definition at line 352 of file matrix.hpp.

§ evaluation_category

template<class VectorType>
typedef elementwise_tag shark::blas::diagonal_matrix< VectorType >::evaluation_category

Definition at line 364 of file matrix.hpp.

§ index_pointer

template<class VectorType>
typedef index_type shark::blas::diagonal_matrix< VectorType >::index_pointer

Definition at line 359 of file matrix.hpp.

§ orientation

template<class VectorType>
typedef row_major shark::blas::diagonal_matrix< VectorType >::orientation

Definition at line 365 of file matrix.hpp.

§ pointer

template<class VectorType>
typedef VectorType::pointer shark::blas::diagonal_matrix< VectorType >::pointer

Definition at line 354 of file matrix.hpp.

§ reference

template<class VectorType>
typedef VectorType::reference shark::blas::diagonal_matrix< VectorType >::reference

Definition at line 353 of file matrix.hpp.

§ row_iterator

Definition at line 458 of file matrix.hpp.

§ storage_category

template<class VectorType>
typedef sparse_tag shark::blas::diagonal_matrix< VectorType >::storage_category

Definition at line 363 of file matrix.hpp.

Constructor & Destructor Documentation

§ diagonal_matrix() [1/2]

template<class VectorType>
shark::blas::diagonal_matrix< VectorType >::diagonal_matrix ( )
inline

Definition at line 368 of file matrix.hpp.

§ diagonal_matrix() [2/2]

template<class VectorType>
shark::blas::diagonal_matrix< VectorType >::diagonal_matrix ( VectorType const &  diagonal)
inline

Definition at line 369 of file matrix.hpp.

Member Function Documentation

§ column_begin()

template<class VectorType>
const_column_iterator shark::blas::diagonal_matrix< VectorType >::column_begin ( index_type  i) const
inline

Definition at line 468 of file matrix.hpp.

§ column_end()

template<class VectorType>
const_column_iterator shark::blas::diagonal_matrix< VectorType >::column_end ( index_type  i) const
inline

Definition at line 471 of file matrix.hpp.

§ operator()()

template<class VectorType>
const_reference shark::blas::diagonal_matrix< VectorType >::operator() ( index_type  i,
index_type  j 
) const
inline

Definition at line 380 of file matrix.hpp.

§ operator=()

template<class VectorType>
diagonal_matrix& shark::blas::diagonal_matrix< VectorType >::operator= ( diagonal_matrix< VectorType > const &  m)
inline

Definition at line 393 of file matrix.hpp.

§ row_begin()

template<class VectorType>
const_row_iterator shark::blas::diagonal_matrix< VectorType >::row_begin ( index_type  i) const
inline

Definition at line 462 of file matrix.hpp.

§ row_end()

template<class VectorType>
const_row_iterator shark::blas::diagonal_matrix< VectorType >::row_end ( index_type  i) const
inline

Definition at line 465 of file matrix.hpp.

§ set_element()

template<class VectorType>
void shark::blas::diagonal_matrix< VectorType >::set_element ( size_type  i,
size_type  j,
value_type  t 
)
inline

Definition at line 387 of file matrix.hpp.

§ size1()

template<class VectorType>
size_type shark::blas::diagonal_matrix< VectorType >::size1 ( ) const
inline

Definition at line 372 of file matrix.hpp.

§ size2()

template<class VectorType>
size_type shark::blas::diagonal_matrix< VectorType >::size2 ( ) const
inline

Definition at line 375 of file matrix.hpp.

§ swap()

template<class VectorType>
void shark::blas::diagonal_matrix< VectorType >::swap ( diagonal_matrix< VectorType > &  m)
inline

Definition at line 399 of file matrix.hpp.

Friends And Related Function Documentation

§ swap

template<class VectorType>
void swap ( diagonal_matrix< VectorType > &  m1,
diagonal_matrix< VectorType > &  m2 
)
friend

Definition at line 402 of file matrix.hpp.


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