/home/brandes/workspace/LAMA/src/lama/CommunicationPlan.hpp

Go to the documentation of this file.

#ifndef LAMA_COMMUNICATION_PLAN_HPP_
#define LAMA_COMMUNICATION_PLAN_HPP_

// for dll_import
#include <lama/config.hpp>

// base classes
#include <lama/Printable.hpp>

// others
#include <lama/LAMATypes.hpp>
#include <lama/LAMAArray.hpp>

// logging
#include <logging/logging.hpp>

#include <vector>

namespace lama
{

class Communicator;   // forward declaration

class LAMA_DLL_IMPORTEXPORT CommunicationPlan : public Printable
{
public:

    struct Entry
    {
        PartitionId partitionId;  
        IndexType   quantity;     
        IndexType   offset;       
    };

    CommunicationPlan();

    void clear();

    CommunicationPlan(const LAMAArray<IndexType>& quantities, bool compressFlag = true );

    CommunicationPlan(const PartitionId noPartitions,
                      const std::vector<PartitionId>& owners,
                      bool compressFlag = true );

    CommunicationPlan( const CommunicationPlan& other, const IndexType quantities[] );

    CommunicationPlan( const CommunicationPlan& other, const IndexType n );

    virtual ~CommunicationPlan();

    void allocate(const LAMAArray<IndexType>& quantities, bool compressFlag = true);

    void allocate(const PartitionId noPartitions,
                  const std::vector<PartitionId>& owners, bool compressFlag = true);

    void allocateTranspose( const CommunicationPlan& plan, const Communicator& comm);

    bool allocated() const;

    void compress();

    bool compressed() const;

    inline PartitionId size() const;

    inline IndexType totalQuantity() const;

    IndexType maxQuantity() const;

    inline const Entry& operator[](const PartitionId index) const;

    void writeAt( std::ostream& stream ) const;

private:

    bool                mAllocated;    

    bool                mCompressed;   

    std::vector<Entry>  mEntries;      

    IndexType mQuantity;    

    LAMA_LOG_DECL_STATIC_LOGGER(logger);
};

/* ----------------------------------------------------------------------*/

PartitionId CommunicationPlan::size() const
{
    return static_cast<PartitionId>( mEntries.size() );
}

const CommunicationPlan::Entry& CommunicationPlan::operator[]
     (const PartitionId id) const
{
    return mEntries.at(id);
}

IndexType CommunicationPlan::totalQuantity() const
{
    return mQuantity;
}

}

#endif // LAMA_COMMUNICATION_PLAN_HPP_