Data Index. More...
#include <Proto_DataIndex.H>
Public Member Functions | |
| DataIndex () | |
| Default Constructor. More... | |
| DataIndex (const std::shared_ptr< P > a_partition, unsigned int a_index) | |
| Explicit Constructor. More... | |
| DataIndex (const DataIndex &other) | |
| Copy constructor. More... | |
| DataIndex & | operator= (const DataIndex &other) |
| Copy assignment. More... | |
| ~DataIndex () | |
| Destructor. More... | |
| bool | operator== (const DataIndex< P > &a_di) const |
| Equality Operator. More... | |
| bool | operator== (const DataIterator< P > &a_iter) const |
| Equality Operator (Overload) More... | |
| bool | operator!= (const DataIndex< P > &a_di) const |
| Inequality Operator. More... | |
| bool | operator!= (const DataIterator< P > &a_iter) const |
| Inequality Operator (Overload) More... | |
| operator int () const | |
| Integer Cast. More... | |
| int | local () const |
| Local Value. More... | |
| int | global () const |
| Local Value. More... | |
| bool | compatible (const DataIndex< P > &a_index) const |
| Compatibility Query. More... | |
| bool | compatible (const P &a_partition) const |
| Compatibility Query. More... | |
| const P & | partition () const |
Protected Attributes | |
| shared_ptr< P > | m_partition |
| int | m_currentInt |
Friends | |
| class | DisjointBoxLayout |
| template<typename PP > | |
| class | DataIterator |
| template<typename PP > | |
| std::ostream & | operator<< (std::ostream &a_os, const DataIndex< PP > &a_index) |
Detailed Description
template<typename P>
class Proto::DataIndex< P >
Data Index.
Data Index is a special object used in tandem with DataIterator. See DataIterator for further documentation.
- Template Parameters
-
P A "Partition" object which defines "layoutness" of the iterable object (see BoxPartition)
Constructor & Destructor Documentation
◆ DataIndex() [1/3]
|
inline |
Default Constructor.
◆ DataIndex() [2/3]
|
inline |
Explicit Constructor.
◆ DataIndex() [3/3]
|
inline |
Copy constructor.
◆ ~DataIndex()
|
inline |
Destructor.
Member Function Documentation
◆ operator=()
|
inline |
Copy assignment.
◆ operator==() [1/2]
|
inline |
Equality Operator.
Referenced by Proto::DataIndex< BoxPartition >::operator==().
◆ operator==() [2/2]
|
inline |
Equality Operator (Overload)
Provided to increase expressiveness and backwards compatibility
◆ operator!=() [1/2]
|
inline |
Inequality Operator.
Referenced by Proto::DataIndex< BoxPartition >::operator!=().
◆ operator!=() [2/2]
|
inline |
Inequality Operator (Overload)
Provided to increase expressiveness and backwards compatibility
◆ operator int()
|
inline |
Integer Cast.
Data Index implicitly casts to the LOCAL index of the iterable. This behavior is used internally to increase code clarity.
◆ local()
|
inline |
Local Value.
Returns the integer value associated with the LOCAL (in the sense of MPI process) index of the iterate.
Referenced by Proto::DataIndex< BoxPartition >::operator int().
◆ global()
|
inline |
Local Value.
Returns the integer value associated with the GLOBAL (in the sense of MPI process) index of the iterate.
◆ compatible() [1/2]
|
inline |
Compatibility Query.
Returns true if the partition associated with *this is compatible with that associated with another index.
Referenced by Proto::CoarseFineBoundary< P >::onCoarseBoundary(), and Proto::CoarseFineBoundary< P >::onFineBoundary().
◆ compatible() [2/2]
|
inline |
Compatibility Query.
Returns true if the partition associated with *this is compatible with another partition.
◆ partition()
|
inline |
Friends And Related Function Documentation
◆ DisjointBoxLayout
|
friend |
◆ DataIterator
◆ operator<<
|
friend |
Member Data Documentation
◆ m_partition
|
protected |
◆ m_currentInt
|
protected |
The documentation for this class was generated from the following files:
