#include <dune/common/diagonalmatrix.hh>

Inheritance diagram for Dune::DiagonalRowVector< K, n >:

Public Types
typedef K	field_type
	export the type representing the field More...

typedef K	block_type
	export the type representing the components More...

typedef std::size_t	size_type
	The type used for the index access and size operation. More...

typedef ContainerWrapperIterator< DiagonalRowVector< K, n >, K, K & >	Iterator
	Iterator class for sequential access. More...

typedef Iterator	iterator
	typedef for stl compliant access More...

typedef ContainerWrapperIterator< DiagonalRowVectorConst< K, n >, const K, const K & >	ConstIterator
	ConstIterator class for sequential access. More...

typedef ConstIterator	const_iterator
	typedef for stl compliant access More...

Public Member Functions
	DiagonalRowVector ()
	Constructor making uninitialized vector. More...

	DiagonalRowVector (K *p, int col)
	Constructor making vector with identical coordinates. More...

DiagonalRowVector &	operator= (const K &k)
	Assignment operator for scalar. More...

K &	operator[] ([[maybe_unused]] size_type i)
	random access More...

Iterator	begin ()
	begin iterator More...

Iterator	end ()
	end iterator More...

Iterator	beforeEnd ()

Iterator	beforeBegin ()

const K &	operator[] ([[maybe_unused]] size_type i) const
	same for read only access More...

bool	identical (const DiagonalRowVectorConst< K, n > &other) const

ConstIterator	begin () const
	begin ConstIterator More...

ConstIterator	end () const
	end ConstIterator More...

ConstIterator	beforeEnd () const

ConstIterator	beforeBegin () const

bool	operator== (const DiagonalRowVectorConst &y) const
	Binary vector comparison. More...

size_type	N () const
	number of blocks in the vector (are of size 1 here) More...

size_type	dim () const
	dimension of the vector space More...

size_type	rowIndex () const
	index of this row in surrounding matrix More...

const K &	diagonal () const
	the diagonal value More...

Static Public Attributes
static constexpr int	dimension = n

static constexpr int	blocklevel = 1
	The number of block levels we contain. More...

static constexpr int	size = n
	The size of this vector. More...

Protected Member Functions
DiagonalRowVector *	operator & ()

size_type	realIndex ([[maybe_unused]] int i) const

K *	pointer ([[maybe_unused]] size_type i) const

Protected Attributes
K *	p_

size_type	row_

Friends
template<class DiagonalMatrixType >
class	DiagonalMatrixWrapper

class	ContainerWrapperIterator< DiagonalRowVector< K, n >, K, K &>

Member Typedef Documentation

◆ block_type

template<class K, int n>

typedef K Dune::DiagonalRowVector< K, n >::block_type

export the type representing the components

◆ const_iterator

template<class K, int n>

typedef ConstIterator Dune::DiagonalRowVector< K, n >::const_iterator

typedef for stl compliant access

◆ ConstIterator

template<class K, int n>

typedef ContainerWrapperIterator<DiagonalRowVectorConst<K,n>, const K, const K&> Dune::DiagonalRowVector< K, n >::ConstIterator

ConstIterator class for sequential access.

◆ field_type

template<class K, int n>

typedef K Dune::DiagonalRowVector< K, n >::field_type

export the type representing the field

◆ Iterator

template<class K, int n>

typedef ContainerWrapperIterator<DiagonalRowVector<K,n>, K, K&> Dune::DiagonalRowVector< K, n >::Iterator

Iterator class for sequential access.

◆ iterator

template<class K, int n>

typedef Iterator Dune::DiagonalRowVector< K, n >::iterator

typedef for stl compliant access

◆ size_type

template<class K, int n>

typedef std::size_t Dune::DiagonalRowVector< K, n >::size_type

The type used for the index access and size operation.

Constructor & Destructor Documentation

◆ DiagonalRowVector() [1/2]

template<class K, int n>

Dune::DiagonalRowVector< K, n >::DiagonalRowVector ( )

inline

Constructor making uninitialized vector.

◆ DiagonalRowVector() [2/2]

template<class K, int n>

Dune::DiagonalRowVector< K, n >::DiagonalRowVector	(	K *	p,
		int	col
	)

inlineexplicit

Constructor making vector with identical coordinates.

Member Function Documentation

◆ beforeBegin() [1/2]

template<class K , int n>

ConstIterator Dune::DiagonalRowVectorConst< K, n >::beforeBegin ( ) const

inlineinherited

Returns: an iterator that is positioned before the first row of the matrix.

◆ beforeBegin() [2/2]

template<class K, int n>

Iterator Dune::DiagonalRowVector< K, n >::beforeBegin ( )

inline

Returns: an iterator that is positioned before the first row of the matrix.

◆ beforeEnd() [1/2]

template<class K , int n>

ConstIterator Dune::DiagonalRowVectorConst< K, n >::beforeEnd ( ) const

inlineinherited

Returns: an iterator that is positioned before the end iterator of the rows. i.e. at the row.

◆ beforeEnd() [2/2]

template<class K, int n>

