Dune::DynamicVector< K, Allocator > Class Template Reference

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

#include <dune/common/dynvector.hh>

Public Types
enum
	We are at the leaf of the block recursion.
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 (const allocator_type &a=allocator_type())
	Constructor making uninitialized vector.
	DynamicVector (size_type n, value_type c, const allocator_type &a=allocator_type())
	Constructor making vector with identical coordinates.
	DynamicVector (const DynamicVector &x)
	Constructor making vector with identical coordinates.
	DynamicVector (DynamicVector &&x)
	Move constructor.
template<class X >
	DynamicVector (const DenseVector< X > &x, const allocator_type &a=allocator_type())
	Copy constructor from another DenseVector.
DynamicVector &	operator= (const DynamicVector &other)
	Copy assignment operator.
DynamicVector &	operator= (DynamicVector &&other)
	Move assignment operator.
size_type	capacity () const
	Number of elements for which memory has been allocated. More...
derived_type &	operator= (const value_type &k)
	Assignment operator for scalar.
value_type &	operator[] (size_type i)
	random access
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_type &	operator+= (const DenseVector< Other > &y)
	vector space addition
std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type &	operator+= (const ValueType &kk)
	vector space add scalar to all comps More...
derived_type &	operator-= (const DenseVector< Other > &y)
	vector space subtraction
std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type &	operator-= (const ValueType &kk)
	vector space subtract scalar from all comps More...
derived_type	operator+ (const DenseVector< Other > &b) const
	Binary vector addition.
derived_type	operator- (const DenseVector< Other > &b) const
	Binary vector subtraction.
std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type &	operator*= (const ValueType &kk)
	vector space multiplication with scalar More...
std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type &	operator/= (const ValueType &kk)
	vector space division by scalar More...
bool	operator== (const DenseVector< Other > &y) const
	Binary vector comparison.
bool	operator!= (const DenseVector< Other > &y) const
	Binary vector incomparison.
derived_type &	axpy (const value_type &a, const DenseVector< Other > &y)
	vector space axpy operation ( *this += a y )
PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType	operator* (const DenseVector< Other > &y) const
	indefinite vector dot product $\left (x^T \cdot y \right)$ which corresponds to Petsc's VecTDot More...
PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType	dot (const DenseVector< Other > &y) const
	vector dot product $\left (x^H \cdot y \right)$ which corresponds to Petsc's VecDot More...
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 , class Allocator >
std::istream &	operator>> (std::istream &in, DynamicVector< K, Allocator > &v)
	Read a DynamicVector from an input stream. More...
std::ostream &	operator<< (std::ostream &s, const DenseVector< DynamicVector< K, std::allocator< K > > > &v)
	Write a DenseVector to an output stream. More...

Detailed Description

template<class K, class Allocator = std::allocator< K >>
class Dune::DynamicVector< K, Allocator >

Construct a vector with a dynamic size.

Template Parameters

K	is the field type (use float, double, complex, etc)
Allocator	type of allocator object used to define the storage allocation model, default Allocator = std::allocator< K >.

Member Function Documentation

beforeBegin() [1/2]

Iterator Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::beforeBegin ( )

inlineinherited

Returns

an iterator that is positioned before the first entry of the vector.

beforeBegin() [2/2]

ConstIterator Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::beforeBegin ( ) const

inlineinherited

Returns

an iterator that is positioned before the first entry of the vector.

beforeEnd() [1/2]

Iterator Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::beforeEnd ( )

inlineinherited

Returns

an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.

beforeEnd() [2/2]

ConstIterator Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::beforeEnd ( ) const

inlineinherited

Returns

an iterator that is positioned before the end iterator of the vector. i.e. at the last element

capacity()

template<class K , class Allocator = std::allocator< K >>

size_type Dune::DynamicVector< K, Allocator >::capacity ( ) const

inline

Number of elements for which memory has been allocated.

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

dot()

PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::dot ( const DenseVector< Other > &  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

y	other vector

Returns

operator*()

PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::operator* ( const DenseVector< Other > &  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

y	other vector

Returns

operator*=()

std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::operator*= ( const ValueType &  kk )

inlineinherited

vector space multiplication with scalar

we use enable_if to avoid an ambiguity, if the function parameter can be converted to value_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to value_type.

operator+=()

std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::operator+= ( const ValueType &  kk )

inlineinherited

vector space add scalar to all comps

we use enable_if to avoid an ambiguity, if the function parameter can be converted to value_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to value_type.

operator-=()

std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::operator-= ( const ValueType &  kk )

inlineinherited

vector space subtract scalar from all comps

we use enable_if to avoid an ambiguity, if the function parameter can be converted to value_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to value_type.

operator/=()

std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & Dune::DenseVector< DynamicVector< K, std::allocator< K > > >::operator/= ( const ValueType &  kk )

inlineinherited

vector space division by scalar

we use enable_if to avoid an ambiguity, if the function parameter can be converted to value_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to value_type.

Friends And Related Function Documentation

operator<<()

std::ostream & operator<< ( std::ostream &  s, const DenseVector< DynamicVector< K, std::allocator< K > > > &  v  )

related

Write a DenseVector to an output stream.

Parameters

[in]	s	std :: ostream to write to
[in]	v	DenseVector to write

Returns

the output stream (s)

---

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

• dune/common/dynvector.hh