CkArrayOptions Class Reference

Arguments for array creation:. More...

#include <ckarrayoptions.h>

Collaboration diagram for CkArrayOptions:


Public Member Functions
	CkArrayOptions (void)
	Default: empty array.
	CkArrayOptions (int ndims, int dims[])
	With initial elements nD.
	CkArrayOptions (int ni1_)
	With initial elements 1D.
	CkArrayOptions (int ni1_, int ni2_)
	With initial elements 2D.
	CkArrayOptions (int ni1_, int ni2_, int ni3)
	With initial elements 3D.
	CkArrayOptions (short ni1_, short ni2_, short ni3, short ni4_)
	With initial elements 4D.
	CkArrayOptions (short ni1_, short ni2_, short ni3, short ni4_, short ni5_)
	With initial elements 5D.
	CkArrayOptions (short ni1_, short ni2_, short ni3, short ni4_, short ni5_, short ni6_)
	With initial elements 6D.
	CkArrayOptions (CkArrayIndex s, CkArrayIndex e, CkArrayIndex step)
	Initialize the start, end, and step.
CkArrayOptions &	setStart (CkArrayIndex s)
	These functions return "this" so you can string them together, e.g.
CkArrayOptions &	setEnd (CkArrayIndex e)
CkArrayOptions &	setStep (CkArrayIndex s)
CkArrayOptions &	setNumInitial (int ni)
	Create this many initial elements 1D.
CkArrayOptions &	setNumInitial (int ni1, int ni2)
	Create this many initial elements 2D.
CkArrayOptions &	setNumInitial (int ni1, int ni2, int ni3)
	Create this many initial elements 3D.
CkArrayOptions &	setNumInitial (short ni1, short ni2, short ni3, short ni4)
	Create this many initial elements 4D.
CkArrayOptions &	setNumInitial (short ni1, short ni2, short ni3, short ni4, short ni5)
	Create this many initial elements 5D.
CkArrayOptions &	setNumInitial (short ni1, short ni2, short ni3, short ni4, short ni5, short ni6)
	Create this many initial elements 6D.
CkArrayOptions &	setBounds (int ni)
	Allow up to this many elements in 1D.
CkArrayOptions &	setBounds (int ni1, int ni2)
	Allow up to this many elements in 2D.
CkArrayOptions &	setBounds (int ni1, int ni2, int ni3)
	Allow up to this many elements in 3D.
CkArrayOptions &	setBounds (short ni1, short ni2, short ni3, short ni4)
	Allow up to this many elements in 4D.
CkArrayOptions &	setBounds (short ni1, short ni2, short ni3, short ni4, short ni5)
	Allow up to this many elements in 5D.
CkArrayOptions &	setBounds (short ni1, short ni2, short ni3, short ni4, short ni5, short ni6)
	Allow up to this many elements in 6D.
CkArrayOptions &	setMap (const CkGroupID &m)
	Use this location map.
CkArrayOptions &	bindTo (const CkArrayID &b)
	Bind our elements to this array.
CkArrayOptions &	setLocationManager (const CkGroupID &l)
	Use this location manager.
CkArrayOptions &	setMcastManager (const CkGroupID &m)
	Use this ckmulticast manager.
