dune-common  2.2.1
Public Types | Public Member Functions | Related Functions | List of all members
Dune::DynamicVector< K > Class Template Reference

Construct a vector with a dynamic size. More...

#include <dune/common/dynvector.hh>

Inheritance diagram for Dune::DynamicVector< K >:
Inheritance graph

Public Types

typedef Base::size_type size_type
typedef Base::value_type value_type
enum  
 We are at the leaf of the block recursion. More...
typedef Traits::derived_type derived_type
 type of derived vector class
typedef Traits::value_type field_type
 export the type representing the field
typedef Traits::value_type block_type
 export the type representing the components
typedef DenseIterator
< DenseVector, value_type
Iterator
 Iterator class for sequential access.
typedef Iterator iterator
 typedef for stl compliant access
typedef DenseIterator< const
DenseVector, const value_type
ConstIterator
 ConstIterator class for sequential access.
typedef ConstIterator const_iterator
 typedef for stl compliant access

Public Member Functions

 DynamicVector ()
 Constructor making uninitialized vector.
 DynamicVector (size_type n, value_type c=value_type())
 Constructor making vector with identical coordinates.
 DynamicVector (const DynamicVector &x)
 Constructor making vector with identical coordinates.
size_type capacity () const
 Number of elements for which memory has been allocated.
void resize (size_type n, value_type c=value_type())
void reserve (size_type n)
size_type vec_size () const
K & vec_access (size_type i)
const K & vec_access (size_type i) const
value_typeoperator[] (size_type i)
 random access
const value_typeoperator[] (size_type i) const
size_type size () const
 size method
Iterator begin ()
 begin iterator
ConstIterator begin () const
 begin ConstIterator
Iterator end ()
 end iterator
ConstIterator end () const
 end ConstIterator
Iterator beforeEnd ()
ConstIterator beforeEnd () const
Iterator beforeBegin ()
ConstIterator beforeBegin () const
Iterator find (size_type i)
 return iterator to given element or end()
ConstIterator find (size_type i) const
 return iterator to given element or end()
derived_typeoperator+= (const DenseVector< Other > &y)
 vector space addition
derived_typeoperator+= (const value_type &k)
 vector space add scalar to all comps
derived_typeoperator-= (const DenseVector< Other > &y)
 vector space subtraction
derived_typeoperator-= (const value_type &k)
 vector space subtract scalar from all comps
derived_type operator+ (const DenseVector< Other > &b) const
 Binary vector addition.
derived_type operator- (const DenseVector< Other > &b) const
 Binary vector subtraction.
derived_typeoperator*= (const value_type &k)
 vector space multiplication with scalar
derived_typeoperator/= (const value_type &k)
 vector space division by scalar
bool operator== (const DenseVector< Other > &y) const
 Binary vector comparison.
bool operator!= (const DenseVector< Other > &y) const
 Binary vector incomparison.
derived_typeaxpy (const value_type &a, const DenseVector< Other > &y)
 vector space axpy operation ( *this += a y )
value_type operator* (const DenseVector< Other > &y) const
 scalar product (x^T y)
FieldTraits< value_type >
::real_type 
one_norm () const
 one norm (sum over absolute values of entries)
FieldTraits< value_type >
::real_type 
one_norm_real () const
 simplified one norm (uses Manhattan norm for complex values)
FieldTraits< value_type >
::real_type 
two_norm () const
 two norm sqrt(sum over squared values of entries)
FieldTraits< value_type >
::real_type 
two_norm2 () const
 square of two norm (sum over squared values of entries), need for block recursion
FieldTraits< value_type >
::real_type 
infinity_norm () const
 infinity norm (maximum of absolute values of entries)
FieldTraits< value_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

Related Functions

(Note that these are not member functions.)

template<class K >
std::istream & operator>> (std::istream &in, DynamicVector< K > &v)
 Read a DynamicVector from an input stream.

Detailed Description

template<class K>
class Dune::DynamicVector< K >

Construct a vector with a dynamic size.

Template Parameters
Kis the field type (use float, double, complex, etc)

Member Typedef Documentation

export the type representing the components

typedef for stl compliant access

ConstIterator class for sequential access.

type of derived vector class

export the type representing the field

Iterator class for sequential access.

typedef Iterator Dune::DenseVector< DynamicVector< K > >::iterator
inherited

typedef for stl compliant access

template<class K>
typedef Base::size_type Dune::DynamicVector< K >::size_type
template<class K>
typedef Base::value_type Dune::DynamicVector< K >::value_type

Member Enumeration Documentation

anonymous enum
inherited

We are at the leaf of the block recursion.

Constructor & Destructor Documentation

template<class K>
Dune::DynamicVector< K >::DynamicVector ( )
inline

Constructor making uninitialized vector.

template<class K>
Dune::DynamicVector< K >::DynamicVector ( size_type  n,
value_type  c = value_type() 
)
inlineexplicit

Constructor making vector with identical coordinates.

template<class K>
Dune::DynamicVector< K >::DynamicVector ( const DynamicVector< K > &  x)
inline

Constructor making vector with identical coordinates.

Member Function Documentation

derived_type& Dune::DenseVector< DynamicVector< K > >::axpy ( const value_type a,
const DenseVector< Other > &  y 
)
inlineinherited

vector space axpy operation ( *this += a y )

