dune-istl  2.3beta2
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::BlockVectorWindow< B, A > Class Template Reference

#include <dune/istl/bvector.hh>

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

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

 BlockVectorWindow ()
 makes empty array
 BlockVectorWindow (B *_p, size_type _n)
 make array from given pointer and size
 BlockVectorWindow (const BlockVectorWindow &a)
 copy constructor, this has reference semantics!
 BlockVectorWindow (const block_vector_unmanaged< B, A > &_a)
 construct from base class object with reference semantics!
BlockVectorWindowoperator= (const BlockVectorWindow &a)
 assignment
BlockVectorWindowoperator= (const block_vector_unmanaged< B, A > &a)
 assign from base class object
BlockVectorWindowoperator= (const field_type &k)
 assign from scalar
void set (size_type _n, B *_p)
 set size and pointer
void setsize (size_type _n)
 set size only
void setptr (B *_p)
 set pointer only
B * getptr ()
 get pointer
size_type getsize ()
 get size
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
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
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
FieldTraits< field_type >
::real_type 
one_norm () const
 one norm (sum over absolute values of entries)
FieldTraits< field_type >
::real_type 
one_norm_real () const
 simplified one norm (uses Manhattan norm for complex values)
FieldTraits< field_type >
::real_type 
two_norm () const
 two norm sqrt(sum over squared values of entries)
FieldTraits< field_type >
::real_type 
two_norm2 () const
 Square of the two-norm (the sum over the squared values of the entries)
FieldTraits< field_type >
::real_type 
infinity_norm () const
 infinity norm (maximum of absolute values of entries)
FieldTraits< field_type >
::real_type 
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 beforeEnd ()
const_iterator beforeEnd () const
iterator beforeBegin ()
const_iterator beforeBegin () const
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)

Protected Attributes

size_type n
B * p

Detailed Description

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

BlockVectorWindow adds window manipulation functions to the block_vector_unmanaged template.

This class has no memory management. It assumes that the storage for the entries of the vector is maintained outside of this class.

But you can copy objects of this class and of the base class with reference semantics.

Assignment copies the data, if the format is incopmpatible with

the argument an exception is thrown in debug mode.

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

Member Typedef Documentation

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

export the allocator type

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

export the type representing the components

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

iterator class for sequential access

template<class B , class A = std::allocator<B>>
typedef block_vector_unmanaged<B,A>::ConstIterator Dune::BlockVectorWindow< B, A >::ConstIterator

make iterators available as types

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

export the type representing the field

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

iterator type for sequential access

template<class B , class A = std::allocator<B>>
typedef block_vector_unmanaged<B,A>::Iterator Dune::BlockVectorWindow< B, A >::Iterator

make iterators available as types

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

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

The type for the index access.

template<class B, class A = std::allocator<B>>
typedef B Dune::block_vector_unmanaged< B, A >::value_type
inherited

for STL compatibility

Member Enumeration Documentation

template<class B , class A = std::allocator<B>>
anonymous enum

increment block level counter

Enumerator:
blocklevel 

The number of blocklevels we contain.

Constructor & Destructor Documentation

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

makes empty array

template<class B , class A = std::allocator<B>>
Dune::BlockVectorWindow< B, A >::BlockVectorWindow ( B *  _p,
size_type  _n 
)
inline

make array from given pointer and size

References Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

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

copy constructor, this has reference semantics!

References Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

template<class B , class A = std::allocator<B>>
Dune::BlockVectorWindow< B, A >::BlockVectorWindow ( const block_vector_unmanaged< B, A > &  _a)
inline

construct from base class object with reference semantics!

References Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

Member Function Documentation

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

Referenced by Dune::block_vector_unmanaged< T, A >::axpy().

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.
template<class B, class A = std::allocator<B>>
const_iterator Dune::base_array_unmanaged< B, A >::beforeBegin ( ) const
inlineinherited
Returns
an iterator that is positioned before the first entry of the vector.

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

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

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

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

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

template<class B, class A = std::allocator<B>>
iterator Dune::base_array_unmanaged< B, A >::begin ( )
inlineinherited

begin iterator

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

Referenced by test_basearray(), and test_IO().

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

begin const_iterator

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

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

dimension of the vector space

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

Referenced by Dune::block_vector_unmanaged< T, A >::dot().

template<class B, class A = std::allocator<B>>
iterator Dune::base_array_unmanaged< B, A >::end ( )
inlineinherited

end iterator

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

Referenced by test_basearray(), and test_IO().

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

end const_iterator

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

