dune-istl  2.5-git
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::MatrixImp::DenseMatrixBase< B, A > Class Template Reference

A Vector of blocks with different blocksizes. More...

#include <dune/istl/matrix.hh>

Inheritance diagram for Dune::MatrixImp::DenseMatrixBase< B, A >:
Inheritance graph

Classes

class  ConstIterator
 ConstIterator class for sequential access. More...
 
class  Iterator
 Iterator class for sequential access. More...
 

Public Types

typedef B::field_type field_type
 export the type representing the field More...
 
typedef A allocator_type
 export the allocator type More...
 
typedef A::size_type size_type
 The size type for the index access. More...
 
typedef BlockVector< B, A > value_type
 Type of the elements of the outer vector, i.e., dynamic vectors of B. More...
 
typedef BlockVector< B, A > block_type
 Same as value_type, here for historical reasons. More...
 
typedef BlockVectorWindow< B, A > window_type
 
typedef window_type reference
 
typedef const window_type const_reference
 
using iterator = Iterator
 Export the iterator type using std naming rules. More...
 
using const_iterator = ConstIterator
 Export the const iterator type using std naming rules. More...
 
typedef base_array_unmanaged< B, A >::iterator Iterator
 make iterators available as types More...
 
typedef base_array_unmanaged< B, A >::const_iterator ConstIterator
 make iterators available as types More...
 
typedef B member_type
 export the type representing the components More...
 

Public Member Functions

 DenseMatrixBase ()
 
 DenseMatrixBase (size_type rows, size_type columns)
 
 DenseMatrixBase (const DenseMatrixBase &a)
 copy constructor, has copy semantics More...
 
 ~DenseMatrixBase ()
 free dynamic memory More...
 
void resize (size_type rows, size_type columns)
 same effect as constructor with same argument More...
 
DenseMatrixBaseoperator= (const DenseMatrixBase &a)
 assignment More...
 
DenseMatrixBaseoperator= (const field_type &k)
 assign from scalar More...
 
reference operator[] (size_type i)
 random access to blocks More...
 
const_reference operator[] (size_type i) const
 same for read only access More...
 
Iterator begin ()
 begin Iterator More...
 
Iterator end ()
 end Iterator More...
 
Iterator beforeEnd ()
 
Iterator beforeBegin () const
 
Iterator find (size_type i)
 random access returning iterator (end if not contained) More...
 
ConstIterator find (size_type i) const
 random access returning iterator (end if not contained) More...
 
ConstIterator begin () const
 begin ConstIterator More...
 
ConstIterator end () const
 end ConstIterator More...
 
ConstIterator beforeEnd () const
 
ConstIterator rend () const
 end ConstIterator More...
 
size_type N () const
 number of blocks in the vector (are of variable size here) More...
 
block_vector_unmanagedoperator+= (const block_vector_unmanaged &y)
 vector space addition More...
 
block_vector_unmanagedoperator-= (const block_vector_unmanaged &y)
 vector space subtraction More...
 
block_vector_unmanagedoperator*= (const field_type &k)
 vector space multiplication with scalar More...
 
block_vector_unmanagedoperator/= (const field_type &k)
 vector space division by scalar More...
 
block_vector_unmanagedaxpy (const field_type &a, const block_vector_unmanaged &y)
 vector space axpy operation More...
 
template<class OtherB , class OtherA >
PromotionTraits< field_type, typename OtherB::field_type >::PromotedType operator* (const block_vector_unmanaged< OtherB, OtherA > &y) const
 indefinite vector dot product $\left (x^T \cdot y \right)$ which corresponds to Petsc's VecTDot More...
 
template<class OtherB , class OtherA >
PromotionTraits< field_type, typename OtherB::field_type >::PromotedType dot (const block_vector_unmanaged< OtherB, OtherA > &y) const
 vector dot product $\left (x^H \cdot y \right)$ which corresponds to Petsc's VecDot More...
 
FieldTraits< field_type >::real_type one_norm () const
 one norm (sum over absolute values of entries) More...
 
FieldTraits< field_type >::real_type one_norm_real () const
 simplified one norm (uses Manhattan norm for complex values) More...
 
FieldTraits< field_type >::real_type two_norm () const
 two norm sqrt(sum over squared values of entries) More...
 
FieldTraits< field_type >::real_type two_norm2 () const
 Square of the two-norm (the sum over the squared values of the entries) More...
 