CkArrayOptions &	addListener (CkArrayListener *listener)
	Add an array listener component to this array (keeps the new'd listener).
CkArrayOptions &	setAnytimeMigration (bool b)
CkArrayOptions &	setStaticInsertion (bool b)
CkArrayOptions &	setBroadcastViaScheduler (bool b)
CkArrayOptions &	setSectionAutoDelegate (bool b)
CkArrayOptions &	setReductionClient (CkCallback cb)
CkArrayOptions &	setInitCallback (CkCallback cb)
const CkArrayIndex &	getStart (void) const
const CkArrayIndex &	getEnd (void) const
const CkArrayIndex &	getStep (void) const
const CkArrayIndex &	getNumInitial (void) const
const CkArrayIndex &	getBounds (void) const
const CkGroupID &	getMap (void) const
const CkGroupID &	getLocationManager (void) const
const CkGroupID &	getMcastManager (void) const
bool	isSectionAutoDelegated (void) const
const CkCallback &	getInitCallback (void) const
int	getListeners (void) const
CkArrayListener *	getListener (int listenerNum)
void	pup (PUP::er &p)
Private Member Functions
void	init ()
	Set various safe defaults for all the constructors.
void	updateIndices ()
	Helper functions to keep numInitial and start/step/end consistent.
void	updateNumInitial ()
Private Attributes
CkArrayIndex	start
CkArrayIndex	end
CkArrayIndex	step
CkArrayIndex	numInitial
	Number of elements to create.
CkArrayIndex	bounds
	Limits of element counts in each dimension of this and all bound arrays.
CkGroupID	map
	Array location map object.
CkGroupID	locMgr
	Location manager to bind to.
CkGroupID	mCastMgr
CkPupAblePtrVec< CkArrayListener >	arrayListeners
	<ckmulticast mgr to bind to, for sections
CkCallback	reductionClient
CkCallback	initCallback
bool	anytimeMigration
bool	disableNotifyChildInRed
bool	staticInsertion
bool	broadcastViaScheduler
bool	sectionAutoDelegate
Friends
class	CkArray

Detailed Description

Arguments for array creation:.

Definition at line 69 of file ckarrayoptions.h.

Constructor & Destructor Documentation

CkArrayOptions::CkArrayOptions ( void )

Default: empty array.

Definition at line 5 of file ckarrayoptions.C.

References init().

Here is the call graph for this function:

CkArrayOptions::CkArrayOptions	(	int	ndims,
		int	dims[]
	)

With initial elements nD.

Definition at line 15 of file ckarrayoptions.C.

References init().

Here is the call graph for this function:

CkArrayOptions::CkArrayOptions ( int ni1_ )

With initial elements 1D.

Definition at line 25 of file ckarrayoptions.C.

References init().

Here is the call graph for this function:

CkArrayOptions::CkArrayOptions	(	int	ni1_,
		int	ni2_
	)

With initial elements 2D.

Definition at line 35 of file ckarrayoptions.C.

References init().

Here is the call graph for this function:

CkArrayOptions::CkArrayOptions	(	int	ni1_,
		int	ni2_,
		int	ni3
	)

With initial elements 3D.

Definition at line 45 of file ckarrayoptions.C.

References init().

Here is the call graph for this function:

CkArrayOptions::CkArrayOptions	(	short	ni1_,
		short	ni2_,
		short	ni3,
		short	ni4_
	)

With initial elements 4D.

CkArrayOptions::CkArrayOptions	(	short	ni1_,
		short	ni2_,
		short	ni3,
		short	ni4_,
		short	ni5_
	)

With initial elements 5D.

CkArrayOptions::CkArrayOptions	(	short	ni1_,
		short	ni2_,
		short	ni3,
		short	ni4_,
		short	ni5_,
		short	ni6_
	)

With initial elements 6D.

CkArrayOptions::CkArrayOptions	(	CkArrayIndex	s,
		CkArrayIndex	e,
		CkArrayIndex	step
	)

Initialize the start, end, and step.

Definition at line 89 of file ckarrayoptions.C.

References init().

Here is the call graph for this function:

Member Function Documentation

void CkArrayOptions::init ( ) [private]

Set various safe defaults for all the constructors.

Definition at line 99 of file ckarrayoptions.C.

References _isAnytimeMigration, _isNotifyChildInRed, _isStaticInsertion, anytimeMigration, broadcastViaScheduler, disableNotifyChildInRed, CkCallback::invalid, locMgr, mCastMgr, reductionClient, sectionAutoDelegate, _ckGroupID::setZero(), staticInsertion, and CkCallback::type.

Referenced by CkArrayOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

void CkArrayOptions::updateIndices ( ) [private]

Helper functions to keep numInitial and start/step/end consistent.

Definition at line 130 of file ckarrayoptions.C.

References PUP::d, end, numInitial, start, and step.

Referenced by setNumInitial().

Here is the caller graph for this function:

void CkArrayOptions::updateNumInitial ( ) [private]

Definition at line 145 of file ckarrayoptions.C.

References PUP::d, end, numInitial, start, and step.

Referenced by setEnd(), setStart(), and setStep().

Here is the caller graph for this function:

CkArrayOptions& CkArrayOptions::setStart ( CkArrayIndex s ) [inline]

These functions return "this" so you can string them together, e.g.

: foo(CkArrayOptions().setMap(mid).bindTo(aid)); Set the start, end, and step for the initial elements to populate

Definition at line 117 of file ckarrayoptions.h.

References start, and updateNumInitial().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setEnd ( CkArrayIndex e ) [inline]

Definition at line 122 of file ckarrayoptions.h.

References end, and updateNumInitial().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setStep ( CkArrayIndex s ) [inline]

Definition at line 127 of file ckarrayoptions.h.

References step, and updateNumInitial().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setNumInitial ( int ni ) [inline]

Create this many initial elements 1D.

Definition at line 134 of file ckarrayoptions.h.

References numInitial, and updateIndices().

Referenced by liveVizInit().

Here is the call graph for this function:

Here is the caller graph for this function:

CkArrayOptions& CkArrayOptions::setNumInitial	(	int	ni1,
		int	ni2
	)			`[inline]`

Create this many initial elements 2D.

Definition at line 140 of file ckarrayoptions.h.

References numInitial, and updateIndices().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setNumInitial	(	int	ni1,
		int	ni2,
		int	ni3
	)			`[inline]`

Create this many initial elements 3D.

Definition at line 146 of file ckarrayoptions.h.

References numInitial, and updateIndices().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setNumInitial	(	short	ni1,
		short	ni2,
		short	ni3,
		short	ni4
	)			`[inline]`

Create this many initial elements 4D.

Definition at line 152 of file ckarrayoptions.h.

References numInitial, and updateIndices().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setNumInitial	(	short	ni1,
		short	ni2,
		short	ni3,
		short	ni4,
		short	ni5
	)			`[inline]`

Create this many initial elements 5D.

Definition at line 158 of file ckarrayoptions.h.

References numInitial, and updateIndices().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setNumInitial	(	short	ni1,
		short	ni2,
		short	ni3,
		short	ni4,
		short	ni5,
		short	ni6
	)			`[inline]`

Create this many initial elements 6D.

Definition at line 164 of file ckarrayoptions.h.

References numInitial, and updateIndices().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setBounds ( int ni ) [inline]

Allow up to this many elements in 1D.

Definition at line 172 of file ckarrayoptions.h.

References bounds.

CkArrayOptions& CkArrayOptions::setBounds	(	int	ni1,
		int	ni2
	)			`[inline]`

Allow up to this many elements in 2D.

Definition at line 177 of file ckarrayoptions.h.

References bounds.

CkArrayOptions& CkArrayOptions::setBounds	(	int	ni1,
		int	ni2,
		int	ni3
	)			`[inline]`

Allow up to this many elements in 3D.

Definition at line 182 of file ckarrayoptions.h.

References bounds.

CkArrayOptions& CkArrayOptions::setBounds	(	short	ni1,
		short	ni2,
		short	ni3,
		short	ni4
	)			`[inline]`

Allow up to this many elements in 4D.

Definition at line 187 of file ckarrayoptions.h.

References bounds.

CkArrayOptions& CkArrayOptions::setBounds	(	short	ni1,
		short	ni2,
		short	ni3,
		short	ni4,
		short	ni5
	)			`[inline]`

Allow up to this many elements in 5D.

Definition at line 192 of file ckarrayoptions.h.

References bounds.

CkArrayOptions& CkArrayOptions::setBounds	(	short	ni1,
		short	ni2,
		short	ni3,
		short	ni4,
		short	ni5,
		short	ni6
	)			`[inline]`

Allow up to this many elements in 6D.

Definition at line 197 of file ckarrayoptions.h.

References bounds.

CkArrayOptions& CkArrayOptions::setMap ( const CkGroupID & m ) [inline]

Use this location map.

Definition at line 204 of file ckarrayoptions.h.

References map.

Referenced by CkCreateArrayExt(), LV3D1_Attach(), and TCHARM_Build_threads().

Here is the caller graph for this function:

CkArrayOptions & CkArrayOptions::bindTo ( const CkArrayID & b )

Bind our elements to this array.

Definition at line 117 of file ckarrayoptions.C.

References CkLocMgr::getGroupID(), CkArray::getLocMgr(), and setLocationManager().

Referenced by FEM_REF_INIT(), liveVizInit(), ParFUM_SA_Init(), REFINE2D_Init(), TCHARM_Attach_start(), and TCHARMLIB_Bound_array().

Here is the call graph for this function:

Here is the caller graph for this function:

CkArrayOptions& CkArrayOptions::setLocationManager ( const CkGroupID & l ) [inline]

Use this location manager.

Definition at line 213 of file ckarrayoptions.h.

References locMgr.

Referenced by bindTo().

Here is the caller graph for this function:

CkArrayOptions& CkArrayOptions::setMcastManager ( const CkGroupID & m ) [inline]

Use this ckmulticast manager.

Definition at line 219 of file ckarrayoptions.h.

References mCastMgr.

CkArrayOptions & CkArrayOptions::addListener ( CkArrayListener * listener )

Add an array listener component to this array (keeps the new'd listener).

Definition at line 125 of file ckarrayoptions.C.

References arrayListeners, and CkVec< T >::push_back().

Here is the call graph for this function:

CkArrayOptions& CkArrayOptions::setAnytimeMigration ( bool b ) [inline]

Definition at line 227 of file ckarrayoptions.h.

References anytimeMigration.

CkArrayOptions & CkArrayOptions::setStaticInsertion ( bool b )

Definition at line 110 of file ckarrayoptions.C.

References _defaultArrayMapID, _fastArrayMapID, map, and staticInsertion.

Referenced by Ck::IO::impl::Director::prepareWriteSession_helper(), and TCHARM_Build_threads().

Here is the caller graph for this function:

CkArrayOptions& CkArrayOptions::setBroadcastViaScheduler ( bool b ) [inline]

Definition at line 232 of file ckarrayoptions.h.

References broadcastViaScheduler.

CkArrayOptions& CkArrayOptions::setSectionAutoDelegate ( bool b ) [inline]

Definition at line 236 of file ckarrayoptions.h.

References sectionAutoDelegate.

Referenced by ampiInit(), and TCHARM_Build_threads().

Here is the caller graph for this function:

CkArrayOptions& CkArrayOptions::setReductionClient ( CkCallback cb ) [inline]

Definition at line 240 of file ckarrayoptions.h.

References reductionClient.

CkArrayOptions& CkArrayOptions::setInitCallback ( CkCallback cb ) [inline]

Definition at line 244 of file ckarrayoptions.h.

References initCallback.

Referenced by Ck::IO::impl::Director::prepareWriteSession_helper().

Here is the caller graph for this function:

const CkArrayIndex& CkArrayOptions::getStart ( void ) const [inline]

Definition at line 250 of file ckarrayoptions.h.

References start.

Referenced by ConfigurableRRMap::populateInitial(), CldMap::populateInitial(), BlockMap::populateInitial(), and CkArrayMap::populateInitial().

Here is the caller graph for this function:

const CkArrayIndex& CkArrayOptions::getEnd ( void ) const [inline]

Definition at line 251 of file ckarrayoptions.h.

References end.

Referenced by CkLocMgr::CkLocMgr(), RRMap::indexInit(), ConfigurableRRMap::populateInitial(), CldMap::populateInitial(), BlockMap::populateInitial(), and CkArrayMap::populateInitial().

Here is the caller graph for this function:

const CkArrayIndex& CkArrayOptions::getStep ( void ) const [inline]

Definition at line 252 of file ckarrayoptions.h.

References step.

Referenced by ConfigurableRRMap::populateInitial(), CldMap::populateInitial(), BlockMap::populateInitial(), and CkArrayMap::populateInitial().

Here is the caller graph for this function:

const CkArrayIndex& CkArrayOptions::getNumInitial ( void ) const [inline]

Definition at line 253 of file ckarrayoptions.h.

References numInitial.

Referenced by liveVizInit().

Here is the caller graph for this function:

const CkArrayIndex& CkArrayOptions::getBounds ( void ) const [inline]

Definition at line 254 of file ckarrayoptions.h.

References bounds.

const CkGroupID& CkArrayOptions::getMap ( void ) const [inline]

Definition at line 255 of file ckarrayoptions.h.

References map.

Referenced by CkLocMgr::CkLocMgr().

Here is the caller graph for this function:

const CkGroupID& CkArrayOptions::getLocationManager ( void ) const [inline]

Definition at line 256 of file ckarrayoptions.h.

References locMgr.

const CkGroupID& CkArrayOptions::getMcastManager ( void ) const [inline]

Definition at line 257 of file ckarrayoptions.h.

References mCastMgr.

bool CkArrayOptions::isSectionAutoDelegated ( void ) const [inline]

Definition at line 258 of file ckarrayoptions.h.

References sectionAutoDelegate.

const CkCallback& CkArrayOptions::getInitCallback ( void ) const [inline]

Definition at line 259 of file ckarrayoptions.h.

References initCallback.

int CkArrayOptions::getListeners ( void ) const [inline]

Definition at line 260 of file ckarrayoptions.h.

References arrayListeners, and CkVec< T >::size().

Here is the call graph for this function:

CkArrayListener* CkArrayOptions::getListener ( int listenerNum ) [inline]

Definition at line 261 of file ckarrayoptions.h.

References arrayListeners.

void CkArrayOptions::pup ( PUP::er & p )

Definition at line 181 of file ckarrayoptions.C.

References anytimeMigration, arrayListeners, bounds, broadcastViaScheduler, disableNotifyChildInRed, end, initCallback, locMgr, map, mCastMgr, numInitial, reductionClient, sectionAutoDelegate, start, staticInsertion, and step.

Friends And Related Function Documentation

friend class CkArray [friend]

Definition at line 70 of file ckarrayoptions.h.

Field Documentation

CkArrayIndex CkArrayOptions::start [private]

Definition at line 72 of file ckarrayoptions.h.

Referenced by getStart(), pup(), setStart(), updateIndices(), and updateNumInitial().

CkArrayIndex CkArrayOptions::end [private]

Definition at line 72 of file ckarrayoptions.h.

Referenced by getEnd(), pup(), setEnd(), updateIndices(), and updateNumInitial().

CkArrayIndex CkArrayOptions::step [private]

Definition at line 72 of file ckarrayoptions.h.

Referenced by getStep(), pup(), setStep(), updateIndices(), and updateNumInitial().

CkArrayIndex CkArrayOptions::numInitial [private]

Number of elements to create.

Definition at line 73 of file ckarrayoptions.h.

Referenced by getNumInitial(), pup(), setNumInitial(), updateIndices(), and updateNumInitial().

CkArrayIndex CkArrayOptions::bounds [private]

Limits of element counts in each dimension of this and all bound arrays.

Definition at line 75 of file ckarrayoptions.h.

Referenced by getBounds(), pup(), and setBounds().

CkGroupID CkArrayOptions::map [private]

Array location map object.

Definition at line 76 of file ckarrayoptions.h.

Referenced by getMap(), pup(), setMap(), and setStaticInsertion().

CkGroupID CkArrayOptions::locMgr [private]

Location manager to bind to.

Definition at line 77 of file ckarrayoptions.h.

Referenced by getLocationManager(), init(), pup(), and setLocationManager().

CkGroupID CkArrayOptions::mCastMgr [private]

Definition at line 78 of file ckarrayoptions.h.

Referenced by getMcastManager(), init(), pup(), and setMcastManager().

CkPupAblePtrVec<CkArrayListener> CkArrayOptions::arrayListeners [private]

<ckmulticast mgr to bind to, for sections

Definition at line 79 of file ckarrayoptions.h.

Referenced by addListener(), getListener(), getListeners(), and pup().

CkCallback CkArrayOptions::reductionClient [private]

Definition at line 80 of file ckarrayoptions.h.

Referenced by init(), pup(), and setReductionClient().

CkCallback CkArrayOptions::initCallback [private]

Definition at line 81 of file ckarrayoptions.h.

Referenced by getInitCallback(), pup(), and setInitCallback().

bool CkArrayOptions::anytimeMigration [private]

Definition at line 82 of file ckarrayoptions.h.

Referenced by init(), pup(), and setAnytimeMigration().

bool CkArrayOptions::disableNotifyChildInRed [private]

Definition at line 83 of file ckarrayoptions.h.

Referenced by init(), and pup().

bool CkArrayOptions::staticInsertion [private]

Definition at line 84 of file ckarrayoptions.h.

Referenced by init(), pup(), and setStaticInsertion().

bool CkArrayOptions::broadcastViaScheduler [private]

Definition at line 85 of file ckarrayoptions.h.

Referenced by init(), pup(), and setBroadcastViaScheduler().

bool CkArrayOptions::sectionAutoDelegate [private]

Definition at line 86 of file ckarrayoptions.h.

Referenced by init(), isSectionAutoDelegated(), pup(), and setSectionAutoDelegate().

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

ck-core/ckarrayoptions.h
ck-core/ckarrayoptions.C

CkArrayOptions Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation