Dune::DenseVector< V > Class Template Reference

Interface for a class of dense vectors over a given field. More...

#include <dune/common/densevector.hh>

Public Types
typedef Traits::derived_type	derived_type
	type of derived vector class
typedef Traits::value_type	value_type
	export the type representing the field
typedef FieldTraits< value_type >::field_type	field_type
	export the type representing the field
typedef Traits::value_type	block_type
	export the type representing the components
typedef Traits::size_type	size_type
	The type used for the index access and size operation.
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
constexpr derived_type &	operator= (const value_type &k)
	Assignment operator for scalar.
template<typename W , std::enable_if_t< std::is_assignable< value_type &, typename DenseVector< W >::value_type >::value, int > = 0>
constexpr derived_type &	operator= (const DenseVector< W > &other)
	Assignment operator for other DenseVector of different type.
constexpr value_type &	operator[] (size_type i)
	random access
constexpr value_type &	front ()
	return reference to first element
constexpr const value_type &	front () const
	return reference to first element
constexpr value_type &	back ()
	return reference to last element
constexpr const value_type &	back () const
	return reference to last element
constexpr bool	empty () const
	checks whether the container is empty
constexpr size_type	size () const
	size method
constexpr Iterator	begin ()
	begin iterator
constexpr Iterator	end ()
	end iterator
constexpr Iterator	beforeEnd ()
constexpr Iterator	beforeBegin ()
constexpr Iterator	find (size_type i)
	return iterator to given element or end()
constexpr ConstIterator	begin () const
	begin ConstIterator
constexpr ConstIterator	end () const
	end ConstIterator
constexpr ConstIterator	beforeEnd () const
constexpr ConstIterator	beforeBegin () const
constexpr ConstIterator	find (size_type i) const
	return iterator to given element or end()
template<class Other >
constexpr derived_type &	operator+= (const DenseVector< Other > &x)
	vector space addition
template<class Other >
constexpr derived_type &	operator-= (const DenseVector< Other > &x)
	vector space subtraction
template<class Other >
constexpr derived_type	operator+ (const DenseVector< Other > &b) const
	Binary vector addition.
template<class Other >
constexpr derived_type	operator- (const DenseVector< Other > &b) const
	Binary vector subtraction.
constexpr derived_type	operator- () const
	Vector negation.
template<typename ValueType >
constexpr 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...
template<typename ValueType >
constexpr 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...
template<typename FieldType >
constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type &	operator*= (const FieldType &kk)
	vector space multiplication with scalar More...
template<typename FieldType >
constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type &	operator/= (const FieldType &kk)
	vector space division by scalar More...
template<class Other >
constexpr bool	operator== (const DenseVector< Other > &x) const
	Binary vector comparison.
template<class Other >
constexpr bool	operator!= (const DenseVector< Other > &x) const
	Binary vector incomparison.
template<class Other >
constexpr derived_type &	axpy (const field_type &a, const DenseVector< Other > &x)
	vector space axpy operation ( *this += a x )
template<class Other >
constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType	operator* (const DenseVector< Other > &x) const
	indefinite vector dot product $\left (x^T \cdot y \right)$ which corresponds to Petsc's VecTDot More...
template<class Other >
constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType	dot (const DenseVector< Other > &x) const
	vector dot product $\left (x^H \cdot y \right)$ which corresponds to Petsc's VecDot More...
constexpr FieldTraits< value_type >::real_type	one_norm () const
	one norm (sum over absolute values of entries)
constexpr FieldTraits< value_type >::real_type	one_norm_real () const
	simplified one norm (uses Manhattan norm for complex values)
constexpr FieldTraits< value_type >::real_type	two_norm () const
	two norm sqrt(sum over squared values of entries)
constexpr FieldTraits< value_type >::real_type	two_norm2 () const
	square of two norm (sum over squared values of entries), need for block recursion
template<typename vt = value_type, typename std::enable_if<!HasNaN< vt >::value, int >::type = 0>
constexpr FieldTraits< vt >::real_type	infinity_norm () const
	infinity norm (maximum of absolute values of entries)
template<typename vt = value_type, typename std::enable_if<!HasNaN< vt >::value, int >::type = 0>
constexpr FieldTraits< vt >::real_type	infinity_norm_real () const
	simplified infinity norm (uses Manhattan norm for complex values)
template<typename vt = value_type, typename std::enable_if< HasNaN< vt >::value, int >::type = 0>
constexpr FieldTraits< vt >::real_type	infinity_norm () const
	infinity norm (maximum of absolute values of entries)
template<typename vt = value_type, typename std::enable_if< HasNaN< vt >::value, int >::type = 0>
constexpr FieldTraits< vt >::real_type	infinity_norm_real () const
	simplified infinity norm (uses Manhattan norm for complex values)
constexpr size_type	N () const
	number of blocks in the vector (are of size 1 here)
constexpr size_type	dim () const
	dimension of the vector space

Static Public Attributes
static constexpr int	blocklevel = 1
	The number of block levels we contain. This is the leaf, that is, 1.

Protected Member Functions
constexpr DenseVector &	operator= (const DenseVector &)=default
	Assignment operator for other DenseVector of same type.

Related Functions
(Note that these are not member functions.)
template<typename V >
std::ostream &	operator<< (std::ostream &s, const DenseVector< V > &v)
	Write a DenseVector to an output stream. More...

Detailed Description

template<typename V>
class Dune::DenseVector< V >

Interface for a class of dense vectors over a given field.

Template Parameters

V	implementation class of the vector

Member Function Documentation

beforeBegin() [1/2]

template<typename V >

constexpr Iterator Dune::DenseVector< V >::beforeBegin ( )

inlineconstexpr

Returns

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

beforeBegin() [2/2]

template<typename V >

constexpr ConstIterator Dune::DenseVector< V >::beforeBegin ( ) const

inlineconstexpr

Returns

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

beforeEnd() [1/2]

template<typename V >

constexpr Iterator Dune::DenseVector< V >::beforeEnd ( )

inlineconstexpr

Returns

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

References Dune::DenseVector< V >::size().

beforeEnd() [2/2]

template<typename V >

constexpr ConstIterator Dune::DenseVector< V >::beforeEnd ( ) const

inlineconstexpr

Returns

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

References Dune::DenseVector< V >::size().

dot()

template<typename V >

template<class Other >

constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType Dune::DenseVector< V >::dot ( const DenseVector< Other > &  x ) const

inlineconstexpr

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

x	other vector

Returns

References Dune::dot(), and Dune::DenseVector< V >::size().

operator*()

template<typename V >

template<class Other >

constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType Dune::DenseVector< V >::operator* ( const DenseVector< Other > &  x ) const

inlineconstexpr

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

x	other vector

Returns

References Dune::DenseVector< V >::size().

operator*=()

template<typename V >

template<typename FieldType >

constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type & Dune::DenseVector< V >::operator*= ( const FieldType &  kk )

inlineconstexpr

vector space multiplication with scalar

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

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

References Dune::DenseVector< V >::size().

operator+=()

template<typename V >

template<typename ValueType >

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

inlineconstexpr

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.

References Dune::DenseVector< V >::size().

operator-=()

template<typename V >

template<typename ValueType >

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

inlineconstexpr

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.

References Dune::DenseVector< V >::size().

operator/=()

template<typename V >

template<typename FieldType >

constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type & Dune::DenseVector< V >::operator/= ( const FieldType &  kk )

inlineconstexpr

vector space division by scalar

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

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

References Dune::DenseVector< V >::size().

---

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

• dune/common/densevector.hh