template<typename ft = field_type, typename std::enable_if<!has_nan< ft >::value, int >::type = 0>
FieldTraits< ft >::real_type infinity_norm () const
 infinity norm (maximum of absolute values of entries) More...
 
template<typename ft = field_type, typename std::enable_if< has_nan< ft >::value, int >::type = 0>
FieldTraits< ft >::real_type infinity_norm () const
 infinity norm (maximum of absolute values of entries) More...
 
template<typename ft = field_type, typename std::enable_if<!has_nan< ft >::value, int >::type = 0>
FieldTraits< ft >::real_type infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values) More...
 
template<typename ft = field_type, typename std::enable_if< has_nan< ft >::value, int >::type = 0>
FieldTraits< ft >::real_type infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values) More...
 
size_type dim () const
 dimension of the vector space More...
 
iterator beforeBegin ()
 
size_type size () const
 number of blocks in the array (are of size 1 here) More...
 

Protected Attributes

size_type n
 
B * p
 

Detailed Description

template<class B, class A = std::allocator<B>>
class Dune::MatrixImp::DenseMatrixBase< B, A >

A Vector of blocks with different blocksizes.

This class started as a copy of VariableBlockVector, which used to be used for the internal memory managerment of the 'Matrix' class. However, that mechanism stopped working when I started using the RandomAccessIteratorFacade in VariableBlockVector (308dd85483108f8baaa4051251e2c75e2a9aed32, to make VariableBlockVector pass a number of tightened interface compliance tests), and I couldn't quite figure out how to fix that. However, using VariableBlockVector in Matrix internally was a hack anyway, so I simply took the working version of VariableBlockVector and copied it here under the new name of DenseMatrixBase. This is still hacky, but one step closer to an elegant solution.

Member Typedef Documentation

§ allocator_type

template<class B, class A = std::allocator<B>>
typedef A Dune::MatrixImp::DenseMatrixBase< B, A >::allocator_type

export the allocator type

§ block_type

template<class B, class A = std::allocator<B>>
typedef BlockVector<B,A> Dune::MatrixImp::DenseMatrixBase< B, A >::block_type

Same as value_type, here for historical reasons.

§ const_iterator

template<class B, class A = std::allocator<B>>
using Dune::MatrixImp::DenseMatrixBase< B, A >::const_iterator = ConstIterator

Export the const iterator type using std naming rules.

§ const_reference

template<class B, class A = std::allocator<B>>
typedef const window_type Dune::MatrixImp::DenseMatrixBase< B, A >::const_reference

§ ConstIterator

template<class B, class A = std::allocator<B>>
typedef base_array_unmanaged<B,A>::const_iterator Dune::block_vector_unmanaged< B, A >::ConstIterator
inherited

make iterators available as types

§ field_type

template<class B, class A = std::allocator<B>>
typedef B::field_type Dune::MatrixImp::DenseMatrixBase< B, A >::field_type

export the type representing the field

§ Iterator

template<class B, class A = std::allocator<B>>
typedef base_array_unmanaged<B,A>::iterator Dune::block_vector_unmanaged< B, A >::Iterator
inherited

make iterators available as types

§ iterator

template<class B, class A = std::allocator<B>>
using Dune::MatrixImp::DenseMatrixBase< B, A >::iterator = Iterator

Export the iterator type using std naming rules.

§ member_type

template<class B, class A = std::allocator<B>>
typedef B Dune::base_array_unmanaged< B, A >::member_type
inherited

export the type representing the components

§ reference

template<class B, class A = std::allocator<B>>
typedef window_type Dune::MatrixImp::DenseMatrixBase< B, A >::reference

§ size_type

template<class B, class A = std::allocator<B>>
typedef A::size_type Dune::MatrixImp::DenseMatrixBase< B, A >::size_type

The size type for the index access.

§ value_type

template<class B, class A = std::allocator<B>>
typedef BlockVector<B,A> Dune::MatrixImp::DenseMatrixBase< B, A >::value_type

Type of the elements of the outer vector, i.e., dynamic vectors of B.

Note that this is not the type referred to by the iterators and random access operators, which return proxy objects.

§ window_type

template<class B, class A = std::allocator<B>>
typedef BlockVectorWindow<B,A> Dune::MatrixImp::DenseMatrixBase< B, A >::window_type

Constructor & Destructor Documentation

§ DenseMatrixBase() [1/3]

template<class B, class A = std::allocator<B>>
Dune::MatrixImp::DenseMatrixBase< B, A >::DenseMatrixBase ( )
inline

