pmap.h

Go to the documentation of this file.

/*
 *  This file is a part of TiledArray.
 *  Copyright (C) 2013  Virginia Tech
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  Justus Calvin
 *  Department of Chemistry, Virginia Tech
 *
 *  pmap.h
 *  April 24, 2012
 *
 */

#ifndef TILEDARRAY_PMAP_H__INCLUDED
#define TILEDARRAY_PMAP_H__INCLUDED

#include <TiledArray/madness.h>
#include <TiledArray/error.h>

namespace TiledArray {


  class Pmap {
  public:
    typedef std::size_t size_type; 
    typedef std::vector<size_type>::const_iterator const_iterator; 

  protected:
    const size_type rank_; 
    const size_type procs_; 
    const size_type size_; 
    std::vector<size_type> local_; 

  private:
    // Not allowed
    Pmap(const Pmap&);
    Pmap& operator=(const Pmap&);

  public:


    Pmap(World& world, const size_type size) :
      rank_(world.rank()), procs_(world.size()), size_(size), local_()
    {
      TA_ASSERT(size_ > 0ul);
    }

    virtual ~Pmap() { }


    virtual size_type owner(const size_type tile) const = 0;


    virtual bool is_local(const size_type tile) const = 0;


    size_type size() const { return size_; }


    size_type rank() const { return rank_; }


    size_type procs() const { return procs_; }


    size_type local_size() const { return local_.size(); }


    bool empty() const { return local_.empty(); }


    virtual bool is_replicated() const { return false; }


    const_iterator begin() const { return local_.begin(); }


    const_iterator end() const { return local_.end(); }

  }; // class Pmap

}  // namespace TiledArray


#endif // TILEDARRAY_PMAP_H__INCLUDED