PlayaGeneralizedIndex.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                 Playa: Programmable Linear Algebra
//                 Copyright 2012 Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */

#ifndef PLAYA_GENERALIZED_INDEX_HPP
#define PLAYA_GENERALIZED_INDEX_HPP

#include "PlayaDefs.hpp"
#include <deque>

namespace Playa
{

/**
 * 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.
 */
class GeneralizedIndex
{
public:
  /** */
  GeneralizedIndex() : blockIndex_(), localIndex_(-1){}

  /** */
  void pushBlockIndex(int b) {blockIndex_.push_back(b);}

  /** */
  void popBlockIndex() {blockIndex_.pop_back();}

  /** */
  int readBlockIndex() const {return blockIndex_.back();}

  /** */
  void setLocalIndex(int i) {localIndex_=i;}

  /** */
  int readLocalIndex() const {return localIndex_;}

  /** */
  int depth() const {return blockIndex_.size();}

  /** */
  const std::deque<int>& blockIndex() const {return blockIndex_;}
  
  
private:
  std::deque<int> blockIndex_;
  int localIndex_;
};

}

#endif