DUNE PDELab (git)

Dune::MatrixImp::DenseMatrixBase< B, A > Class Template Reference

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

#include <dune/istl/matrix.hh>

Classes

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

Public Types

using field_type = typename Imp::BlockTraits< B >::field_type
 export the type representing the field
 
typedef A allocator_type
 export the allocator type
 
typedef A::size_type size_type
 The size type for the index access.
 
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.
 
using iterator = Iterator
 Export the iterator type using std naming rules.
 
using const_iterator = ConstIterator
 Export the const iterator type using std naming rules.
 

Public Member Functions

 DenseMatrixBase ()
 
 DenseMatrixBase (size_type rows, size_type columns)
 
 DenseMatrixBase (const DenseMatrixBase &a)
 copy constructor, has copy semantics
 
 ~DenseMatrixBase ()
 free dynamic memory
 
void resize (size_type rows, size_type columns)
 same effect as constructor with same argument
 
DenseMatrixBaseoperator= (const DenseMatrixBase &a)
 assignment
 
DenseMatrixBaseoperator= (const field_type &k)
 assign from scalar
 
reference operator[] (size_type i)
 random access to blocks
 
const_reference operator[] (size_type i) const
 same for read only access
 
Iterator begin ()
 begin Iterator
 
Iterator end ()
 end Iterator
 
Iterator beforeEnd ()
 
Iterator beforeBegin () const
 
Iterator find (size_type i)
 random access returning iterator (end if not contained)
 
ConstIterator find (size_type i) const
 random access returning iterator (end if not contained)
 
ConstIterator begin () const
 begin ConstIterator
 
ConstIterator end () const
 end ConstIterator
 
ConstIterator beforeEnd () const
 
ConstIterator rend () const
 end ConstIterator
 
size_type N () const
 number of blocks in the vector (are of variable size here)
 

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

◆ 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.

Constructor & Destructor Documentation

◆ DenseMatrixBase() [1/2]

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/2]

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
rowsNumber of rows
columnsNumber of columns

Member Function Documentation

◆ beforeBegin()

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.

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 23, 23:29, 2024)