Reference documentation for deal.II version Git d902c8c1aa 2019-12-15 00:36:45 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Public Member Functions | List of all members
MatrixTableIterators::Iterator< TableType, Constness, storage_order > Class Template Reference

Iterator class for both matrix-like tables, i.e., Table<2, T> and TransposeTable. More...

#include <deal.II/base/table.h>

Inheritance diagram for MatrixTableIterators::Iterator< TableType, Constness, storage_order >:
[legend]

Public Types

using size_type = typename TableType::size_type
 
using container_pointer_type = typename std::conditional< Constness, const TableType *, TableType * >::type
 
- Public Types inherited from LinearIndexIterator< Iterator< TableType, Constness, storage_order >, Accessor< TableType, Constness, storage_order > >
using iterator_category = std::random_access_iterator_tag
 
using value_type = Accessor< TableType, Constness, storage_order >
 
using difference_type = std::ptrdiff_t
 
using reference = const value_type &
 
using pointer = const value_type *
 
using size_type = typename value_type::size_type
 

Public Member Functions

 Iterator (const Accessor< TableType, Constness, storage_order > &accessor)
 
 Iterator (const container_pointer_type object)
 
 Iterator (const container_pointer_type object, const size_type row, const size_type column)
 
 Iterator (const Iterator< TableType, false, storage_order > &i)
 
 Iterator (const container_pointer_type container, const std::ptrdiff_t linear_index)
 
- Public Member Functions inherited from LinearIndexIterator< Iterator< TableType, Constness, storage_order >, Accessor< TableType, Constness, storage_order > >
Iterator< TableType, Constness, storage_order > & operator= (const Iterator< TableType, Constness, storage_order > &it)
 
Iterator< TableType, Constness, storage_order > & operator++ ()
 
Iterator< TableType, Constness, storage_order > operator++ (int)
 
Iterator< TableType, Constness, storage_order > & operator-- ()
 
Iterator< TableType, Constness, storage_order > operator-- (int)
 
Iterator< TableType, Constness, storage_order > operator+ (const difference_type n) const
 
Iterator< TableType, Constness, storage_order > operator- (const difference_type n) const
 
difference_type operator- (const Iterator< TableType, Constness, storage_order > &p) const
 
Iterator< TableType, Constness, storage_order > & operator+= (const difference_type n)
 
Iterator< TableType, Constness, storage_order > & operator-= (const difference_type n)
 
reference operator* () const
 
pointer operator-> () const
 
bool operator== (const Iterator< TableType, Constness, storage_order > &) const
 
bool operator!= (const Iterator< TableType, Constness, storage_order > &) const
 
bool operator<= (const Iterator< TableType, Constness, storage_order > &) const
 
bool operator>= (const Iterator< TableType, Constness, storage_order > &) const
 
bool operator< (const Iterator< TableType, Constness, storage_order > &) const
 
bool operator> (const Iterator< TableType, Constness, storage_order > &) const
 

Additional Inherited Members

- Protected Member Functions inherited from LinearIndexIterator< Iterator< TableType, Constness, storage_order >, Accessor< TableType, Constness, storage_order > >
 LinearIndexIterator (const Accessor< TableType, Constness, storage_order > accessor)
 
- Protected Attributes inherited from LinearIndexIterator< Iterator< TableType, Constness, storage_order >, Accessor< TableType, Constness, storage_order > >
Accessor< TableType, Constness, storage_order > accessor
 

Detailed Description

template<typename TableType, bool Constness, Storage storage_order>
class MatrixTableIterators::Iterator< TableType, Constness, storage_order >

Iterator class for both matrix-like tables, i.e., Table<2, T> and TransposeTable.

Template Parameters
TableTypethe type of the Table, e.g., Table<2, T> or TransposeTable.
Constnesswhether or not this is a constant iterator.
storage_orderThe storage scheme of the underlying table, e.g., Storage::row_major for Table<2, T>.

Definition at line 848 of file table.h.

Member Typedef Documentation

◆ size_type

template<typename TableType, bool Constness, Storage storage_order>
using MatrixTableIterators::Iterator< TableType, Constness, storage_order >::size_type = typename TableType::size_type

Size type used by the underlying table.

Definition at line 1074 of file table.h.

◆ container_pointer_type

template<typename TableType, bool Constness, Storage storage_order>
using MatrixTableIterators::Iterator< TableType, Constness, storage_order >::container_pointer_type = typename std:: conditional<Constness, const TableType *, TableType *>::type

Type of the stored pointer to the table.

Definition at line 1080 of file table.h.

Constructor & Destructor Documentation

◆ Iterator() [1/5]

template<typename TableType, bool Constness, Storage storage_order>
MatrixTableIterators::Iterator< TableType, Constness, storage_order >::Iterator ( const Accessor< TableType, Constness, storage_order > &  accessor)

Constructor from an accessor.

◆ Iterator() [2/5]

template<typename TableType, bool Constness, Storage storage_order>
MatrixTableIterators::Iterator< TableType, Constness, storage_order >::Iterator ( const container_pointer_type  object)

Constructor. Create the end iterator for a table.

◆ Iterator() [3/5]

template<typename TableType, bool Constness, Storage storage_order>
MatrixTableIterators::Iterator< TableType, Constness, storage_order >::Iterator ( const container_pointer_type  object,
const size_type  row,
const size_type  column 
)

Constructor for a particular table entry.

◆ Iterator() [4/5]

template<typename TableType, bool Constness, Storage storage_order>
MatrixTableIterators::Iterator< TableType, Constness, storage_order >::Iterator ( const Iterator< TableType, false, storage_order > &  i)

Copy constructor from a non-const iterator.

◆ Iterator() [5/5]

template<typename TableType, bool Constness, Storage storage_order>
MatrixTableIterators::Iterator< TableType, Constness, storage_order >::Iterator ( const container_pointer_type  container,
const std::ptrdiff_t  linear_index 
)

Constructor for an entry with a particular linear index.


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