Dune::DynamicMatrix< K > Class Template Reference
[Dense Matrix and Vector Template Library]

Construct a matrix with a dynamic size. More...

#include <dune/common/dynmatrix.hh>

Inheritance diagram for Dune::DynamicMatrix< K >:
Dune::DenseMatrix< DynamicMatrix< K > >

List of all members.

Public Types

typedef Base::size_type size_type
 The type used for the index access and size operation.
typedef Base::value_type value_type
 export the type representing the field
typedef Base::row_type row_type
 The type used to represent a row (must fulfill the Dune::DenseVector interface).
enum  
 

We are at the leaf of the block recursion.

More...
typedef Traits::derived_type derived_type
 type of derived matrix class
typedef Traits::value_type field_type
 export the type representing the field
typedef Traits::value_type block_type
 export the type representing the components
typedef Traits::row_reference row_reference
 The type used to represent a reference to a row (usually row_type &).
typedef Traits::const_row_reference const_row_reference
 The type used to represent a reference to a constant row (usually const row_type &).
typedef DenseIterator
< DenseMatrix, row_type,
row_reference
Iterator
 Iterator class for sequential access.
typedef Iterator iterator
 typedef for stl compliant access
typedef Iterator RowIterator
 rename the iterators for easier access
typedef std::remove_reference
< row_reference >
::type::Iterator 
ColIterator
 rename the iterators for easier access
typedef DenseIterator< const
DenseMatrix, const row_type,
const_row_reference
ConstIterator
 Iterator class for sequential access.
typedef ConstIterator const_iterator
 typedef for stl compliant access
typedef ConstIterator ConstRowIterator
 rename the iterators for easier access
typedef std::remove_reference
< const_row_reference >
::type::ConstIterator 
ConstColIterator
 rename the iterators for easier access

Public Member Functions

 DynamicMatrix ()
 Default constructor.
 DynamicMatrix (size_type r, size_type c, value_type v=value_type())
 Constructor initializing the whole matrix with a scalar.
 DynamicMatrix (std::initializer_list< DynamicVector< K >> const &ll)
 Constructor initializing the matrix from a list of vector.
template<class T , typename = std::enable_if_t<!Dune::IsNumber<T>::value && HasDenseMatrixAssigner<DynamicMatrix, T>::value>>
 DynamicMatrix (T const &rhs)
void resize (size_type r, size_type c, value_type v=value_type())
 resize matrix to r × c
template<typename T , typename = std::enable_if_t<!Dune::IsNumber<T>::value>>
DynamicMatrixoperator= (T const &rhs)
template<typename T , typename = std::enable_if_t<Dune::IsNumber<T>::value>>
DynamicMatrixoperator= (T scalar)
size_type mat_rows () const
size_type mat_cols () const
row_typemat_access (size_type i)
const row_typemat_access (size_type i) const
row_reference operator[] (size_type i)
 random access
const_row_reference operator[] (size_type i) const
size_type size () const
 size method (number of rows)
Iterator begin ()
 begin iterator
ConstIterator begin () const
 begin iterator
Iterator end ()
 end iterator
ConstIterator end () const
 end iterator
Iterator beforeEnd ()
ConstIterator beforeEnd () const
Iterator beforeBegin ()
ConstIterator beforeBegin () const
DenseMatrixoperator+= (const DenseMatrix< Other > &y)
 vector space addition
DenseMatrixoperator-= (const DenseMatrix< Other > &y)
 vector space subtraction
DenseMatrixoperator*= (const field_type &k)
 vector space multiplication with scalar
DenseMatrixoperator/= (const field_type &k)
 vector space division by scalar
DenseMatrixaxpy (const field_type &k, const DenseMatrix< Other > &y)
 vector space axpy operation (*this += k y)
bool operator== (const DenseMatrix< Other > &y) const
 Binary matrix comparison.
bool operator!= (const DenseMatrix< Other > &y) const
 Binary matrix incomparison.
void mv (const X &x, Y &y) const
 y = A x
void mtv (const X &x, Y &y) const
 y = A^T x
void umv (const X &x, Y &y) const
 y += A x
void umtv (const X &x, Y &y) const
 y += A^T x
void umhv (const X &x, Y &y) const
 y += A^H x
void mmv (const X &x, Y &y) const
 y -= A x
void mmtv (const X &x, Y &y) const
 y -= A^T x
void mmhv (const X &x, Y &y) const
 y -= A^H x
