PartitionData Class Reference

A simple class to encapsulate data regarding a partition in the PMSTClusterMaker owned by a particular process. More...

#include <PartitionData.h>

List of all members.

Public Member Functions
	PartitionData (const int startESTidxValue, const int estCountValue)
	The constructor.
	PartitionData (const int startESTidxValue, const int estCountValue, const int ownedESTCountValue)
	The constructor.
virtual	~PartitionData ()
	The destructor.
virtual int	getPartitionManager () const
virtual int	getWorkerCount () const
Public Attributes
int	startESTidx
	The zero-based index of the first EST in the partition.
int	estCount
	The count of ESTs belonging to the partition.
int	ownedESTCount
	The count of ESTs which are owned by this process.

---

Detailed Description

A simple class to encapsulate data regarding a partition in the PMSTClusterMaker owned by a particular process.

A partition is a subset of the EST data set.

Note:

This class is meant to be used only by the PMSTClusterMaker.

Definition at line 43 of file PartitionData.h.

---

Constructor & Destructor Documentation

PartitionData::PartitionData	(	const int	startESTidxValue,
		const int	estCountValue
	)			[inline]

The constructor.

This constructor simply sets all the instance variables to corresponding values specified by the parameters.

Parameters:

[in]	startESTidxValue	The zero-based index of the EST that marks the beginning of this partition.
[in]	estCountValue	The count of ESTs belonging to this partition.

Definition at line 56 of file PartitionData.h.

PartitionData::PartitionData	(	const int	startESTidxValue,
		const int	estCountValue,
		const int	ownedESTCountValue
	)			[inline]

The constructor.

This constructor simply sets all the instance variables to corresponding values specified by the parameters.

Parameters:

[in]	startESTidxValue	The zero-based index of the EST that marks the beginning of this partition.
[in]	estCountValue	The count of ESTs belonging to this partition.
[in]	ownedESTCountValue	The count of ESTs owned by this partition.

Definition at line 74 of file PartitionData.h.

virtual PartitionData::~PartitionData

(

)

[inline, virtual]

The destructor.

This class does not contain any members that utilize dynamic memory to hold data. Consequently, the destructor has no special tasks to perform and is merely present to adhere to coding conventions.

Definition at line 86 of file PartitionData.h.

---

Member Function Documentation

virtual int PartitionData::getPartitionManager

(

)

const [inline, virtual]

Definition at line 88 of file PartitionData.h.

Referenced by PMSTClusterMaker::getOwnedESTidx(), PMSTClusterMaker::makeClusters(), PMSTClusterMaker::populateCache(), PMSTClusterMaker::sendToWorkers(), and PMSTClusterMaker::worker().

virtual int PartitionData::getWorkerCount

(

)

const [inline, virtual]

Definition at line 91 of file PartitionData.h.

Referenced by PMSTClusterMaker::computeNextESTidx(), PMSTClusterMaker::estAdded(), PMSTClusterMaker::getOwnedESTidx(), PMSTClusterMaker::getOwnerProcess(), PMSTClusterMaker::populateCache(), and PMSTClusterMaker::sendToWorkers().

---

Member Data Documentation

int PartitionData::estCount

The count of ESTs belonging to the partition.

Definition at line 102 of file PartitionData.h.

Referenced by PMSTClusterMaker::getOwnedESTidx(), and PMSTClusterMaker::manager().

int PartitionData::ownedESTCount

The count of ESTs which are owned by this process.

Definition at line 107 of file PartitionData.h.

Referenced by PMSTClusterMaker::makeClusters().

int PartitionData::startESTidx

The zero-based index of the first EST in the partition.

Definition at line 97 of file PartitionData.h.

Referenced by PMSTClusterMaker::getOwnedESTidx(), PMSTClusterMaker::makeClusters(), and PMSTClusterMaker::manager().

---

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

• PartitionData.h