Go to the documentation of this file.
3 #ifndef DUNE_ISTL_SCALEDIDMATRIX_HH
4 #define DUNE_ISTL_SCALEDIDMATRIX_HH
16 #include <dune/common/exceptions.hh>
17 #include <dune/common/fmatrix.hh>
18 #include <dune/common/diagonalmatrix.hh>
19 #include <dune/common/ftraits.hh>
26 template<
class K,
int n>
29 typedef DiagonalMatrixWrapper< ScaledIdentityMatrix<K,n> > WrapperType;
84 return (
this==&other);
89 typedef ContainerWrapperIterator<const WrapperType, reference, reference>
Iterator;
100 return Iterator(WrapperType(
this),0);
106 return Iterator(WrapperType(
this),n);
113 return Iterator(WrapperType(
this),n-1);
120 return Iterator(WrapperType(
this),-1);
125 typedef ContainerWrapperIterator<const WrapperType, const_reference, const_reference>
ConstIterator;
207 return p_==other.
scalar();
213 return p_!=other.
scalar();
219 template<
class X,
class Y>
220 void mv (
const X& x, Y& y)
const
222 #ifdef DUNE_FMatrix_WITH_CHECKING
223 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
224 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
231 template<
class X,
class Y>
232 void mtv (
const X& x, Y& y)
const
238 template<
class X,
class Y>
239 void umv (
const X& x, Y& y)
const
241 #ifdef DUNE_FMatrix_WITH_CHECKING
242 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
243 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
250 template<
class X,
class Y>
251 void umtv (
const X& x, Y& y)
const
253 #ifdef DUNE_FMatrix_WITH_CHECKING
254 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
255 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
262 template<
class X,
class Y>
263 void umhv (
const X& x, Y& y)
const
265 #ifdef DUNE_FMatrix_WITH_CHECKING
266 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
267 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
270 y[i] += conjugateComplex(p_)*x[i];
274 template<
class X,
class Y>
275 void mmv (
const X& x, Y& y)
const
277 #ifdef DUNE_FMatrix_WITH_CHECKING
278 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
279 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
286 template<
class X,
class Y>
287 void mmtv (
const X& x, Y& y)
const
289 #ifdef DUNE_FMatrix_WITH_CHECKING
290 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
291 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
298 template<
class X,
class Y>
299 void mmhv (
const X& x, Y& y)
const
301 #ifdef DUNE_FMatrix_WITH_CHECKING
302 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
303 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
306 y[i] -= conjugateComplex(p_)*x[i];
310 template<
class X,
class Y>
311 void usmv (
const K& alpha,
const X& x, Y& y)
const
313 #ifdef DUNE_FMatrix_WITH_CHECKING
314 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
315 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
318 y[i] += alpha * p_ * x[i];
322 template<
class X,
class Y>
323 void usmtv (
const K& alpha,
const X& x, Y& y)
const
325 #ifdef DUNE_FMatrix_WITH_CHECKING
326 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
327 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
330 y[i] += alpha * p_ * x[i];
334 template<
class X,
class Y>
335 void usmhv (
const K& alpha,
const X& x, Y& y)
const
337 #ifdef DUNE_FMatrix_WITH_CHECKING
338 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
339 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
342 y[i] += alpha * conjugateComplex(p_) * x[i];
350 return fvmeta::sqrt(n*p_*p_);
368 return fvmeta::absreal(p_);
378 for (
int i=0; i<n; i++)
391 return std::pow(p_,n);
413 #ifdef DUNE_FMatrix_WITH_CHECKING
414 if (i<0 || i>=n) DUNE_THROW(FMatrixError,
"row index out of range");
415 if (j<0 || j>=n) DUNE_THROW(FMatrixError,
"column index out of range");
427 s << ((i==j) ? a.p_ : 0) <<
" ";
436 return reference(
const_cast<K*
>(&p_), i);
477 template <
class DenseMatrix,
class field,
int N>
479 static void apply(DenseMatrix& denseMatrix,
481 assert(denseMatrix.M() == N);
482 assert(denseMatrix.N() == N);
483 denseMatrix = field(0);
484 for (
int i = 0; i < N; ++i)
485 denseMatrix[i][i] = rhs.
scalar();
void mmhv(const X &x, Y &y) const
y -= A^H x
Definition: scaledidmatrix.hh:299
const_row_type const_reference
Definition: scaledidmatrix.hh:53
bool identical(const ScaledIdentityMatrix< K, n > &other) const
Definition: scaledidmatrix.hh:82
ConstIterator begin() const
begin iterator
Definition: scaledidmatrix.hh:134
DiagonalRowVector< K, n > row_type
Each row is implemented by a field vector.
Definition: scaledidmatrix.hh:50
DiagonalRowVectorConst< K, n > const_row_type
Definition: scaledidmatrix.hh:52
void umtv(const X &x, Y &y) const
y += A^T x
Definition: scaledidmatrix.hh:251
Iterator beforeEnd()
Definition: scaledidmatrix.hh:111
ScaledIdentityMatrix & operator+=(const ScaledIdentityMatrix &y)
vector space addition
Definition: scaledidmatrix.hh:162
Iterator RowIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:93
void mtv(const X &x, Y &y) const
y = A^T x
Definition: scaledidmatrix.hh:232
ConstIterator beforeBegin() const
Definition: scaledidmatrix.hh:154
void usmv(const K &alpha, const X &x, Y &y) const
y += alpha A x
Definition: scaledidmatrix.hh:311
reference operator[](size_type i)
Return reference object as row replacement.
Definition: scaledidmatrix.hh:434
Iterator end()
end iterator
Definition: scaledidmatrix.hh:104
ScaledIdentityMatrix(const K &k)
Constructor initializing the whole matrix with a scalar.
Definition: scaledidmatrix.hh:70
const_reference operator[](size_type i) const
Return const_reference object as row replacement.
Definition: scaledidmatrix.hh:440
Iterator beforeBegin()
Definition: scaledidmatrix.hh:118
ConstIterator ConstRowIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:129
ScaledIdentityMatrix & operator=(const K &k)
Definition: scaledidmatrix.hh:75
void mmtv(const X &x, Y &y) const
y -= A^T x
Definition: scaledidmatrix.hh:287
ScaledIdentityMatrix & operator*=(const K &k)
vector space multiplication with scalar
Definition: scaledidmatrix.hh:189
const K & scalar() const
Get const reference to the scalar diagonal value.
Definition: scaledidmatrix.hh:459
A multiple of the identity matrix of static size.
Definition: scaledidmatrix.hh:27
void umv(const X &x, Y &y) const
y += A x
Definition: scaledidmatrix.hh:239
ScaledIdentityMatrix()
Default constructor.
Definition: scaledidmatrix.hh:66
bool exists(size_type i, size_type j) const
return true when (i,j) is in pattern
Definition: scaledidmatrix.hh:411
friend std::ostream & operator<<(std::ostream &s, const ScaledIdentityMatrix< K, n > &a)
Sends the matrix to an output stream.
Definition: scaledidmatrix.hh:423
FieldTraits< field_type >::real_type infinity_norm() const
infinity norm (row sum norm, how to generalize for blocks?)
Definition: scaledidmatrix.hh:360
void umhv(const X &x, Y &y) const
y += A^H x
Definition: scaledidmatrix.hh:263
bool operator!=(const ScaledIdentityMatrix &other) const
incomparison operator
Definition: scaledidmatrix.hh:211
@ cols
The number of columns.
Definition: scaledidmatrix.hh:60
size_type N() const
number of blocks in row direction
Definition: scaledidmatrix.hh:397
row_type::Iterator ColIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:95
FieldTraits< field_type >::real_type frobenius_norm() const
frobenius norm: sqrt(sum over squared values of entries)
Definition: scaledidmatrix.hh:348
void mv(const X &x, Y &y) const
y = A x
Definition: scaledidmatrix.hh:220
ConstIterator beforeEnd() const
Definition: scaledidmatrix.hh:147
ScaledIdentityMatrix & operator/=(const K &k)
vector space division by scalar
Definition: scaledidmatrix.hh:196
K block_type
export the type representing the components
Definition: scaledidmatrix.hh:38
ContainerWrapperIterator< const WrapperType, reference, reference > Iterator
Iterator class for sequential access.
Definition: scaledidmatrix.hh:89
bool operator==(const ScaledIdentityMatrix &other) const
comparison operator
Definition: scaledidmatrix.hh:205
K determinant() const
calculates the determinant of this matrix
Definition: scaledidmatrix.hh:390
Definition: allocator.hh:7
const_row_type::ConstIterator ConstColIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:131
FieldTraits< field_type >::real_type infinity_norm_real() const
simplified infinity norm (uses Manhattan norm for complex values)
Definition: scaledidmatrix.hh:366
K field_type
export the type representing the field
Definition: scaledidmatrix.hh:35
row_type reference
Definition: scaledidmatrix.hh:51
FieldTraits< field_type >::real_type frobenius_norm2() const
square of frobenius norm, need for block recursion
Definition: scaledidmatrix.hh:354
Iterator begin()
begin iterator
Definition: scaledidmatrix.hh:98
@ blocklevel
The number of block levels we contain. This is 1.
Definition: scaledidmatrix.hh:46
ScaledIdentityMatrix & operator-=(const ScaledIdentityMatrix &y)
vector space subtraction
Definition: scaledidmatrix.hh:169
Iterator iterator
typedef for stl compliant access
Definition: scaledidmatrix.hh:91
static void apply(DenseMatrix &denseMatrix, ScaledIdentityMatrix< field, N > const &rhs)
Definition: scaledidmatrix.hh:479
void usmtv(const K &alpha, const X &x, Y &y) const
y += alpha A^T x
Definition: scaledidmatrix.hh:323
K & scalar()
Get reference to the scalar diagonal value.
Definition: scaledidmatrix.hh:466
void solve(V &x, const V &b) const
Solve system A x = b.
Definition: scaledidmatrix.hh:376
@ rows
The number of rows.
Definition: scaledidmatrix.hh:58
ConstIterator end() const
end iterator
Definition: scaledidmatrix.hh:140
std::size_t size_type
The type used for the index access and size operations.
Definition: scaledidmatrix.hh:41
void usmhv(const K &alpha, const X &x, Y &y) const
y += alpha A^H x
Definition: scaledidmatrix.hh:335
void mmv(const X &x, Y &y) const
y -= A x
Definition: scaledidmatrix.hh:275
size_type M() const
number of blocks in column direction
Definition: scaledidmatrix.hh:403
void invert()
Compute inverse.
Definition: scaledidmatrix.hh:384
ContainerWrapperIterator< const WrapperType, const_reference, const_reference > ConstIterator
Iterator class for sequential access.
Definition: scaledidmatrix.hh:125
ConstIterator const_iterator
typedef for stl compliant access
Definition: scaledidmatrix.hh:127
const K & diagonal(size_type) const
Get const reference to diagonal entry.
Definition: scaledidmatrix.hh:446
K & diagonal(size_type)
Get reference to diagonal entry.
Definition: scaledidmatrix.hh:452