Playa::GeneralizedIndex Class Reference

#include <PlayaGeneralizedIndex.hpp>

List of all members.

Public Member Functions

 GeneralizedIndex ()
void pushBlockIndex (int b)
void popBlockIndex ()
int readBlockIndex () const
void setLocalIndex (int i)
int readLocalIndex () const
int depth () const
const std::deque< int > & blockIndex () const

Detailed Description

GeneralizedIndex is a locator for an element in vector with arbitrary block structure. Together with the processor's rank it can uniquely specify an element in a distributed vector. This object is used in operations such as minloc and maxloc on arbitrarily-structured vectors.

The implementation is a simple pair of (1) a deque giving the sequence of block indices and (2) an integer giving the local offset within the lowest-level block. The integer index is local, i.e., relative to the block pointed to by the block index.

Definition at line 26 of file PlayaGeneralizedIndex.hpp.

Constructor & Destructor Documentation

Playa::GeneralizedIndex::GeneralizedIndex (  )  [inline]

Definition at line 30 of file PlayaGeneralizedIndex.hpp.

Member Function Documentation

void Playa::GeneralizedIndex::pushBlockIndex ( int  b  )  [inline]

Definition at line 33 of file PlayaGeneralizedIndex.hpp.

void Playa::GeneralizedIndex::popBlockIndex (  )  [inline]

Definition at line 36 of file PlayaGeneralizedIndex.hpp.

int Playa::GeneralizedIndex::readBlockIndex (  )  const [inline]

Definition at line 39 of file PlayaGeneralizedIndex.hpp.

void Playa::GeneralizedIndex::setLocalIndex ( int  i  )  [inline]

Definition at line 42 of file PlayaGeneralizedIndex.hpp.

int Playa::GeneralizedIndex::readLocalIndex (  )  const [inline]

Definition at line 45 of file PlayaGeneralizedIndex.hpp.

int Playa::GeneralizedIndex::depth (  )  const [inline]

Definition at line 48 of file PlayaGeneralizedIndex.hpp.

const std::deque<int>& Playa::GeneralizedIndex::blockIndex (  )  const [inline]

Definition at line 51 of file PlayaGeneralizedIndex.hpp.

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