void usmv (const typename FieldTraits< Y >::field_type &alpha, const X &x, Y &y) const
 y += alpha A x
void usmtv (const typename FieldTraits< Y >::field_type &alpha, const X &x, Y &y) const
 y += alpha A^T x
void usmhv (const typename FieldTraits< Y >::field_type &alpha, const X &x, Y &y) const
 y += alpha A^H x
FieldTraits< value_type >
::real_type 
frobenius_norm () const
 frobenius norm: sqrt(sum over squared values of entries)
FieldTraits< value_type >
::real_type 
frobenius_norm2 () const
 square of frobenius norm, need for block recursion
FieldTraits< vt >::real_type infinity_norm () const
 infinity norm (row sum norm, how to generalize for blocks?)
FieldTraits< vt >::real_type infinity_norm () const
 infinity norm (row sum norm, how to generalize for blocks?)
FieldTraits< vt >::real_type infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values)
FieldTraits< vt >::real_type infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values)
void solve (V &x, const V &b) const
 Solve system A x = b.
void invert ()
 Compute inverse.
field_type determinant () const
 calculates the determinant of this matrix
DynamicMatrix< K > & leftmultiply (const DenseMatrix< M2 > &M)
 Multiplies M from the left to this matrix.
DynamicMatrix< K > & rightmultiply (const DenseMatrix< M2 > &M)
 Multiplies M from the right to this matrix.
size_type N () const
 number of rows
size_type M () const
 number of columns
size_type rows () const
 number of rows
size_type cols () const
 number of columns
bool exists (size_type i, size_type j) const
 return true when (i,j) is in pattern

Detailed Description

template<class K>
class Dune::DynamicMatrix< K >

Construct a matrix with a dynamic size.

Template Parameters:
K is the field type (use float, double, complex, etc)

Member Typedef Documentation

export the type representing the components

typedef std::remove_reference<row_reference>::type::Iterator Dune::DenseMatrix< DynamicMatrix< K > >::ColIterator [inherited]

rename the iterators for easier access

typedef for stl compliant access

The type used to represent a reference to a constant row (usually const row_type &).

typedef std::remove_reference<const_row_reference>::type::ConstIterator Dune::DenseMatrix< DynamicMatrix< K > >::ConstColIterator [inherited]

rename the iterators for easier access

Iterator class for sequential access.

rename the iterators for easier access

type of derived matrix class

export the type representing the field

typedef Iterator Dune::DenseMatrix< DynamicMatrix< K > >::iterator [inherited]

typedef for stl compliant access

Iterator class for sequential access.

The type used to represent a reference to a row (usually row_type &).

template<class K>
typedef Base::row_type Dune::DynamicMatrix< K >::row_type

The type used to represent a row (must fulfill the Dune::DenseVector interface).

Reimplemented from Dune::DenseMatrix< DynamicMatrix< K > >.

typedef Iterator Dune::DenseMatrix< DynamicMatrix< K > >::RowIterator [inherited]

rename the iterators for easier access

template<class K>
typedef Base::size_type Dune::DynamicMatrix< K >::size_type

The type used for the index access and size operation.

Reimplemented from Dune::DenseMatrix< DynamicMatrix< K > >.

template<class K>
typedef Base::value_type Dune::DynamicMatrix< K >::value_type

export the type representing the field

Reimplemented from Dune::DenseMatrix< DynamicMatrix< K > >.


Member Enumeration Documentation

anonymous enum [inherited]

We are at the leaf of the block recursion.


Constructor & Destructor Documentation

template<class K>
Dune::DynamicMatrix< K >::DynamicMatrix (  )  [inline]

Default constructor.

template<class K>
Dune::DynamicMatrix< K >::DynamicMatrix ( size_type  r,
size_type  c,
value_type  v = value_type() 
) [inline]

Constructor initializing the whole matrix with a scalar.

template<class K>
Dune::DynamicMatrix< K >::DynamicMatrix ( std::initializer_list< DynamicVector< K >> const &  ll  )  [inline]

Constructor initializing the matrix from a list of vector.

template<class K>
template<class T , typename = std::enable_if_t<!Dune::IsNumber<T>::value && HasDenseMatrixAssigner<DynamicMatrix, T>::value>>
Dune::DynamicMatrix< K >::DynamicMatrix ( T const &  rhs  )  [inline]

Member Function Documentation

DenseMatrix& Dune::DenseMatrix< DynamicMatrix< K > >::axpy ( const field_type &  k,
const DenseMatrix< Other > &  y 
) [inline, inherited]

