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 | Private Attributes | Friends | List of all members
TrilinosWrappers::SparsityPatternIterators::Iterator Class Reference

#include <trilinos_sparsity_pattern.h>

Public Types

typedef ::types::global_dof_index size_type
 

Public Member Functions

 Iterator (const SparsityPattern *sparsity_pattern, const size_type row, const size_type index)
 
 Iterator (const Iterator &i)
 
Iteratoroperator++ ()
 
Iterator operator++ (int)
 
const Accessoroperator* () const
 
const Accessoroperator-> () const
 
bool operator== (const Iterator &) const
 
bool operator!= (const Iterator &) const
 
bool operator< (const Iterator &) const
 
 DeclException2 (ExcInvalidIndexWithinRow, size_type, size_type,<< "Attempt to access element "<< arg2<< " of row "<< arg1<< " which doesn't have that many elements.")
 

Private Attributes

Accessor accessor
 

Friends

class TrilinosWrappers::SparsityPattern
 

Detailed Description

Iterator class for sparsity patterns of type TrilinosWrappers::SparsityPattern. Access to individual elements of the sparsity pattern is handled by the Accessor class in this namespace.

Definition at line 193 of file trilinos_sparsity_pattern.h.

Member Typedef Documentation

Declare type for container size.

Definition at line 199 of file trilinos_sparsity_pattern.h.

Constructor & Destructor Documentation

TrilinosWrappers::SparsityPatternIterators::Iterator::Iterator ( const SparsityPattern sparsity_pattern,
const size_type  row,
const size_type  index 
)

Constructor. Create an iterator into the matrix matrix for the given row and the index within it.

TrilinosWrappers::SparsityPatternIterators::Iterator::Iterator ( const Iterator i)

Copy constructor.

Member Function Documentation

Iterator& TrilinosWrappers::SparsityPatternIterators::Iterator::operator++ ( )

Prefix increment.

Iterator TrilinosWrappers::SparsityPatternIterators::Iterator::operator++ ( int  )

Postfix increment.

const Accessor& TrilinosWrappers::SparsityPatternIterators::Iterator::operator* ( ) const

Dereferencing operator.

const Accessor* TrilinosWrappers::SparsityPatternIterators::Iterator::operator-> ( ) const

Dereferencing operator.

bool TrilinosWrappers::SparsityPatternIterators::Iterator::operator== ( const Iterator ) const

Comparison. True, if both iterators point to the same matrix position.

bool TrilinosWrappers::SparsityPatternIterators::Iterator::operator!= ( const Iterator ) const

Inverse of ==.

bool TrilinosWrappers::SparsityPatternIterators::Iterator::operator< ( const Iterator ) const

Comparison operator. Result is true if either the first row number is smaller or if the row numbers are equal and the first index is smaller.

TrilinosWrappers::SparsityPatternIterators::Iterator::DeclException2 ( ExcInvalidIndexWithinRow  ,
size_type  ,
size_type  ,
<< "Attempt to access element "<< arg2<< " of row "<< arg1<< " which doesn't have that many elements."   
)

Exception

Member Data Documentation

Accessor TrilinosWrappers::SparsityPatternIterators::Iterator::accessor
private

Store an object of the accessor class.

Definition at line 272 of file trilinos_sparsity_pattern.h.


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