ChunkSparsityPatternIterators::Iterator Class Reference

#include <deal.II/lac/chunk_sparsity_pattern.h>

Public Types
using	size_type = types::global_dof_index

Public Member Functions
	Iterator (const ChunkSparsityPattern *sp, const size_type row)
Iterator &	operator++ ()
Iterator	operator++ (int)
const Accessor &	operator* () const
const Accessor *	operator-> () const
bool	operator== (const Iterator &) const
bool	operator!= (const Iterator &) const
bool	operator< (const Iterator &) const

Private Attributes
Accessor	accessor

Detailed Description

Iterator that walks over the elements of a sparsity pattern.

Definition at line 167 of file chunk_sparsity_pattern.h.

Member Typedef Documentation

size_type

using ChunkSparsityPatternIterators::Iterator::size_type = types::global_dof_index

Declare the type for container size.

Definition at line 173 of file chunk_sparsity_pattern.h.

Constructor & Destructor Documentation

Iterator()

ChunkSparsityPatternIterators::Iterator::Iterator	(	const ChunkSparsityPattern *	sp,
		const size_type	row
	)

Constructor. Create an iterator into the sparsity pattern sp for the given row and the index within it.

Member Function Documentation

operator++() [1/2]

Iterator & ChunkSparsityPatternIterators::Iterator::operator++

(

)

Prefix increment.

operator++() [2/2]

Iterator ChunkSparsityPatternIterators::Iterator::operator++

(

int

)

Postfix increment.

operator*()

const Accessor & ChunkSparsityPatternIterators::Iterator::operator*

(

)

const

Dereferencing operator.

operator->()

const Accessor * ChunkSparsityPatternIterators::Iterator::operator->

(

)

const

Dereferencing operator.

operator==()

bool ChunkSparsityPatternIterators::Iterator::operator==

(

const Iterator &

)

const

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

operator!=()

bool ChunkSparsityPatternIterators::Iterator::operator!=

(

const Iterator &

)

const

Inverse of ==.

operator<()

bool ChunkSparsityPatternIterators::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.

This function is only valid if both iterators point into the same matrix.

Member Data Documentation

accessor

Accessor ChunkSparsityPatternIterators::Iterator::accessor

private

Store an object of the accessor class.

Definition at line 231 of file chunk_sparsity_pattern.h.

---

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

• include/deal.II/lac/chunk_sparsity_pattern.h