DUNE PDELab (git)
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 | |
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> | |
derived_type & | operator= (const DenseVector< W > &other) |
Assignment operator for other DenseVector of different type. | |
value_type & | operator[] (size_type i) |
random access | |
value_type & | front () |
return reference to first element | |
const value_type & | front () const |
return reference to first element | |
value_type & | back () |
return reference to last element | |
const value_type & | back () const |
return reference to last element | |
bool | empty () const |
checks whether the container is empty | |
size_type | size () const |
size method | |
Iterator | begin () |
begin iterator | |
Iterator | end () |
end iterator | |
Iterator | beforeEnd () |
Iterator | beforeBegin () |
Iterator | find (size_type i) |
return iterator to given element or end() | |
ConstIterator | begin () const |
begin ConstIterator | |
ConstIterator | end () const |
end ConstIterator | |
ConstIterator | beforeEnd () const |
ConstIterator | beforeBegin () const |
ConstIterator | find (size_type i) const |
return iterator to given element or end() | |
template<class Other > | |
derived_type & | operator+= (const DenseVector< Other > &x) |
vector space addition | |
template<class Other > | |
derived_type & | operator-= (const DenseVector< Other > &x) |
vector space subtraction | |
template<class Other > | |
derived_type | operator+ (const DenseVector< Other > &b) const |
Binary vector addition. | |
template<class Other > | |
derived_type | operator- (const DenseVector< Other > &b) const |
Binary vector subtraction. | |
derived_type | operator- () const |
Vector negation. | |
template<typename ValueType > | |
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 > | |
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 > | |
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 > | |
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 > | |
bool | operator== (const DenseVector< Other > &x) const |
Binary vector comparison. | |
template<class Other > | |
bool | operator!= (const DenseVector< Other > &x) const |
Binary vector incomparison. | |
template<class Other > | |
derived_type & | axpy (const field_type &a, const DenseVector< Other > &x) |
vector space axpy operation ( *this += a x ) | |
template<class Other > | |
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 > | |
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... | |
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 | |
template<typename vt = value_type, typename std::enable_if<!HasNaN< vt >::value, int >::type = 0> | |
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> | |
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> | |
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> | |
FieldTraits< vt >::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 | |
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 | |
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
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]
|
inline |
- Returns
- an iterator that is positioned before the first entry of the vector.
◆ beforeBegin() [2/2]
|
inline |
- Returns
- an iterator that is positioned before the first entry of the vector.
◆ beforeEnd() [1/2]
|
inline |
- 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]
|
inline |
- 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()
|
inline |
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*()
|
inline |
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*=()
|
inline |
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+=()
|
inline |
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-=()
|
inline |
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/=()
|
inline |
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