dune-common  2.3.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Dune::DiagonalRowVectorConst< K, n > Class Template Reference

#include <dune/common/diagonalmatrix.hh>

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

Public Types

enum  { dimension = n }
enum  { blocklevel = 1 }
 We are at the leaf of the block recursion. More...
enum  { size = n }
 export size More...
typedef K field_type
 export the type representing the field
typedef K block_type
 export the type representing the components
typedef std::size_t size_type
 The type used for the index access and size operation.
typedef
ContainerWrapperIterator
< DiagonalRowVectorConst< K, n >
, const K, const K & > 
ConstIterator
 ConstIterator class for sequential access.
typedef ConstIterator const_iterator
 typedef for stl compliant access

Public Member Functions

 DiagonalRowVectorConst ()
 Constructor making uninitialized vector.
 DiagonalRowVectorConst (K *p, int col)
 Constructor making vector with identical coordinates.
const K & operator[] (size_type i) const
 same for read only access
bool identical (const DiagonalRowVectorConst< K, n > &other) const
ConstIterator begin () const
 begin ConstIterator
ConstIterator end () const
 end ConstIterator
ConstIterator beforeEnd () const
ConstIterator beforeBegin () const
bool operator== (const DiagonalRowVectorConst &y) const
 Binary vector comparison.
size_type N () const
 number of blocks in the vector (are of size 1 here)
size_type dim () const
 dimension of the vector space
size_type rowIndex () const
 index of this row in surrounding matrix
const K & diagonal () const
 the diagonal value

Protected Member Functions

size_type realIndex (int i) const
K * pointer (size_type i) const
DiagonalRowVectorConstoperator& ()

Protected Attributes

K * p_
size_type row_

Friends

class DiagonalMatrixWrapper
class ContainerWrapperIterator< DiagonalRowVectorConst< K, n >, const K, const K & >

Member Typedef Documentation

template<class K, int n>
typedef K Dune::DiagonalRowVectorConst< K, n >::block_type

export the type representing the components

template<class K, int n>
typedef ConstIterator Dune::DiagonalRowVectorConst< K, n >::const_iterator

typedef for stl compliant access

template<class K, int n>
typedef ContainerWrapperIterator<DiagonalRowVectorConst<K,n>, const K, const K&> Dune::DiagonalRowVectorConst< K, n >::ConstIterator

ConstIterator class for sequential access.

template<class K, int n>
typedef K Dune::DiagonalRowVectorConst< K, n >::field_type

export the type representing the field

template<class K, int n>
typedef std::size_t Dune::DiagonalRowVectorConst< K, n >::size_type

The type used for the index access and size operation.

Member Enumeration Documentation

template<class K, int n>
anonymous enum
Enumerator:
dimension 
template<class K, int n>
anonymous enum

We are at the leaf of the block recursion.

Enumerator:
blocklevel 

The number of block levels we contain.

template<class K, int n>
anonymous enum

export size

Enumerator:
size 

The size of this vector.

Constructor & Destructor Documentation

template<class K, int n>
Dune::DiagonalRowVectorConst< K, n >::DiagonalRowVectorConst ( )
inline

Constructor making uninitialized vector.

template<class K, int n>
Dune::DiagonalRowVectorConst< K, n >::DiagonalRowVectorConst ( K *  p,
int  col 
)
inlineexplicit

Constructor making vector with identical coordinates.

Member Function Documentation

template<class K, int n>
ConstIterator Dune::DiagonalRowVectorConst< K, n >::beforeBegin ( ) const
inline
Returns
an iterator that is positioned before the first row of the matrix.
template<class K, int n>
ConstIterator Dune::DiagonalRowVectorConst< K, n >::beforeEnd ( ) const
inline
Returns
an iterator that is positioned before the end iterator of the rows. i.e. at the row.
template<class K, int n>
ConstIterator Dune::DiagonalRowVectorConst< K, n >::begin ( ) const
inline

begin ConstIterator

template<class K, int n>
const K& Dune::DiagonalRowVectorConst< K, n >::diagonal ( ) const
inline

the diagonal value

References Dune::DiagonalRowVectorConst< K, n >::p_.

template<class K, int n>
size_type Dune::DiagonalRowVectorConst< K, n >::dim ( ) const
inline

dimension of the vector space

template<class K, int n>
ConstIterator Dune::DiagonalRowVectorConst< K, n >::end ( ) const
inline

end ConstIterator

template<class K, int n>
bool Dune::DiagonalRowVectorConst< K, n >::identical ( const DiagonalRowVectorConst< K, n > &  other) const
inline
template<class K, int n>
size_type Dune::DiagonalRowVectorConst< K, n >::N ( ) const
inline

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

template<class K, int n>
DiagonalRowVectorConst* Dune::DiagonalRowVectorConst< K, n >::operator& ( )
inlineprotected
template<class K, int n>
bool Dune::DiagonalRowVectorConst< K, n >::operator== ( const DiagonalRowVectorConst< K, n > &  y) const
inline
template<class K, int n>
const K& Dune::DiagonalRowVectorConst< K, n >::operator[] ( size_type  i) const
inline
template<class K, int n>
K* Dune::DiagonalRowVectorConst< K, n >::pointer ( size_type  i) const
inlineprotected
template<class K, int n>
size_type Dune::DiagonalRowVectorConst< K, n >::realIndex ( int  i) const
inlineprotected
template<class K, int n>
size_type Dune::DiagonalRowVectorConst< K, n >::rowIndex ( ) const
inline

index of this row in surrounding matrix

References Dune::DiagonalRowVectorConst< K, n >::row_.

Referenced by Dune::DiagonalRowVectorConst< K, n >::realIndex().

Friends And Related Function Documentation

template<class K, int n>
friend class ContainerWrapperIterator< DiagonalRowVectorConst< K, n >, const K, const K & >
friend
template<class K, int n>
friend class DiagonalMatrixWrapper
friend

Member Data Documentation

template<class K, int n>
K* Dune::DiagonalRowVectorConst< K, n >::p_
protected
template<class K, int n>
size_type Dune::DiagonalRowVectorConst< K, n >::row_
protected

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