Dune Core Modules (2.8.0)
A generic dynamic dense matrix. More...
#include <dune/istl/matrix.hh>
Public Types | |
using | field_type = typename Imp::BlockTraits< T >::field_type |
Export the type representing the underlying field. | |
typedef T | block_type |
Export the type representing the components. | |
typedef A | allocator_type |
Export the allocator. | |
typedef MatrixImp::DenseMatrixBase< T, A >::window_type | row_type |
The type implementing a matrix row. | |
typedef A::size_type | size_type |
Type for indices and sizes. | |
typedef MatrixImp::DenseMatrixBase< T, A >::Iterator | RowIterator |
Iterator over the matrix rows. | |
typedef row_type::iterator | ColIterator |
Iterator for the entries of each row. | |
typedef MatrixImp::DenseMatrixBase< T, A >::ConstIterator | ConstRowIterator |
Const iterator over the matrix rows. | |
typedef row_type::const_iterator | ConstColIterator |
Const iterator for the entries of each row. | |
Public Member Functions | |
Matrix () | |
Create empty matrix. | |
Matrix (size_type rows, size_type cols) | |
Create uninitialized matrix of size rows x cols. | |
void | setSize (size_type rows, size_type cols) |
Change the matrix size. More... | |
RowIterator | begin () |
Get iterator to first row. | |
RowIterator | end () |
Get iterator to one beyond last row. | |
RowIterator | beforeEnd () |
RowIterator | beforeBegin () |
ConstRowIterator | begin () const |
Get const iterator to first row. | |
ConstRowIterator | end () const |
Get const iterator to one beyond last row. | |
ConstRowIterator | beforeEnd () const |
ConstRowIterator | beforeBegin () const |
Matrix & | operator= (const field_type &t) |
Assignment from scalar. | |
row_type | operator[] (size_type row) |
The index operator. | |
const row_type | operator[] (size_type row) const |
The const index operator. | |
size_type | N () const |
Return the number of rows. | |
size_type | M () const |
Return the number of columns. | |
Matrix< T > & | operator*= (const field_type &scalar) |
Multiplication with a scalar. | |
Matrix< T > & | operator/= (const field_type &scalar) |
Division by a scalar. | |
Matrix & | operator+= (const Matrix &b) |
Add the entries of another matrix to this one. More... | |
Matrix & | operator-= (const Matrix &b) |
Subtract the entries of another matrix from this one. More... | |
Matrix | transpose () const |
Return the transpose of the matrix. | |
template<class X , class Y > | |
void | mv (const X &x, Y &y) const |
y = A x | |
template<class X , class Y > | |
void | mtv (const X &x, Y &y) const |
y = A^T x | |
template<class X , class Y > | |
void | umv (const X &x, Y &y) const |
y += A x | |
template<class X , class Y > | |
void | mmv (const X &x, Y &y) const |
y -= A x | |
template<class X , class Y > | |
void | usmv (const field_type &alpha, const X &x, Y &y) const |
\( y += \alpha A x \) | |
template<class X , class Y > | |
void | umtv (const X &x, Y &y) const |
y += A^T x | |
template<class X , class Y > | |
void | mmtv (const X &x, Y &y) const |
y -= A^T x | |
template<class X , class Y > | |
void | usmtv (const field_type &alpha, const X &x, Y &y) const |
y += alpha A^T x | |
template<class X , class Y > | |
void | umhv (const X &x, Y &y) const |
y += A^H x | |
template<class X , class Y > | |
void | mmhv (const X &x, Y &y) const |
y -= A^H x | |
template<class X , class Y > | |
void | usmhv (const field_type &alpha, const X &x, Y &y) const |
y += alpha A^H x | |
FieldTraits< field_type >::real_type | frobenius_norm () const |
frobenius norm: sqrt(sum over squared values of entries) | |
FieldTraits< field_type >::real_type | frobenius_norm2 () const |
square of frobenius norm, need for block recursion | |
template<typename ft = field_type, typename std::enable_if<!HasNaN< ft >::value, int >::type = 0> | |
FieldTraits< ft >::real_type | infinity_norm () const |
infinity norm (row sum norm, how to generalize for blocks?) | |
template<typename ft = field_type, typename std::enable_if<!HasNaN< ft >::value, int >::type = 0> | |
FieldTraits< ft >::real_type | infinity_norm_real () const |
simplified infinity norm (uses Manhattan norm for complex values) | |
template<typename ft = field_type, typename std::enable_if< HasNaN< ft >::value, int >::type = 0> | |
FieldTraits< ft >::real_type | infinity_norm () const |
infinity norm (row sum norm, how to generalize for blocks?) | |
template<typename ft = field_type, typename std::enable_if< HasNaN< ft >::value, int >::type = 0> | |
FieldTraits< ft >::real_type | infinity_norm_real () const |
simplified infinity norm (uses Manhattan norm for complex values) | |
bool | exists (size_type i, size_type j) const |
return true if (i,j) is in pattern | |
Static Public Attributes | |
static constexpr auto | blocklevel = blockLevel<T>()+1 |
The number of nesting levels the matrix contains. | |
Protected Attributes | |
MatrixImp::DenseMatrixBase< T, A > | data_ |
Abuse DenseMatrixBase as an engine for a 2d array ISTL-style. | |
size_type | cols_ |
Number of columns of the matrix. More... | |
Detailed Description
class Dune::Matrix< T, A >
A generic dynamic dense matrix.
Member Function Documentation
◆ beforeBegin() [1/2]
|
inline |
- Returns
- an iterator that is positioned before the first row of the matrix.
References Dune::Matrix< T, A >::data_.
◆ beforeBegin() [2/2]
|
inline |
- Returns
- an iterator that is positioned before the first row if the matrix.
References Dune::Matrix< T, A >::data_.
◆ beforeEnd() [1/2]
|
inline |
- Returns
- an iterator that is positioned before the end iterator of the rows, i.e. at the last row.
References Dune::Matrix< T, A >::data_.
◆ beforeEnd() [2/2]
|
inline |
- Returns
- an iterator that is positioned before the end iterator of the rows. i.e. at the last row.
References Dune::Matrix< T, A >::data_.
◆ operator+=()
|
inline |
Add the entries of another matrix to this one.
- Parameters
-
b The matrix to add to this one. Its size has to be the same as the size of this matrix.
References Dune::Matrix< T, A >::data_, DUNE_THROW, Dune::Matrix< T, A >::M(), and Dune::Matrix< T, A >::N().
◆ operator-=()
|
inline |
Subtract the entries of another matrix from this one.
- Parameters
-
b The matrix to subtract from this one. Its size has to be the same as the size of this matrix.
References Dune::Matrix< T, A >::data_, DUNE_THROW, Dune::Matrix< T, A >::M(), and Dune::Matrix< T, A >::N().
◆ setSize()
|
inline |
Change the matrix size.
The way the data is handled is unpredictable.
References Dune::Matrix< T, A >::cols_, and Dune::Matrix< T, A >::data_.
Member Data Documentation
◆ cols_
|
protected |
Number of columns of the matrix.
In general you can extract the same information from the data_ member. However if you want to be able to properly handle 0xn matrices then you need a separate member.
Referenced by Dune::Matrix< T, A >::M(), Dune::Matrix< T, A >::mmhv(), Dune::Matrix< T, A >::mmtv(), Dune::Matrix< T, A >::mmv(), Dune::Matrix< T, A >::mv(), Dune::Matrix< T, A >::setSize(), Dune::Matrix< T, A >::umhv(), Dune::Matrix< T, A >::umtv(), Dune::Matrix< T, A >::umv(), Dune::Matrix< T, A >::usmhv(), Dune::Matrix< T, A >::usmtv(), and Dune::Matrix< T, A >::usmv().
The documentation for this class was generated from the following file:
- dune/istl/matrix.hh