constructor without arguments makes empty vector, object cannot be used yet

§ DenseMatrixBase() [2/3]

template<class B, class A = std::allocator<B>>
Dune::MatrixImp::DenseMatrixBase< B, A >::DenseMatrixBase ( size_type  rows,
size_type  columns 
)
inline

make vector with given number of blocks each having a constant size, object is fully usable then.

Parameters
_nblocksNumber of blocks
mNumber of elements in each block

§ DenseMatrixBase() [3/3]

template<class B, class A = std::allocator<B>>
Dune::MatrixImp::DenseMatrixBase< B, A >::DenseMatrixBase ( const DenseMatrixBase< B, A > &  a)
inline

copy constructor, has copy semantics

§ ~DenseMatrixBase()

template<class B, class A = std::allocator<B>>
Dune::MatrixImp::DenseMatrixBase< B, A >::~DenseMatrixBase ( )
inline

free dynamic memory

Member Function Documentation

§ axpy()

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::axpy ( const field_type a,
const block_vector_unmanaged< B, A > &  y 
)
inlineinherited

vector space axpy operation

§ beforeBegin() [1/2]

template<class B, class A = std::allocator<B>>
iterator Dune::base_array_unmanaged< B, A >::beforeBegin ( )
inlineinherited
Returns
an iterator that is positioned before the first entry of the vector.

§ beforeBegin() [2/2]

template<class B, class A = std::allocator<B>>
Iterator Dune::MatrixImp::DenseMatrixBase< B, A >::beforeBegin ( ) const
inline
Returns
an iterator that is positioned before the first entry of the vector.

§ beforeEnd() [1/2]

template<class B, class A = std::allocator<B>>
Iterator Dune::MatrixImp::DenseMatrixBase< B, A >::beforeEnd ( )
inline
Returns
an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.

§ beforeEnd() [2/2]

template<class B, class A = std::allocator<B>>
ConstIterator Dune::MatrixImp::DenseMatrixBase< B, A >::beforeEnd ( ) const
inline
Returns
an iterator that is positioned before the end iterator of the vector. i.e. at the last element.

§ begin() [1/2]

template<class B, class A = std::allocator<B>>
Iterator Dune::MatrixImp::DenseMatrixBase< B, A >::begin ( )
inline

begin Iterator

§ begin() [2/2]

template<class B, class A = std::allocator<B>>
ConstIterator Dune::MatrixImp::DenseMatrixBase< B, A >::begin ( ) const
inline

§ dim()

template<class B, class A = std::allocator<B>>
size_type Dune::block_vector_unmanaged< B, A >::dim ( ) const
inlineinherited

dimension of the vector space

§ dot()

template<class B, class A = std::allocator<B>>
template<class OtherB , class OtherA >
PromotionTraits<field_type,typename OtherB::field_type>::PromotedType Dune::block_vector_unmanaged< B, A >::dot ( const block_vector_unmanaged< OtherB, OtherA > &  y) const
inlineinherited

vector dot product $\left (x^H \cdot y \right)$ which corresponds to Petsc's VecDot

http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecDot.html

Parameters
yother (compatible) vector
Returns

§ end() [1/2]

template<class B, class A = std::allocator<B>>
Iterator Dune::MatrixImp::DenseMatrixBase< B, A >::end ( )
inline

end Iterator

§ end() [2/2]

template<class B, class A = std::allocator<B>>
ConstIterator Dune::MatrixImp::DenseMatrixBase< B, A >::end ( ) const
inline

§ find() [1/2]

template<class B, class A = std::allocator<B>>
Iterator Dune::MatrixImp::DenseMatrixBase< B, A >::find ( size_type  i)
inline

random access returning iterator (end if not contained)

§ find() [2/2]

template<class B, class A = std::allocator<B>>
ConstIterator Dune::MatrixImp::DenseMatrixBase< B, A >::find ( size_type  i) const
inline

random access returning iterator (end if not contained)

§ infinity_norm() [1/2]

template<class B, class A = std::allocator<B>>
template<typename ft = field_type, typename std::enable_if<!has_nan< ft >::value, int >::type = 0>
FieldTraits<ft>::real_type Dune::block_vector_unmanaged< B, A >::infinity_norm ( ) const
inlineinherited

infinity norm (maximum of absolute values of entries)

§ infinity_norm() [2/2]

