![]() |
Reference documentation for deal.II version 9.1.1
|
#include <deal.II/base/table_indices.h>
Public Member Functions | |
TableIndices () | |
TableIndices (const std::size_t index0) | |
TableIndices (const std::size_t index0, const std::size_t index1) | |
TableIndices (const std::size_t index0, const std::size_t index1, const std::size_t index2) | |
TableIndices (const std::size_t index0, const std::size_t index1, const std::size_t index2, const std::size_t index3) | |
TableIndices (const std::size_t index0, const std::size_t index1, const std::size_t index2, const std::size_t index3, const std::size_t index4) | |
TableIndices (const std::size_t index0, const std::size_t index1, const std::size_t index2, const std::size_t index3, const std::size_t index4, const std::size_t index5, const std::size_t index6=numbers::invalid_unsigned_int, const std::size_t index7=numbers::invalid_unsigned_int, const std::size_t index8=numbers::invalid_unsigned_int) | |
std::size_t | operator[] (const unsigned int i) const |
std::size_t & | operator[] (const unsigned int i) |
bool | operator== (const TableIndices< N > &other) const |
bool | operator!= (const TableIndices< N > &other) const |
void | sort () |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Protected Attributes | |
std::size_t | indices [N] |
Related Functions | |
(Note that these are not member functions.) | |
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 44 of file table_indices.h.
TableIndices< N >::TableIndices | ( | ) |
Default constructor. This constructor sets all indices to zero.
Definition at line 190 of file table_indices.h.
|
explicit |
Constructor. This is the appropriate constructor for an object of type TableIndices<1> and initializes the single index with index0
.
This constructor will result in a compiler error if the template argument N
is different from one.
Definition at line 199 of file table_indices.h.
TableIndices< N >::TableIndices | ( | const std::size_t | index0, |
const std::size_t | index1 | ||
) |
Constructor. This is the appropriate constructor for an object of type TableIndices<2> and initializes the indices stored by this object by the given arguments.
This constructor will result in a compiler error if the template argument N
is different from two.
Definition at line 209 of file table_indices.h.
TableIndices< N >::TableIndices | ( | const std::size_t | index0, |
const std::size_t | index1, | ||
const std::size_t | index2 | ||
) |
Constructor. This is the appropriate constructor for an object of type TableIndices<3> and initializes the indices stored by this object by the given arguments.
This constructor will result in a compiler error if the template argument N
is different from three.
Definition at line 221 of file table_indices.h.
TableIndices< N >::TableIndices | ( | const std::size_t | index0, |
const std::size_t | index1, | ||
const std::size_t | index2, | ||
const std::size_t | index3 | ||
) |
Constructor. This is the appropriate constructor for an object of type TableIndices<4> and initializes the indices stored by this object by the given arguments.
This constructor will result in a compiler error if the template argument N
is different from four.
Definition at line 235 of file table_indices.h.
TableIndices< N >::TableIndices | ( | const std::size_t | index0, |
const std::size_t | index1, | ||
const std::size_t | index2, | ||
const std::size_t | index3, | ||
const std::size_t | index4 | ||
) |
Constructor. This is the appropriate constructor for an object of type TableIndices<5> and initializes the indices stored by this object by the given arguments.
This constructor will result in a compiler error if the template argument N
is different from five.
Definition at line 251 of file table_indices.h.
TableIndices< N >::TableIndices | ( | const std::size_t | index0, |
const std::size_t | index1, | ||
const std::size_t | index2, | ||
const std::size_t | index3, | ||
const std::size_t | index4, | ||
const std::size_t | index5, | ||
const std::size_t | index6 = numbers::invalid_unsigned_int , |
||
const std::size_t | index7 = numbers::invalid_unsigned_int , |
||
const std::size_t | index8 = numbers::invalid_unsigned_int |
||
) |
Convenience constructor that takes up to 9 arguments. It can be used to populate a TableIndices object upon creation, either completely, or partially.
Index entries that are not set by these arguments (either because they are omitted, or because \(N > 9\)) are set to numbers::invalid_unsigned_int.
Note that only the first N
arguments are actually used.
N
indices instead. Definition at line 269 of file table_indices.h.
|
inline |
Read-only access the value of the i
th index.
Definition at line 357 of file table_indices.h.
|
inline |
Write access the value of the i
th index.
Definition at line 365 of file table_indices.h.
|
inline |
Compare two index fields for equality.
Definition at line 374 of file table_indices.h.
|
inline |
Compare two index fields for inequality.
Definition at line 385 of file table_indices.h.
|
inline |
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 393 of file table_indices.h.
|
inline |
Write or read the data of this object to or from a stream for the purpose of serialization.
Definition at line 402 of file table_indices.h.
|
related |
Output operator for TableIndices objects; reports them in a list like this: [i1,i2,...]
.
Definition at line 416 of file table_indices.h.
|
protected |
Store the indices in an array.
Definition at line 181 of file table_indices.h.