Reference documentation for deal.II version Git b304a00 2017-03-22 15:49:17 -0600
Public Member Functions | Protected Attributes | Related Functions | List of all members
TableIndices< N > Class Template Reference

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

Inheritance diagram for TableIndices< N >:
[legend]

Public Member Functions

 TableIndices ()
 
 TableIndices (const unsigned int index0, const unsigned int index1=numbers::invalid_unsigned_int, const unsigned int index2=numbers::invalid_unsigned_int, const unsigned int index3=numbers::invalid_unsigned_int, const unsigned int index4=numbers::invalid_unsigned_int, const unsigned int index5=numbers::invalid_unsigned_int, const unsigned int index6=numbers::invalid_unsigned_int, const unsigned int index7=numbers::invalid_unsigned_int, const unsigned int index8=numbers::invalid_unsigned_int)
 
unsigned int operator[] (const unsigned int i) const
 
unsigned int & 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

unsigned int indices [N]
 

Related Functions

(Note that these are not member functions.)

template<int N>
std::ostream & operator<< (std::ostream &out, const TableIndices< N > &indices)
 

Detailed Description

template<int N>
class TableIndices< N >

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.

Author
Wolfgang Bangerth, Matthias Maier, 2002, 2015

Definition at line 41 of file table_indices.h.

Constructor & Destructor Documentation

template<int N>
TableIndices< N >::TableIndices ( )

Default constructor. It sets all indices to zero.

Definition at line 119 of file table_indices.h.

template<int N>
TableIndices< N >::TableIndices ( const unsigned int  index0,
const unsigned int  index1 = numbers::invalid_unsigned_int,
const unsigned int  index2 = numbers::invalid_unsigned_int,
const unsigned int  index3 = numbers::invalid_unsigned_int,
const unsigned int  index4 = numbers::invalid_unsigned_int,
const unsigned int  index5 = numbers::invalid_unsigned_int,
const unsigned int  index6 = numbers::invalid_unsigned_int,
const unsigned int  index7 = numbers::invalid_unsigned_int,
const unsigned int  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.

Template Parameters
NThe number of indices stored in each object.

Definition at line 129 of file table_indices.h.

Member Function Documentation

template<int N>
unsigned int TableIndices< N >::operator[] ( const unsigned int  i) const
inline

Read-only access the value of the ith index.

Definition at line 198 of file table_indices.h.

template<int N>
unsigned int & TableIndices< N >::operator[] ( const unsigned int  i)
inline

Write access the value of the ith index.

Definition at line 208 of file table_indices.h.

template<int N>
bool TableIndices< N >::operator== ( const TableIndices< N > &  other) const
inline

Compare two index fields for equality.

Definition at line 218 of file table_indices.h.

template<int N>
bool TableIndices< N >::operator!= ( const TableIndices< N > &  other) const
inline

Compare two index fields for inequality.

Definition at line 230 of file table_indices.h.

template<int N>
void TableIndices< N >::sort ( )
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 239 of file table_indices.h.

template<int N>
template<class Archive >
void TableIndices< N >::serialize ( Archive &  ar,
const unsigned int  version 
)
inline

Write or read the data of this object to or from a stream for the purpose of serialization.

Definition at line 249 of file table_indices.h.

Friends And Related Function Documentation

template<int N>
std::ostream & operator<< ( std::ostream &  out,
const TableIndices< N > &  indices 
)
related

Output operator for TableIndices objects; reports them in a list like this: [i1,i2,...].

Definition at line 263 of file table_indices.h.

Member Data Documentation

template<int N>
unsigned int TableIndices< N >::indices[N]
protected

Store the indices in an array.

Definition at line 110 of file table_indices.h.


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