Reference documentation for deal.II version Git 2a81969 2017-11-21 09:22:35 +0100
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)
 
 TableIndices (const unsigned int index0, const unsigned int index1)
 
 TableIndices (const unsigned int index0, const unsigned int index1, const unsigned int index2)
 
 TableIndices (const unsigned int index0, const unsigned int index1, const unsigned int index2, const unsigned int index3)
 
 TableIndices (const unsigned int index0, const unsigned int index1, const unsigned int index2, const unsigned int index3, const unsigned int index4)
 
 TableIndices (const unsigned int index0, const unsigned int index1, const unsigned int index2, const unsigned int index3, const unsigned int index4, const unsigned int index5, 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.

Template Parameters
NThe number of indices stored in each object.
Author
Wolfgang Bangerth, Matthias Maier, 2002, 2015

Definition at line 43 of file table_indices.h.

Constructor & Destructor Documentation

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

Default constructor. This constructor sets all indices to zero.

Definition at line 183 of file table_indices.h.

template<int N>
TableIndices< N >::TableIndices ( const unsigned int  index0)
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 194 of file table_indices.h.

template<int N>
TableIndices< N >::TableIndices ( const unsigned int  index0,
const unsigned int  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 204 of file table_indices.h.

template<int N>
TableIndices< N >::TableIndices ( const unsigned int  index0,
const unsigned int  index1,
const unsigned int  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 216 of file table_indices.h.

template<int N>
TableIndices< N >::TableIndices ( const unsigned int  index0,
const unsigned int  index1,
const unsigned int  index2,
const unsigned int  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 230 of file table_indices.h.

template<int N>
TableIndices< N >::TableIndices ( const unsigned int  index0,
const unsigned int  index1,
const unsigned int  index2,
const unsigned int  index3,
const unsigned int  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 246 of file table_indices.h.

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

Deprecated:
Use the constructor with the appropriate number of arguments to initialize the N indices instead.

Definition at line 264 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 350 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 360 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 370 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 382 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 391 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 401 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 415 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 174 of file table_indices.h.


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