Miind
Public Member Functions | List of all members
MPILib::utilities::NodeDistributionInterface Class Referenceabstract

#include <libs/MPILib/include/utilities/NodeDistributionInterface.hpp>

Inheritance diagram for MPILib::utilities::NodeDistributionInterface:
Inheritance graph
Collaboration diagram for MPILib::utilities::NodeDistributionInterface:
Collaboration graph

Public Member Functions

 NodeDistributionInterface ()=default
 
virtual ~NodeDistributionInterface ()=default
 
virtual int getResponsibleProcessor (NodeId nodeId) const =0
 
virtual bool isLocalNode (NodeId nodeId) const =0
 
virtual bool isMaster () const =0
 

Detailed Description

NodeDistributionInterface abstract interface for implementing concrete distributions

Definition at line 33 of file NodeDistributionInterface.hpp.

Constructor & Destructor Documentation

MPILib::utilities::NodeDistributionInterface::NodeDistributionInterface ( )
default

constructor

virtual MPILib::utilities::NodeDistributionInterface::~NodeDistributionInterface ( )
virtualdefault

destructor virtual to allow inheritance

Member Function Documentation

virtual int MPILib::utilities::NodeDistributionInterface::getResponsibleProcessor ( NodeId  nodeId) const
pure virtual

get the processor number which is responsible for the node

Parameters
nodeIdThe Id of the Node
Returns
the processor responsible

Implemented in MPILib::utilities::CircularDistribution.

virtual bool MPILib::utilities::NodeDistributionInterface::isLocalNode ( NodeId  nodeId) const
pure virtual

check is a node is local to the processor

Parameters
nodeIdThe Id of the Node
Returns
true if the Node is local

Implemented in MPILib::utilities::CircularDistribution.

virtual bool MPILib::utilities::NodeDistributionInterface::isMaster ( ) const
pure virtual

If the processor is master (We assume the processor with _processorId=0 is the master)

Returns
true if the node is the master.

Implemented in MPILib::utilities::CircularDistribution.


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