Reference documentation for deal.II version Git 78a8940608 2021-04-17 09:24:19 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MatrixTableIterators::Accessor< TableType, true, storage_order > Class Template Reference

Accessor class offering read-only access to elements of a table. This is the same as the base class. More...

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

Inheritance diagram for MatrixTableIterators::Accessor< TableType, true, storage_order >:
[legend]

Public Types

using value_type = typename AccessorBase< TableType, true, storage_order >::value_type
 
using size_type = typename AccessorBase< TableType, true, storage_order >::size_type
 
using container_pointer_type = typename std::conditional< Constness, const TableType *, TableType *>::type
 

Public Member Functions

const value_typevalue () const
 
 operator const value_type & () const
 
size_type row () const
 
size_type column () const
 

Protected Member Functions

void assert_valid_linear_index () const
 

Protected Attributes

container_pointer_type container
 
std::ptrdiff_t linear_index
 

Detailed Description

template<typename TableType, Storage storage_order>
class MatrixTableIterators::Accessor< TableType, true, storage_order >

Accessor class offering read-only access to elements of a table. This is the same as the base class.

Definition at line 973 of file table.h.

Member Typedef Documentation

◆ value_type

template<typename TableType , Storage storage_order>
using MatrixTableIterators::Accessor< TableType, true, storage_order >::value_type = typename AccessorBase<TableType, true, storage_order>::value_type

Use the base class value type.

Definition at line 981 of file table.h.

◆ size_type

template<typename TableType , Storage storage_order>
using MatrixTableIterators::Accessor< TableType, true, storage_order >::size_type = typename AccessorBase<TableType, true, storage_order>::size_type

Use the base class size type.

Definition at line 987 of file table.h.

◆ container_pointer_type

using MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::container_pointer_type = typename std:: conditional<Constness, const TableType *, TableType *>::type
inherited

Type of the stored pointer to the table.

Definition at line 869 of file table.h.

Member Function Documentation

◆ value()

const value_type& MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::value ( ) const
inherited

Get a constant reference to the value of the element represented by this accessor.

◆ operator const value_type &()

MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::operator const value_type & ( ) const
inherited

Conversion operator that returns a constant reference to the element.

◆ row()

size_type MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::row ( ) const
inherited

Return the row of the current entry.

◆ column()

size_type MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::column ( ) const
inherited

Return the column of the current entry.

◆ assert_valid_linear_index()

void MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::assert_valid_linear_index ( ) const
protectedinherited

Check that linear_index corresponds to an entry that is actually stored by the table (i.e., assert that linear_index is nonnegative and less than container->size()).

Member Data Documentation

◆ container

container_pointer_type MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::container
protectedinherited

Pointer to the table.

Definition at line 943 of file table.h.

◆ linear_index

std::ptrdiff_t MatrixTableIterators::AccessorBase< TableType, Constness, storage_order >::linear_index
protectedinherited

Current index.

Definition at line 948 of file table.h.


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