Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
BlockMatrixIterators::Accessor< BlockMatrix, true > Class Template Reference

#include <block_matrix_base.h>

Inheritance diagram for BlockMatrixIterators::Accessor< BlockMatrix, true >:
[legend]

Public Types

typedef types::global_dof_index size_type
 
typedef const BlockMatrix MatrixType
 
typedef BlockMatrix::value_type value_type
 
- Public Types inherited from BlockMatrixIterators::AccessorBase< BlockMatrix >
typedef types::global_dof_index size_type
 
typedef BlockMatrix::value_type value_type
 

Public Member Functions

 Accessor (const BlockMatrix *m, const size_type row, const size_type col)
 
 Accessor (const Accessor< BlockMatrix, false > &)
 
size_type row () const
 
size_type column () const
 
value_type value () const
 
- Public Member Functions inherited from BlockMatrixIterators::AccessorBase< BlockMatrix >
 AccessorBase ()
 
unsigned int block_row () const
 
unsigned int block_column () const
 

Protected Member Functions

void advance ()
 
bool operator== (const Accessor &a) const
 

Protected Attributes

const BlockMatrix * matrix
 
BlockMatrix::BlockType::const_iterator base_iterator
 
- Protected Attributes inherited from BlockMatrixIterators::AccessorBase< BlockMatrix >
unsigned int row_block
 
unsigned int col_block
 

Friends

template<typename >
class ::MatrixIterator
 

Detailed Description

template<class BlockMatrix>
class BlockMatrixIterators::Accessor< BlockMatrix, true >

Block matrix accessor for constant matrices, implementing the stepping through a matrix.

Definition at line 225 of file block_matrix_base.h.

Member Typedef Documentation

template<class BlockMatrix >
typedef types::global_dof_index BlockMatrixIterators::Accessor< BlockMatrix, true >::size_type

Declare type for container size.

Definition at line 233 of file block_matrix_base.h.

template<class BlockMatrix >
typedef const BlockMatrix BlockMatrixIterators::Accessor< BlockMatrix, true >::MatrixType

Type of the matrix used in this accessor.

Definition at line 239 of file block_matrix_base.h.

template<class BlockMatrix >
typedef BlockMatrix::value_type BlockMatrixIterators::Accessor< BlockMatrix, true >::value_type

Typedef the value type of the matrix we point into.

Definition at line 245 of file block_matrix_base.h.

Constructor & Destructor Documentation

template<class BlockMatrix >
BlockMatrixIterators::Accessor< BlockMatrix, true >::Accessor ( const BlockMatrix *  m,
const size_type  row,
const size_type  col 
)

Constructor. Since we use accessors only for read access, a const matrix pointer is sufficient.

Place the iterator at the beginning of the given row of the matrix, or create the end pointer if row equals the total number of rows in the matrix.

template<class BlockMatrix >
BlockMatrixIterators::Accessor< BlockMatrix, true >::Accessor ( const Accessor< BlockMatrix, false > &  )

Initalize const accessor from non const accessor.

Member Function Documentation

template<class BlockMatrix >
size_type BlockMatrixIterators::Accessor< BlockMatrix, true >::row ( ) const

Row number of the element represented by this object.

template<class BlockMatrix >
size_type BlockMatrixIterators::Accessor< BlockMatrix, true >::column ( ) const

Column number of the element represented by this object.

template<class BlockMatrix >
value_type BlockMatrixIterators::Accessor< BlockMatrix, true >::value ( ) const

Value of the entry at the current position.

template<class BlockMatrix >
void BlockMatrixIterators::Accessor< BlockMatrix, true >::advance ( )
protected

Move ahead one element.

template<class BlockMatrix >
bool BlockMatrixIterators::Accessor< BlockMatrix, true >::operator== ( const Accessor< BlockMatrix, true > &  a) const
protected

Compare this accessor with another one for equality.

Friends And Related Function Documentation

template<class BlockMatrix >
template<typename >
friend class ::MatrixIterator
friend

Let the iterator class be a friend.

Definition at line 316 of file block_matrix_base.h.

Member Data Documentation

template<class BlockMatrix >
const BlockMatrix* BlockMatrixIterators::Accessor< BlockMatrix, true >::matrix
protected

The matrix accessed.

Definition at line 292 of file block_matrix_base.h.

template<class BlockMatrix >
BlockMatrix::BlockType::const_iterator BlockMatrixIterators::Accessor< BlockMatrix, true >::base_iterator
protected

Iterator of the underlying matrix class.

Definition at line 298 of file block_matrix_base.h.


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