![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/base/table_indices.h>
Public Member Functions | |
constexpr | TableIndices ()=default |
template<typename... T> | |
constexpr | TableIndices (const T... indices) |
constexpr std::size_t | operator[] (const unsigned int i) const |
constexpr std::size_t & | operator[] (const unsigned int i) |
constexpr bool | operator== (const TableIndices< N > &other) const |
constexpr bool | operator!= (const TableIndices< N > &other) const |
DEAL_II_HOST constexpr void | sort () |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Protected Attributes | |
std::size_t | indices [N] {} |
Related Symbols | |
(Note that these are not member symbols.) | |
template<int N> | |
std::ostream & | operator<< (std::ostream &out, const TableIndices< N > &indices) |
A class representing a fixed size array of indices.
It is used in tensorial objects like the TableBase and SymmetricTensor classes to represent a nested choice of indices.
N | The number of indices stored in each object. |
Definition at line 43 of file table_indices.h.
|
constexprdefault |
Default constructor. This constructor sets all indices to zero.
|
constexpr |
Constructor. Initializes the indices stored by this object by the given arguments indices
This constructor will result in a compiler error if the number of arguments given is different from the number of the indices this class stores (i.e., the template argument N
of this class), or if any of the arguments is not of some integer type.
Definition at line 121 of file table_indices.h.
|
inlineconstexpr |
Read-only access the value of the i
th index.
Definition at line 133 of file table_indices.h.
|
inlineconstexpr |
Write access the value of the i
th index.
Definition at line 142 of file table_indices.h.
|
constexpr |
Compare two index fields for equality.
Definition at line 151 of file table_indices.h.
|
constexpr |
Compare two index fields for inequality.
Definition at line 161 of file table_indices.h.
|
inlineconstexpr |
Sort the indices in ascending order. While this operation is not very useful for Table objects, it is used for the SymmetricTensor class.
Definition at line 169 of file table_indices.h.
|
inline |
Write or read the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
Definition at line 178 of file table_indices.h.
|
related |
Output operator for TableIndices objects; reports them in a list like this: [i1,i2,...]
.
Definition at line 191 of file table_indices.h.
|
protected |
Store the indices in an array.
Definition at line 112 of file table_indices.h.