Reference documentation for deal.II version Git e512aac53a 2019-11-15 17:29:53 -0500
ChunkSparsityPatternIterators::Accessor Class Reference

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

Inheritance diagram for ChunkSparsityPatternIterators::Accessor:
[legend]

## Public Types

using size_type = types::global_dof_index

## Public Member Functions

Accessor (const ChunkSparsityPattern *matrix, const size_type row)

Accessor (const ChunkSparsityPattern *matrix)

size_type row () const

std::size_t reduced_index () const

size_type column () const

bool is_valid_entry () const

bool operator== (const Accessor &) const

bool operator< (const Accessor &) const

## Protected Attributes

const ChunkSparsityPatternsparsity_pattern

SparsityPatternIterators::Accessor reduced_accessor

size_type chunk_row

size_type chunk_col

## Detailed Description

Accessor class for iterators into sparsity patterns. This class is also the base class for both const and non-const accessor classes into sparse matrices.

Note that this class only allows read access to elements, providing their row and column number. It does not allow modifying the sparsity pattern itself.

Date
2013

Definition at line 65 of file chunk_sparsity_pattern.h.

## ◆ size_type

Declare the type for container size.

Definition at line 71 of file chunk_sparsity_pattern.h.

## ◆ Accessor() [1/2]

 ChunkSparsityPatternIterators::Accessor::Accessor ( const ChunkSparsityPattern * matrix, const size_type row )

Constructor.

## ◆ Accessor() [2/2]

 ChunkSparsityPatternIterators::Accessor::Accessor ( const ChunkSparsityPattern * matrix )

Constructor. Construct the end accessor for the given sparsity pattern.

## ◆ row()

 size_type ChunkSparsityPatternIterators::Accessor::row ( ) const

Row number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.

## ◆ reduced_index()

 std::size_t ChunkSparsityPatternIterators::Accessor::reduced_index ( ) const

Return the global index from the reduced sparsity pattern.

## ◆ column()

 size_type ChunkSparsityPatternIterators::Accessor::column ( ) const

Column number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.

## ◆ is_valid_entry()

 bool ChunkSparsityPatternIterators::Accessor::is_valid_entry ( ) const

Return whether the sparsity pattern entry pointed to by this iterator is valid or not. Note that after compressing the sparsity pattern, all entries are valid. However, before compression, the sparsity pattern allocated some memory to be used while still adding new nonzero entries; if you create iterators in this phase of the sparsity pattern's lifetime, you will iterate over elements that are not valid. If this is so, then this function will return false.

## ◆ operator==()

 bool ChunkSparsityPatternIterators::Accessor::operator== ( const Accessor & ) const

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

## ◆ operator<()

 bool ChunkSparsityPatternIterators::Accessor::operator< ( const Accessor & ) 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 sparsity pattern.

protected

Move the accessor to the next nonzero entry in the matrix.

## ◆ sparsity_pattern

 const ChunkSparsityPattern* ChunkSparsityPatternIterators::Accessor::sparsity_pattern
protected

The sparsity pattern we operate on accessed.

Definition at line 137 of file chunk_sparsity_pattern.h.

## ◆ reduced_accessor

 SparsityPatternIterators::Accessor ChunkSparsityPatternIterators::Accessor::reduced_accessor
protected

The accessor of the (reduced) sparsity pattern.

Definition at line 142 of file chunk_sparsity_pattern.h.

## ◆ chunk_row

 size_type ChunkSparsityPatternIterators::Accessor::chunk_row
protected

Current chunk row number.

Definition at line 147 of file chunk_sparsity_pattern.h.

## ◆ chunk_col

 size_type ChunkSparsityPatternIterators::Accessor::chunk_col
protected

Current chunk col number.

Definition at line 152 of file chunk_sparsity_pattern.h.

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