Reference documentation for deal.II version 9.2.0
\(\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 | List of all members
Table< 5, T > Class Template Reference

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

Inheritance diagram for Table< 5, T >:
[legend]

Public Types

using size_type = typename TableBase< 5, T >::size_type
 
- Public Types inherited from TableBase< 5, T >
using value_type = T
 
using size_type = typename AlignedVector< T >::size_type
 

Public Member Functions

 Table ()=default
 
 Table (const size_type size1, const size_type size2, const size_type size3, const size_type size4, const size_type size5)
 
::internal::TableBaseAccessors::Accessor< 5, T, true, 4 > operator[] (const size_type i) const
 
::internal::TableBaseAccessors::Accessor< 5, T, false, 4 > operator[] (const size_type i)
 
AlignedVector< T >::const_reference operator() (const size_type i, const size_type j, const size_type k, const size_type l, const size_type m) const
 
AlignedVector< T >::reference operator() (const size_type i, const size_type j, const size_type k, const size_type l, const size_type m)
 
AlignedVector< T >::reference operator() (const TableIndices< 5 > &indices)
 
AlignedVector< T >::const_reference operator() (const TableIndices< 5 > &indices) const
 
- Public Member Functions inherited from TableBase< 5, T >
 TableBase ()=default
 
 TableBase (const TableIndices< N > &sizes)
 
 TableBase (const TableIndices< N > &sizes, InputIterator entries, const bool C_style_indexing=true)
 
 TableBase (const TableBase< N, T > &src)
 
 TableBase (const TableBase< N, T2 > &src)
 
 TableBase (TableBase< N, T > &&src) noexcept
 
 ~TableBase () override=default
 
TableBase< N, T > & operator= (const TableBase< N, T > &src)
 
TableBase< N, T > & operator= (const TableBase< N, T2 > &src)
 
TableBase< N, T > & operator= (TableBase< N, T > &&src) noexcept
 
bool operator== (const TableBase< N, T > &T2) const
 
void reset_values ()
 
void reinit (const TableIndices< N > &new_size, const bool omit_default_initialization=false)
 
size_type size (const unsigned int i) const
 
const TableIndices< N > & size () const
 
size_type n_elements () const
 
bool empty () const
 
void fill (InputIterator entries, const bool C_style_indexing=true)
 
void fill (const T &value)
 
AlignedVector< T >::reference operator() (const TableIndices< N > &indices)
 
AlignedVector< T >::const_reference operator() (const TableIndices< N > &indices) const
 
void swap (TableBase< N, T > &v)
 
std::size_t memory_consumption () const
 
void serialize (Archive &ar, const unsigned int version)
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
- Protected Member Functions inherited from TableBase< 5, T >
size_type position (const TableIndices< N > &indices) const
 
AlignedVector< T >::reference el (const TableIndices< N > &indices)
 
AlignedVector< T >::const_reference el (const TableIndices< N > &indices) const
 
- Protected Attributes inherited from TableBase< 5, T >
AlignedVector< T > values
 
TableIndices< N > table_size
 

Detailed Description

template<typename T>
class Table< 5, T >

A class representing a five-dimensional table of objects (not necessarily only numbers).

For the rationale of this class, and a description of the interface, see the base class.

Author
Wolfgang Bangerth, Ralf Hartmann 2002

Definition at line 1602 of file table.h.

Member Typedef Documentation

◆ size_type

template<typename T >
using Table< 5, T >::size_type = typename TableBase<5, T>::size_type

Integer type used to count the number of elements in this container.

Definition at line 1608 of file table.h.

Constructor & Destructor Documentation

◆ Table() [1/2]

template<typename T >
Table< 5, T >::Table ( )
default

Default constructor. Set all dimensions to zero.

◆ Table() [2/2]

template<typename T >
Table< 5, T >::Table ( const size_type  size1,
const size_type  size2,
const size_type  size3,
const size_type  size4,
const size_type  size5 
)

Constructor. Pass down the given dimensions to the base class.

Member Function Documentation

◆ operator[]() [1/2]

template<typename T >
::internal::TableBaseAccessors::Accessor<5, T, true, 4> Table< 5, T >::operator[] ( const size_type  i) const

Access operator. Generate an object that accesses the requested four- dimensional subobject of this five-dimensional table. Range checks are performed.

This version of the function only allows read access.

◆ operator[]() [2/2]

template<typename T >
::internal::TableBaseAccessors::Accessor<5, T, false, 4> Table< 5, T >::operator[] ( const size_type  i)

Access operator. Generate an object that accesses the requested four- dimensional subobject of this five-dimensional table. Range checks are performed.

This version of the function allows read-write access.

◆ operator()() [1/4]

template<typename T >
AlignedVector<T>::const_reference Table< 5, T >::operator() ( const size_type  i,
const size_type  j,
const size_type  k,
const size_type  l,
const size_type  m 
) const

Direct access to one element of the table by specifying all indices at the same time. Range checks are performed.

This version of the function only allows read access.

◆ operator()() [2/4]

template<typename T >
AlignedVector<T>::reference Table< 5, T >::operator() ( const size_type  i,
const size_type  j,
const size_type  k,
const size_type  l,
const size_type  m 
)

Direct access to one element of the table by specifying all indices at the same time. Range checks are performed.

This version of the function allows read-write access.

◆ operator()() [3/4]

template<typename T >
AlignedVector<T>::reference Table< 5, T >::operator() ( const TableIndices< 5 > &  indices)

Make the corresponding operator () from the TableBase base class available also in this class.

◆ operator()() [4/4]

template<typename T >
AlignedVector<T>::const_reference Table< 5, T >::operator() ( const TableIndices< 5 > &  indices) const

Make the corresponding operator () from the TableBase base class available also in this class.


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