Dune::BlockVector< B, A > Class Template Reference
[Sparse Matrix and Vector classes]

#include <bvector.hh>

Inheritance diagram for Dune::BlockVector< B, A >:

Dune::block_vector_unmanaged< B, A > Dune::base_array_unmanaged< B, A > List of all members.

Detailed Description

template<class B, class A = ISTLAllocator>
class Dune::BlockVector< B, A >

A vector of blocks with memory management.

BlockVector adds memory management with ordinary copy semantics to the block_vector_unmanaged template.

Error checking: no error checking is provided normally. Setting the compile time switch DUNE_ISTL_WITH_CHECKING enables error checking.


Public Types

enum  { blocklevel = B::blocklevel+1 }
 increment block level counter More...
typedef B::field_type field_type
 export the type representing the field
typedef B block_type
 export the type representing the components
typedef A allocator_type
 export the allocator type
typedef A::size_type size_type
 The type for the index access.
typedef block_vector_unmanaged<
B, A >::Iterator 
Iterator
 make iterators available as types
typedef block_vector_unmanaged<
B, A >::ConstIterator 
ConstIterator
 make iterators available as types
typedef B value_type
 for STL compatibility
typedef B member_type
 export the type representing the components
typedef RealIterator< B > iterator
 iterator type for sequential access
typedef RealIterator< const
B > 
const_iterator
 iterator class for sequential access

Public Member Functions

 BlockVector ()
 makes empty vector
 BlockVector (size_type _n)
 make vector with _n components
void reserve (size_type capacity, bool copyOldValues=true)
 Reserve space.
size_type capacity () const
 Get the capacity of the vector.
void resize (size_type size, bool copyOldValues=true)
 Resize the vector.
 BlockVector (const BlockVector &a)
 copy constructor
 BlockVector (const block_vector_unmanaged< B, A > &_a)
 construct from base class object
 ~BlockVector ()
 free dynamic memory
BlockVectoroperator= (const BlockVector &a)
 assignment
BlockVectoroperator= (const block_vector_unmanaged< B, A > &a)
 assign from base class object
BlockVectoroperator= (const field_type &k)
 assign from scalar
block_vector_unmanagedoperator+= (const block_vector_unmanaged &y)
 vector space addition
block_vector_unmanagedoperator-= (const block_vector_unmanaged &y)
 vector space subtraction
block_vector_unmanagedoperator *= (const field_type &k)
 vector space multiplication with scalar
block_vector_unmanagedoperator/= (const field_type &k)
 vector space division by scalar
block_vector_unmanagedaxpy (const field_type &a, const block_vector_unmanaged &y)
 vector space axpy operation
field_type operator * (const block_vector_unmanaged &y) const
 scalar product
double one_norm () const
 one norm (sum over absolute values of entries)
double one_norm_real () const
 simplified one norm (uses Manhattan norm for complex values)
double two_norm () const
 two norm sqrt(sum over squared values of entries)
double two_norm2 () const
 sqare of two norm (sum over squared values of entries), need for block recursion
double infinity_norm () const
 infinity norm (maximum of absolute values of entries)
double infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values)
size_type N () const
 number of blocks in the vector (are of size 1 here)
size_type dim () const
 dimension of the vector space
B & operator[] (size_type i)
 random access to blocks
const B & operator[] (size_type i) const
 same for read only access
iterator begin ()
 begin iterator
const_iterator begin () const
 begin const_iterator
iterator end ()
 end iterator
const_iterator end () const
 end const_iterator
iterator rbegin ()
 begin reverse iterator
const_iterator rbegin () const
 begin reverse const_iterator
iterator rend ()
 end reverse iterator
const_iterator rend () const
 end reverse const_iterator
iterator find (size_type i)
 random access returning iterator (end if not contained)
const_iterator find (size_type i) const
 random access returning iterator (end if not contained)
size_type size () const
 number of blocks in the array (are of size 1 here)

Member Enumeration Documentation

template<class B, class A = ISTLAllocator>
anonymous enum

increment block level counter

Enumerator:
blocklevel  The number of blocklevel we contain.


Member Function Documentation

template<class B, class A = ISTLAllocator>
void Dune::BlockVector< B, A >::reserve ( size_type  capacity,
bool  copyOldValues = true 
) [inline]

Reserve space.

After calling this method the vector can hold up to capacity values. If the specified capacity is smaller than the current capacity and bigger than the current size space will be freed.

If the template parameter copyOldValues is true the values will be copied. If it is false the old values are lost.

Parameters:
capacity The maximum number of elements the vector needs to hold.
copyOldValues If false no object will be copied and the data might be lost. Default value is true.

template<class B, class A = ISTLAllocator>
size_type Dune::BlockVector< B, A >::capacity (  )  const [inline]

Get the capacity of the vector.

I. e. the maximum number of elements the vector can hold.

Returns:
The capacity of the vector.

template<class B, class A = ISTLAllocator>
void Dune::BlockVector< B, A >::resize ( size_type  size,
bool  copyOldValues = true 
) [inline]

Resize the vector.

After calling this method N() will return size If the capacity of the vector is smaller than the specified size then reserve(size) will be called.

If the template parameter copyOldValues is true the values will be copied if the capacity changes. If it is false the old values are lost.

Parameters:
size The new size of the vector.
copyOldValues If false no object will be copied and the data might be lost.


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

Generated on 9 Apr 2008 with Doxygen (ver 1.5.2) [logfile].