Iterator Dune::DenseVector< DynamicVector< K > >::beforeBegin ( )
inlineinherited
Returns
an iterator that is positioned before the first entry of the vector.
ConstIterator Dune::DenseVector< DynamicVector< K > >::beforeBegin ( ) const
inlineinherited
Returns
an iterator that is positioned before the first entry of the vector.
Iterator Dune::DenseVector< DynamicVector< K > >::beforeEnd ( )
inlineinherited
Returns
an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.
ConstIterator Dune::DenseVector< DynamicVector< K > >::beforeEnd ( ) const
inlineinherited
Returns
an iterator that is positioned before the end iterator of the vector. i.e. at the last element
Iterator Dune::DenseVector< DynamicVector< K > >::begin ( )
inlineinherited

begin iterator

ConstIterator Dune::DenseVector< DynamicVector< K > >::begin ( ) const
inlineinherited

begin ConstIterator

template<class K>
size_type Dune::DynamicVector< K >::capacity ( ) const
inline

Number of elements for which memory has been allocated.

capacity() is always greater than or equal to size().

size_type Dune::DenseVector< DynamicVector< K > >::dim ( ) const
inlineinherited

dimension of the vector space

Iterator Dune::DenseVector< DynamicVector< K > >::end ( )
inlineinherited

end iterator

ConstIterator Dune::DenseVector< DynamicVector< K > >::end ( ) const
inlineinherited

end ConstIterator

Iterator Dune::DenseVector< DynamicVector< K > >::find ( size_type  i)
inlineinherited

return iterator to given element or end()

ConstIterator Dune::DenseVector< DynamicVector< K > >::find ( size_type  i) const
inlineinherited

return iterator to given element or end()

FieldTraits<value_type>::real_type Dune::DenseVector< DynamicVector< K > >::infinity_norm ( ) const
inlineinherited

infinity norm (maximum of absolute values of entries)

FieldTraits<value_type>::real_type Dune::DenseVector< DynamicVector< K > >::infinity_norm_real ( ) const
inlineinherited

simplified infinity norm (uses Manhattan norm for complex values)

size_type Dune::DenseVector< DynamicVector< K > >::N ( ) const
inlineinherited

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

FieldTraits<value_type>::real_type Dune::DenseVector< DynamicVector< K > >::one_norm ( ) const
inlineinherited

one norm (sum over absolute values of entries)

FieldTraits<value_type>::real_type Dune::DenseVector< DynamicVector< K > >::one_norm_real ( ) const
inlineinherited

simplified one norm (uses Manhattan norm for complex values)

bool Dune::DenseVector< DynamicVector< K > >::operator!= ( const DenseVector< Other > &  y) const
inlineinherited

Binary vector incomparison.

value_type Dune::DenseVector< DynamicVector< K > >::operator* ( const DenseVector< Other > &  y) const
inlineinherited

scalar product (x^T y)

derived_type& Dune::DenseVector< DynamicVector< K > >::operator*= ( const value_type k)
inlineinherited

vector space multiplication with scalar

derived_type Dune::DenseVector< DynamicVector< K > >::operator+ ( const DenseVector< Other > &  b) const
inlineinherited

Binary vector addition.

derived_type& Dune::DenseVector< DynamicVector< K > >::operator+= ( const DenseVector< Other > &  y)
inlineinherited

vector space addition

derived_type& Dune::DenseVector< DynamicVector< K > >::operator+= ( const value_type k)
inlineinherited

vector space add scalar to all comps

derived_type Dune::DenseVector< DynamicVector< K > >::operator- ( const DenseVector< Other > &  b) const
inlineinherited

Binary vector subtraction.

derived_type& Dune::DenseVector< DynamicVector< K > >::operator-= ( const DenseVector< Other > &  y)
inlineinherited

vector space subtraction

derived_type& Dune::DenseVector< DynamicVector< K > >::operator-= ( const value_type k)
inlineinherited

vector space subtract scalar from all comps

derived_type& Dune::DenseVector< DynamicVector< K > >::operator/= ( const value_type k)
inlineinherited

vector space division by scalar

bool Dune::DenseVector< DynamicVector< K > >::operator== ( const DenseVector< Other > &  y) const
inlineinherited

Binary vector comparison.

value_type& Dune::DenseVector< DynamicVector< K > >::operator[] ( size_type  i)
inlineinherited

random access

const value_type& Dune::DenseVector< DynamicVector< K > >::operator[] ( size_type  i) const
inlineinherited
template<class K>
void Dune::DynamicVector< K >::reserve ( size_type  n)
inline
template<class K>
void Dune::DynamicVector< K >::resize ( size_type  n,
value_type  c = value_type() 
)
inline

References c.

size_type Dune::DenseVector< DynamicVector< K > >::size ( ) const
inlineinherited

size method

Referenced by Dune::DynamicVector< K >::operator>>().

FieldTraits<value_type>::real_type Dune::DenseVector< DynamicVector< K > >::two_norm ( ) const
inlineinherited

two norm sqrt(sum over squared values of entries)

FieldTraits<value_type>::real_type Dune::DenseVector< DynamicVector< K > >::two_norm2 ( ) const
inlineinherited

square of two norm (sum over squared values of entries), need for block recursion

template<class K>
K& Dune::DynamicVector< K >::vec_access ( size_type  i)
inline
template<class K>
const K& Dune::DynamicVector< K >::vec_access ( size_type  i) const
inline
template<class K>
size_type Dune::DynamicVector< K >::vec_size ( ) const
inline

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