Iterator Dune::DiagonalRowVector< K, n >::beforeEnd ( )

inline

Returns: an iterator that is positioned before the end iterator of the rows, i.e. at the last row.

◆ begin() [1/2]

template<class K , int n>

ConstIterator Dune::DiagonalRowVectorConst< K, n >::begin ( ) const

inlineinherited

begin ConstIterator

◆ begin() [2/2]

template<class K, int n>

Iterator Dune::DiagonalRowVector< K, n >::begin ( )

inline

begin iterator

◆ diagonal()

template<class K , int n>

const K& Dune::DiagonalRowVectorConst< K, n >::diagonal ( ) const

inlineinherited

the diagonal value

◆ dim()

template<class K , int n>

size_type Dune::DiagonalRowVectorConst< K, n >::dim ( ) const

inlineinherited

dimension of the vector space

◆ end() [1/2]

template<class K , int n>

ConstIterator Dune::DiagonalRowVectorConst< K, n >::end ( ) const

inlineinherited

end ConstIterator

◆ end() [2/2]

template<class K, int n>

Iterator Dune::DiagonalRowVector< K, n >::end ( )

inline

end iterator

◆ identical()

template<class K , int n>

bool Dune::DiagonalRowVectorConst< K, n >::identical ( const DiagonalRowVectorConst< K, n > & other ) const

inlineinherited

◆ N()

template<class K , int n>

size_type Dune::DiagonalRowVectorConst< K, n >::N ( ) const

inlineinherited

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

◆ operator &()

template<class K, int n>

DiagonalRowVector* Dune::DiagonalRowVector< K, n >::operator& ( )

inlineprotected

◆ operator=()

template<class K, int n>

DiagonalRowVector& Dune::DiagonalRowVector< K, n >::operator= ( const K & k )

inline

Assignment operator for scalar.

◆ operator==()

template<class K , int n>

bool Dune::DiagonalRowVectorConst< K, n >::operator== ( const DiagonalRowVectorConst< K, n > & y ) const

inlineinherited

Binary vector comparison.

◆ operator[]() [1/2]

template<class K , int n>

const K& Dune::DiagonalRowVectorConst< K, n >::operator[] ( [[maybe_unused] ] size_type i ) const

inlineinherited

same for read only access

◆ operator[]() [2/2]

template<class K, int n>

K& Dune::DiagonalRowVector< K, n >::operator[] ( [[maybe_unused] ] size_type i )

inline

random access

◆ pointer()

template<class K , int n>

K* Dune::DiagonalRowVectorConst< K, n >::pointer ( [[maybe_unused] ] size_type i ) const

inlineprotectedinherited

◆ realIndex()

template<class K , int n>

size_type Dune::DiagonalRowVectorConst< K, n >::realIndex ( [[maybe_unused] ] int i ) const

inlineprotectedinherited

◆ rowIndex()

template<class K , int n>

size_type Dune::DiagonalRowVectorConst< K, n >::rowIndex ( ) const

inlineinherited

index of this row in surrounding matrix

Friends And Related Function Documentation

◆ ContainerWrapperIterator< DiagonalRowVector< K, n >, K, K &>

template<class K, int n>

friend class ContainerWrapperIterator< DiagonalRowVector< K, n >, K, K & >

friend

◆ DiagonalMatrixWrapper

template<class K, int n>

template<class DiagonalMatrixType >

friend class DiagonalMatrixWrapper

friend

Member Data Documentation

◆ blocklevel

template<class K , int n>

constexpr int Dune::DiagonalRowVectorConst< K, n >::blocklevel = 1

staticinherited

The number of block levels we contain.

◆ dimension

template<class K , int n>

constexpr int Dune::DiagonalRowVectorConst< K, n >::dimension = n

staticinherited

◆ p_

template<class K , int n>

K* Dune::DiagonalRowVectorConst< K, n >::p_

protectedinherited

◆ row_

template<class K , int n>

size_type Dune::DiagonalRowVectorConst< K, n >::row_

protectedinherited

◆ size

template<class K , int n>

constexpr int Dune::DiagonalRowVectorConst< K, n >::size = n

staticinherited

The size of this vector.

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

diagonalmatrix.hh

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

◆ block_type

◆ const_iterator

◆ ConstIterator

◆ field_type

◆ Iterator

◆ iterator

◆ size_type

Constructor & Destructor Documentation

◆ DiagonalRowVector() [1/2]

◆ DiagonalRowVector() [2/2]

Member Function Documentation

◆ beforeBegin() [1/2]

◆ beforeBegin() [2/2]

◆ beforeEnd() [1/2]

◆ beforeEnd() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ diagonal()

◆ dim()

◆ end() [1/2]

◆ end() [2/2]

◆ identical()

◆ N()

◆ operator &()

◆ operator=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pointer()

◆ realIndex()

◆ rowIndex()

Friends And Related Function Documentation

◆ ContainerWrapperIterator< DiagonalRowVector< K, n >, K, K &>

◆ DiagonalMatrixWrapper

Member Data Documentation

◆ blocklevel

◆ dimension

◆ p_

◆ row_

◆ size