template<class B, class A = std::allocator<B>>
template<typename ft = field_type, typename std::enable_if< has_nan< ft >::value, int >::type = 0>
FieldTraits<ft>::real_type Dune::block_vector_unmanaged< B, A >::infinity_norm ( ) const
inlineinherited

infinity norm (maximum of absolute values of entries)

§ infinity_norm_real() [1/2]

template<class B, class A = std::allocator<B>>
template<typename ft = field_type, typename std::enable_if<!has_nan< ft >::value, int >::type = 0>
FieldTraits<ft>::real_type Dune::block_vector_unmanaged< B, A >::infinity_norm_real ( ) const
inlineinherited

simplified infinity norm (uses Manhattan norm for complex values)

§ infinity_norm_real() [2/2]

template<class B, class A = std::allocator<B>>
template<typename ft = field_type, typename std::enable_if< has_nan< ft >::value, int >::type = 0>
FieldTraits<ft>::real_type Dune::block_vector_unmanaged< B, A >::infinity_norm_real ( ) const
inlineinherited

simplified infinity norm (uses Manhattan norm for complex values)

§ N()

template<class B, class A = std::allocator<B>>
size_type Dune::MatrixImp::DenseMatrixBase< B, A >::N ( ) const
inline

number of blocks in the vector (are of variable size here)

§ one_norm()

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::one_norm ( ) const
inlineinherited

one norm (sum over absolute values of entries)

§ one_norm_real()

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::one_norm_real ( ) const
inlineinherited

simplified one norm (uses Manhattan norm for complex values)

§ operator*()

template<class B, class A = std::allocator<B>>
template<class OtherB , class OtherA >
PromotionTraits<field_type,typename OtherB::field_type>::PromotedType Dune::block_vector_unmanaged< B, A >::operator* ( const block_vector_unmanaged< OtherB, OtherA > &  y) const
inlineinherited

indefinite vector dot product $\left (x^T \cdot y \right)$ which corresponds to Petsc's VecTDot

http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecTDot.html

Parameters
yother (compatible) vector
Returns

§ operator*=()

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator*= ( const field_type k)
inlineinherited

vector space multiplication with scalar

§ operator+=()

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator+= ( const block_vector_unmanaged< B, A > &  y)
inlineinherited

vector space addition

§ operator-=()

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator-= ( const block_vector_unmanaged< B, A > &  y)
inlineinherited

vector space subtraction

§ operator/=()

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator/= ( const field_type k)
inlineinherited

vector space division by scalar

§ operator=() [1/2]

template<class B, class A = std::allocator<B>>
DenseMatrixBase& Dune::MatrixImp::DenseMatrixBase< B, A >::operator= ( const DenseMatrixBase< B, A > &  a)
inline

assignment

§ operator=() [2/2]

template<class B, class A = std::allocator<B>>
DenseMatrixBase& Dune::MatrixImp::DenseMatrixBase< B, A >::operator= ( const field_type k)
inline

assign from scalar

§ operator[]() [1/2]

template<class B, class A = std::allocator<B>>
reference Dune::MatrixImp::DenseMatrixBase< B, A >::operator[] ( size_type  i)
inline

random access to blocks

§ operator[]() [2/2]

template<class B, class A = std::allocator<B>>
const_reference Dune::MatrixImp::DenseMatrixBase< B, A >::operator[] ( size_type  i) const
inline

same for read only access

§ rend()

template<class B, class A = std::allocator<B>>
ConstIterator Dune::MatrixImp::DenseMatrixBase< B, A >::rend ( ) const
inline

§ resize()

template<class B, class A = std::allocator<B>>
void Dune::MatrixImp::DenseMatrixBase< B, A >::resize ( size_type  rows,
size_type  columns 
)
inline

same effect as constructor with same argument

§ size()

template<class B, class A = std::allocator<B>>
size_type Dune::base_array_unmanaged< B, A >::size ( ) const
inlineinherited

number of blocks in the array (are of size 1 here)

§ two_norm()

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::two_norm ( ) const
inlineinherited

two norm sqrt(sum over squared values of entries)

§ two_norm2()

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::two_norm2 ( ) const
inlineinherited

Square of the two-norm (the sum over the squared values of the entries)

Member Data Documentation

§ n

template<class B, class A = std::allocator<B>>
size_type Dune::base_array_unmanaged< B, A >::n
protectedinherited

§ p

template<class B, class A = std::allocator<B>>
B* Dune::base_array_unmanaged< B, A >::p
protectedinherited

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