dune-istl 2.9.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::VariableBlockVector< B, A > Class Template Reference

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

#include <dune/istl/vbvector.hh>

Inheritance diagram for Dune::VariableBlockVector< B, A >:
Inheritance graph

Classes

class  CreateIterator
 Iterator class for sequential creation of blocks. More...
 
class  RealIterator
 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 window_type & reference
 Export type used for references to container entries.
 
typedef const window_type & const_reference
 Export type used for const references to container entries.
 
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.
 
typedef BlockVector< B, A > block_type
 Same as value_type, here for historical reasons.
 
using Iterator = RealIterator< value_type, window_type & >
 
using iterator = Iterator
 Export the iterator type using std naming rules.
 
using ConstIterator = RealIterator< const value_type, const window_type & >
 Const iterator.
 
using const_iterator = ConstIterator
 Export the const iterator type using std naming rules.
 

Public Member Functions

 VariableBlockVector ()
 
 VariableBlockVector (size_type _nblocks)
 
 VariableBlockVector (size_type _nblocks, size_type m)
 
 VariableBlockVector (const VariableBlockVector &a)
 copy constructor, has copy semantics
 
 ~VariableBlockVector ()
 free dynamic memory
 
void resize (size_type _nblocks)
 same effect as constructor with same argument
 
void resize (size_type _nblocks, size_type m)
 same effect as constructor with same argument
 
VariableBlockVectoroperator= (const VariableBlockVector &a)
 assignment
 
VariableBlockVectoroperator= (const field_type &k)
 assign from scalar
 
CreateIterator createbegin ()
 get initial create iterator
 
CreateIterator createend ()
 get create iterator pointing to one after the last block
 
window_type & operator[] (size_type i)
 random access to blocks
 
const window_type & operator[] (size_type i) const
 same for read only access
 
Iterator begin ()
 begin Iterator
 
Iterator end ()
 end Iterator
 
Iterator beforeEnd ()
 
Iterator beforeBegin () const
 
ConstIterator begin () const
 begin ConstIterator
 
ConstIterator end () const
 end ConstIterator
 
ConstIterator beforeEnd () const
 
ConstIterator rend () const
 end ConstIterator
 
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)
 
size_type N () const
 number of blocks in the vector (are of variable size here)
 
size_type size () const
 

Static Public Attributes

static constexpr auto blocklevel = blockLevel<B>()+2
 

Detailed Description

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

A Vector of blocks with different blocksizes.

implements a vector consisting of a number of blocks (to
be given at run-time) which themselves consist of a number
of blocks (also given at run-time) of the given type B.

VariableBlockVector is a container of containers!

Member Typedef Documentation

◆ allocator_type

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

export the allocator type

◆ block_type

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

Same as value_type, here for historical reasons.

◆ const_iterator

template<class B , class A = std::allocator<B>>
using Dune::VariableBlockVector< 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::VariableBlockVector< B, A >::const_reference

Export type used for const references to container entries.

Note
This is not B&, but an internal proxy class!

◆ ConstIterator

template<class B , class A = std::allocator<B>>
using Dune::VariableBlockVector< B, A >::ConstIterator = RealIterator<const value_type, const window_type&>

Const iterator.

◆ field_type

template<class B , class A = std::allocator<B>>
using Dune::VariableBlockVector< B, A >::field_type = typename Imp::BlockTraits<B>::field_type

export the type representing the field

◆ Iterator

template<class B , class A = std::allocator<B>>
using Dune::VariableBlockVector< B, A >::Iterator = RealIterator<value_type,window_type&>

◆ iterator

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

Export the iterator type using std naming rules.

◆ reference

template<class B , class A = std::allocator<B>>
typedef window_type& Dune::VariableBlockVector< B, A >::reference

Export type used for references to container entries.

Note
This is not B&, but an internal proxy class!

◆ size_type

template<class B , class A = std::allocator<B>>
typedef A::size_type Dune::VariableBlockVector< 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::VariableBlockVector< 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

◆ VariableBlockVector() [1/4]

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

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

◆ VariableBlockVector() [2/4]

template<class B , class A = std::allocator<B>>
Dune::VariableBlockVector< B, A >::VariableBlockVector ( size_type  _nblocks)
inlineexplicit

make vector with given number of blocks, but size of each block is not yet known, object cannot be used yet

◆ VariableBlockVector() [3/4]

template<class B , class A = std::allocator<B>>
Dune::VariableBlockVector< B, A >::VariableBlockVector ( size_type  _nblocks,
size_type  m 
)
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

◆ VariableBlockVector() [4/4]

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

copy constructor, has copy semantics

◆ ~VariableBlockVector()

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

free dynamic memory

Member Function Documentation

◆ beforeBegin()

template<class B , class A = std::allocator<B>>
Iterator Dune::VariableBlockVector< 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::VariableBlockVector< 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::VariableBlockVector< 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::VariableBlockVector< B, A >::begin ( )
inline

begin Iterator

◆ begin() [2/2]

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

begin ConstIterator

◆ createbegin()

template<class B , class A = std::allocator<B>>
CreateIterator Dune::VariableBlockVector< B, A >::createbegin ( )
inline

get initial create iterator

◆ createend()

template<class B , class A = std::allocator<B>>
CreateIterator Dune::VariableBlockVector< B, A >::createend ( )
inline

get create iterator pointing to one after the last block

◆ end() [1/2]

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

end Iterator

◆ end() [2/2]

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

end ConstIterator

◆ find() [1/2]

template<class B , class A = std::allocator<B>>
Iterator Dune::VariableBlockVector< 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::VariableBlockVector< B, A >::find ( size_type  i) const
inline

random access returning iterator (end if not contained)

◆ N()

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

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

◆ operator=() [1/2]

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

assign from scalar

◆ operator=() [2/2]

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

assignment

◆ operator[]() [1/2]

template<class B , class A = std::allocator<B>>
window_type & Dune::VariableBlockVector< B, A >::operator[] ( size_type  i)
inline

random access to blocks

◆ operator[]() [2/2]

template<class B , class A = std::allocator<B>>
const window_type & Dune::VariableBlockVector< B, A >::operator[] ( size_type  i) const
inline

same for read only access

◆ rend()

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

end ConstIterator

◆ resize() [1/2]

template<class B , class A = std::allocator<B>>
void Dune::VariableBlockVector< B, A >::resize ( size_type  _nblocks)
inline

same effect as constructor with same argument

◆ resize() [2/2]

template<class B , class A = std::allocator<B>>
void Dune::VariableBlockVector< B, A >::resize ( size_type  _nblocks,
size_type  m 
)
inline

same effect as constructor with same argument

◆ size()

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

Number of blocks in the vector

Returns the same value as method N(), because the vector is dense

Member Data Documentation

◆ blocklevel

template<class B , class A = std::allocator<B>>
constexpr auto Dune::VariableBlockVector< B, A >::blocklevel = blockLevel<B>()+2
staticconstexpr

increment block level counter, yes, it is two levels because VariableBlockVector is a container of containers


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