vector space axpy operation (*this += k y)

ConstIterator Dune::DenseMatrix< DynamicMatrix< K > >::beforeBegin (  )  const [inline, inherited]
Returns:
an iterator that is positioned before the first entry of the vector.
Iterator Dune::DenseMatrix< DynamicMatrix< K > >::beforeBegin (  )  [inline, inherited]
Returns:
an iterator that is positioned before the first entry of the vector.
ConstIterator Dune::DenseMatrix< DynamicMatrix< K > >::beforeEnd (  )  const [inline, inherited]
Returns:
an iterator that is positioned before the end iterator of the vector. i.e. at the last element
Iterator Dune::DenseMatrix< DynamicMatrix< K > >::beforeEnd (  )  [inline, inherited]
Returns:
an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.
ConstIterator Dune::DenseMatrix< DynamicMatrix< K > >::begin (  )  const [inline, inherited]

begin iterator

Iterator Dune::DenseMatrix< DynamicMatrix< K > >::begin (  )  [inline, inherited]

begin iterator

size_type Dune::DenseMatrix< DynamicMatrix< K > >::cols (  )  const [inline, inherited]

number of columns

field_type Dune::DenseMatrix< DynamicMatrix< K > >::determinant (  )  const [inherited]

calculates the determinant of this matrix

ConstIterator Dune::DenseMatrix< DynamicMatrix< K > >::end (  )  const [inline, inherited]

end iterator

Iterator Dune::DenseMatrix< DynamicMatrix< K > >::end (  )  [inline, inherited]

end iterator

bool Dune::DenseMatrix< DynamicMatrix< K > >::exists ( size_type  i,
size_type  j 
) const [inline, inherited]

return true when (i,j) is in pattern

FieldTraits<value_type>::real_type Dune::DenseMatrix< DynamicMatrix< K > >::frobenius_norm (  )  const [inline, inherited]

frobenius norm: sqrt(sum over squared values of entries)

FieldTraits<value_type>::real_type Dune::DenseMatrix< DynamicMatrix< K > >::frobenius_norm2 (  )  const [inline, inherited]

square of frobenius norm, need for block recursion

FieldTraits<vt>::real_type Dune::DenseMatrix< DynamicMatrix< K > >::infinity_norm (  )  const [inline, inherited]

infinity norm (row sum norm, how to generalize for blocks?)

FieldTraits<vt>::real_type Dune::DenseMatrix< DynamicMatrix< K > >::infinity_norm (  )  const [inline, inherited]

infinity norm (row sum norm, how to generalize for blocks?)

FieldTraits<vt>::real_type Dune::DenseMatrix< DynamicMatrix< K > >::infinity_norm_real (  )  const [inline, inherited]

simplified infinity norm (uses Manhattan norm for complex values)

FieldTraits<vt>::real_type Dune::DenseMatrix< DynamicMatrix< K > >::infinity_norm_real (  )  const [inline, inherited]

simplified infinity norm (uses Manhattan norm for complex values)

void Dune::DenseMatrix< DynamicMatrix< K > >::invert (  )  [inherited]

Compute inverse.

Exceptions:
FMatrixError if the matrix is singular
DynamicMatrix< K > & Dune::DenseMatrix< DynamicMatrix< K > >::leftmultiply ( const DenseMatrix< M2 > &  M  )  [inline, inherited]

Multiplies M from the left to this matrix.

size_type Dune::DenseMatrix< DynamicMatrix< K > >::M (  )  const [inline, inherited]

number of columns

template<class K>
const row_type& Dune::DynamicMatrix< K >::mat_access ( size_type  i  )  const [inline]
template<class K>
row_type& Dune::DynamicMatrix< K >::mat_access ( size_type  i  )  [inline]
template<class K>
size_type Dune::DynamicMatrix< K >::mat_cols (  )  const [inline]
template<class K>
size_type Dune::DynamicMatrix< K >::mat_rows (  )  const [inline]
void Dune::DenseMatrix< DynamicMatrix< K > >::mmhv ( const X &  x,
Y &  y 
) const [inline, inherited]

y -= A^H x

void Dune::DenseMatrix< DynamicMatrix< K > >::mmtv ( const X &  x,
Y &  y 
) const [inline, inherited]

y -= A^T x

void Dune::DenseMatrix< DynamicMatrix< K > >::mmv ( const X &  x,
Y &  y 
) const [inline, inherited]

y -= A x

void Dune::DenseMatrix< DynamicMatrix< K > >::mtv ( const X &  x,
Y &  y 
) const [inline, inherited]

y = A^T x

void Dune::DenseMatrix< DynamicMatrix< K > >::mv ( const X &  x,
Y &  y 
) const [inline, inherited]

y = A x

size_type Dune::DenseMatrix< DynamicMatrix< K > >::N (  )  const [inline, inherited]

number of rows

bool Dune::DenseMatrix< DynamicMatrix< K > >::operator!= ( const DenseMatrix< Other > &  y  )  const [inline, inherited]

Binary matrix incomparison.

DenseMatrix& Dune::DenseMatrix< DynamicMatrix< K > >::operator*= ( const field_type &  k  )  [inline, inherited]

vector space multiplication with scalar

DenseMatrix& Dune::DenseMatrix< DynamicMatrix< K > >::operator+= ( const DenseMatrix< Other > &  y  )  [inline, inherited]

vector space addition

DenseMatrix& Dune::DenseMatrix< DynamicMatrix< K > >::operator-= ( const DenseMatrix< Other > &  y  )  [inline, inherited]

vector space subtraction

DenseMatrix& Dune::DenseMatrix< DynamicMatrix< K > >::operator/= ( const field_type &  k  )  [inline, inherited]

vector space division by scalar

template<class K>
template<typename T , typename = std::enable_if_t<Dune::IsNumber<T>::value>>
DynamicMatrix& Dune::DynamicMatrix< K >::operator= ( scalar  )  [inline]
template<class K>
template<typename T , typename = std::enable_if_t<!Dune::IsNumber<T>::value>>
DynamicMatrix& Dune::DynamicMatrix< K >::operator= ( T const &  rhs  )  [inline]
bool Dune::DenseMatrix< DynamicMatrix< K > >::operator== ( const DenseMatrix< Other > &  y  )  const [inline, inherited]

Binary matrix comparison.

const_row_reference Dune::DenseMatrix< DynamicMatrix< K > >::operator[] ( size_type  i  )  const [inline, inherited]
row_reference Dune::DenseMatrix< DynamicMatrix< K > >::operator[] ( size_type  i  )  [inline, inherited]

random access

template<class K>
void Dune::DynamicMatrix< K >::resize ( size_type  r,
size_type  c,
value_type  v = value_type() 
) [inline]

resize matrix to r × c

Resize the matrix to r × c, using v as the value of all entries.

Warning:
All previous entries are lost, even when the matrix was not actually resized.
Parameters:
r number of rows
c number of columns
v value of matrix entries
DynamicMatrix< K > & Dune::DenseMatrix< DynamicMatrix< K > >::rightmultiply ( const DenseMatrix< M2 > &  M  )  [inline, inherited]

Multiplies M from the right to this matrix.

size_type Dune::DenseMatrix< DynamicMatrix< K > >::rows (  )  const [inline, inherited]

number of rows

size_type Dune::DenseMatrix< DynamicMatrix< K > >::size (  )  const [inline, inherited]

size method (number of rows)

void Dune::DenseMatrix< DynamicMatrix< K > >::solve ( V &  x,
const V &  b 
) const [inline, inherited]

Solve system A x = b.

Exceptions:
FMatrixError if the matrix is singular
void Dune::DenseMatrix< DynamicMatrix< K > >::umhv ( const X &  x,
Y &  y 
) const [inline, inherited]

y += A^H x

void Dune::DenseMatrix< DynamicMatrix< K > >::umtv ( const X &  x,
Y &  y 
) const [inline, inherited]

y += A^T x

void Dune::DenseMatrix< DynamicMatrix< K > >::umv ( const X &  x,
Y &  y 
) const [inline, inherited]

y += A x

void Dune::DenseMatrix< DynamicMatrix< K > >::usmhv ( const typename FieldTraits< Y >::field_type &  alpha,
const X &  x,
Y &  y 
) const [inline, inherited]

y += alpha A^H x

void Dune::DenseMatrix< DynamicMatrix< K > >::usmtv ( const typename FieldTraits< Y >::field_type &  alpha,
const X &  x,
Y &  y 
) const [inline, inherited]

y += alpha A^T x

void Dune::DenseMatrix< DynamicMatrix< K > >::usmv ( const typename FieldTraits< Y >::field_type &  alpha,
const X &  x,
Y &  y 
) const [inline, inherited]

y += alpha A x


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 25 Mar 2018 for dune-common by  doxygen 1.6.1