dune-common 2.1.1
Public Types | Public Member Functions
Dune::DynamicMatrix< K > Class Template Reference

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

#include <dune/common/dynmatrix.hh>

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

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 DenseIterator
< DenseMatrix, row_type
Iterator
 Iterator class for sequential access.
typedef Iterator iterator
 typedef for stl compliant access
typedef Iterator RowIterator
 rename the iterators for easier access
typedef row_type::Iterator ColIterator
 rename the iterators for easier access
typedef DenseIterator< const
DenseMatrix, const row_type
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 row_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.
void resize (size_type r, size_type c, value_type v=value_type())
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_typeoperator[] (size_type i)
 random access
const row_typeoperator[] (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 rbegin ()
ConstIterator rbegin () const
Iterator beforeEnd ()
ConstIterator beforeEnd () const
Iterator rend ()
ConstIterator rend () const
Iterator beforeBegin ()
ConstIterator beforeBegin () const
DenseMatrixoperator+= (const DenseMatrix &y)
 vector space addition
DenseMatrixoperator-= (const DenseMatrix &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 &y)
 vector space axpy operation (*this += k y)
bool operator== (const DenseMatrix &y) const
 Binary matrix comparison.
bool operator!= (const DenseMatrix &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 field_type &alpha, const X &x, Y &y) const
 y += alpha A x
void usmtv (const field_type &alpha, const X &x, Y &y) const
 y += alpha A^T x
void usmhv (const 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< value_type >
::real_type 
infinity_norm () const
 infinity norm (row sum norm, how to generalize for blocks?)
FieldTraits< value_type >
::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:
Kis the field type (use float, double, complex, etc)

Member Typedef Documentation

export the type representing the components

rename the iterators for easier access

typedef for stl compliant access

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.

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.


Member Function Documentation

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

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

References Dune::DenseMatrix< MAT >::axpy(), and Dune::DenseMatrix< MAT >::rows().

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

References Dune::DenseMatrix< MAT >::rows().

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.

References Dune::DenseMatrix< MAT >::rows().

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

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

end iterator

References Dune::DenseMatrix< MAT >::rows().

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

end iterator

References Dune::DenseMatrix< MAT >::rows().

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

return true when (i,j) is in pattern

References Dune::DenseMatrix< MAT >::cols(), DUNE_THROW, and Dune::DenseMatrix< MAT >::rows().

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

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

References Dune::DenseMatrix< MAT >::rows().

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

square of frobenius norm, need for block recursion

References Dune::DenseMatrix< MAT >::rows().

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

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

References Dune::DenseMatrix< MAT >::rows().

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

simplified infinity norm (uses Manhattan norm for complex values)

References Dune::DenseMatrix< MAT >::rows().

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

Compute inverse.

Exceptions:
FMatrixErrorif 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.

References Dune::DenseMatrix< MAT >::cols(), and Dune::DenseMatrix< MAT >::rows().

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

number of columns

References Dune::DenseMatrix< MAT >::cols().

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]
void Dune::DenseMatrix< DynamicMatrix< K > >::mmtv ( const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::mmv ( const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::mtv ( const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::mv ( const X &  x,
Y &  y 
) const [inline, inherited]
size_type Dune::DenseMatrix< DynamicMatrix< K > >::N ( ) const [inline, inherited]

number of rows

References Dune::DenseMatrix< MAT >::rows().

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

Binary matrix incomparison.

References Dune::DenseMatrix< MAT >::operator==().

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

vector space multiplication with scalar

References Dune::DenseMatrix< MAT >::rows().

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

vector space addition

References Dune::DenseMatrix< MAT >::rows().

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

vector space subtraction

References Dune::DenseMatrix< MAT >::rows().

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

vector space division by scalar

References Dune::DenseMatrix< MAT >::rows().

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

Binary matrix comparison.

References Dune::DenseMatrix< MAT >::rows().

row_type& Dune::DenseMatrix< DynamicMatrix< K > >::operator[] ( size_type  i) [inline, inherited]

random access

const row_type& Dune::DenseMatrix< DynamicMatrix< K > >::operator[] ( size_type  i) const [inline, inherited]
ConstIterator Dune::DenseMatrix< DynamicMatrix< K > >::rbegin ( ) const [inline, inherited]
Deprecated:
This method was renamed to make it distinct from the STL version which returns a reverse iterator. Use the new method beforeEnd instead.
Deprecated:

References Dune::DenseMatrix< MAT >::beforeEnd().

Iterator Dune::DenseMatrix< DynamicMatrix< K > >::rbegin ( ) [inline, inherited]
Deprecated:
This method was renamed to make it distinct from the STL version which returns a reverse iterator. Use the new method beforeEnd instead.
Deprecated:

References Dune::DenseMatrix< MAT >::beforeBegin().

Iterator Dune::DenseMatrix< DynamicMatrix< K > >::rend ( ) [inline, inherited]
Deprecated:
This method was renamed to make it distinct from the STL version which returns a reverse iterator. Use the new method beforeBegin instead.
Deprecated:

References Dune::DenseMatrix< MAT >::beforeBegin().

ConstIterator Dune::DenseMatrix< DynamicMatrix< K > >::rend ( ) const [inline, inherited]
Deprecated:
This method was renamed to make it distinct from the STL version which returns a reverse iterator. Use the new method beforeBegin instead.
Deprecated:

References Dune::DenseMatrix< MAT >::beforeBegin().

template<class K >
void Dune::DynamicMatrix< K >::resize ( size_type  r,
size_type  c,
value_type  v = value_type() 
) [inline]
DynamicMatrix< K > & Dune::DenseMatrix< DynamicMatrix< K > >::rightmultiply ( const DenseMatrix< M2 > &  M) [inline, inherited]

Multiplies M from the right to this matrix.

References Dune::DenseMatrix< MAT >::cols(), and Dune::DenseMatrix< MAT >::rows().

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

number of rows

Referenced by Dune::DynamicMatrix< K >::mat_cols().

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

size method (number of rows)

References Dune::DenseMatrix< MAT >::rows().

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

Solve system A x = b.

Exceptions:
FMatrixErrorif the matrix is singular
void Dune::DenseMatrix< DynamicMatrix< K > >::umhv ( const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::umtv ( const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::umv ( const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::usmhv ( const field_type alpha,
const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::usmtv ( const field_type alpha,
const X &  x,
Y &  y 
) const [inline, inherited]
void Dune::DenseMatrix< DynamicMatrix< K > >::usmv ( const field_type alpha,
const X &  x,
Y &  y 
) const [inline, inherited]

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