template<class B, class A = std::allocator<B>>
iterator Dune::base_array_unmanaged< B, A >::find ( size_type  i)
inlineinherited

random access returning iterator (end if not contained)

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

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

random access returning iterator (end if not contained)

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

template<class B , class A = std::allocator<B>>
B* Dune::BlockVectorWindow< B, A >::getptr ( )
inline
template<class B , class A = std::allocator<B>>
size_type Dune::BlockVectorWindow< B, A >::getsize ( )
inline
template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::infinity_norm ( ) const
inlineinherited

infinity norm (maximum of absolute values of entries)

Referenced by Dune::block_vector_unmanaged< T, A >::infinity_norm().

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

simplified infinity norm (uses Manhattan norm for complex values)

Referenced by Dune::block_vector_unmanaged< T, A >::infinity_norm_real().

template<class B, class A = std::allocator<B>>
size_type Dune::block_vector_unmanaged< B, A >::N ( ) const
inlineinherited
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)

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)

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

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

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

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

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

assign from base class object

References Dune::BlockVectorWindow< B, A >::operator=().

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

assign from scalar

Reimplemented from Dune::block_vector_unmanaged< B, A >.

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

random access to blocks

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

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

same for read only access

Reimplemented in Dune::VariableBlockVector< B, A >, and Dune::VariableBlockVector< T, A >.

template<class B , class A = std::allocator<B>>
void Dune::BlockVectorWindow< B, A >::set ( size_type  _n,
B *  _p 
)
inline
template<class B , class A = std::allocator<B>>
void Dune::BlockVectorWindow< B, A >::setptr ( B *  _p)
inline
template<class B , class A = std::allocator<B>>
void Dune::BlockVectorWindow< B, A >::setsize ( size_type  _n)
inline
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)

Referenced by Dune::Matrix< T, A >::coldim(), and Dune::BlockVector< FieldVector< T, n >, A >::resize().

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)

Referenced by test_Iter().

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

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

Referenced by Dune::base_array_window< B, A >::advance(), Dune::block_vector_unmanaged< T, A >::axpy(), Dune::base_array< B, A >::base_array(), Dune::base_array_unmanaged< T, A >::beforeEnd(), Dune::BlockVector< FieldVector< T, n >, A >::BlockVector(), Dune::BlockVectorWindow< B, A >::BlockVectorWindow(), Dune::block_vector_unmanaged< T, A >::dim(), Dune::block_vector_unmanaged< T, A >::dot(), Dune::base_array_unmanaged< T, A >::end(), Dune::base_array_unmanaged< T, A >::find(), Dune::BlockVectorWindow< B, A >::getsize(), Dune::block_vector_unmanaged< T, A >::infinity_norm(), Dune::block_vector_unmanaged< T, A >::infinity_norm_real(), Dune::base_array_window< B, A >::move(), Dune::block_vector_unmanaged< T, A >::N(), Dune::block_vector_unmanaged< T, A >::one_norm(), Dune::block_vector_unmanaged< T, A >::one_norm_real(), Dune::block_vector_unmanaged< T, A >::operator*(), Dune::block_vector_unmanaged< T, A >::operator*=(), Dune::VariableBlockVector< B, A >::CreateIterator::operator++(), Dune::block_vector_unmanaged< T, A >::operator+=(), Dune::block_vector_unmanaged< T, A >::operator-=(), Dune::block_vector_unmanaged< T, A >::operator/=(), Dune::block_vector_unmanaged< T, A >::operator=(), Dune::VariableBlockVector< T, A >::operator=(), Dune::base_array< B, A >::operator=(), Dune::BlockVector< FieldVector< T, n >, A >::operator=(), Dune::BlockVectorWindow< B, A >::operator=(), Dune::base_array_unmanaged< T, A >::operator[](), Dune::VariableBlockVector< T, A >::resize(), Dune::BlockVector< FieldVector< T, n >, A >::resize(), Dune::base_array< B, A >::resize(), Dune::base_array_window< B, A >::set(), Dune::BlockVectorWindow< B, A >::set(), Dune::BlockVectorWindow< B, A >::setsize(), Dune::base_array_unmanaged< T, A >::size(), Dune::block_vector_unmanaged< T, A >::two_norm(), Dune::block_vector_unmanaged< T, A >::two_norm2(), Dune::VariableBlockVector< T, A >::VariableBlockVector(), Dune::base_array< B, A >::~base_array(), and Dune::VariableBlockVector< T, A >::~VariableBlockVector().

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: