stapl::runtime::gang_description Class Reference

Contains information about the locations of a gang. More...

Classes
class	process_iterator
	Iterator over process ids. More...
class	process_location_iterator
	Iterator over locations ids of a specific process. More...

Public Member Functions
template<typename ResolutionFunction , typename PhysicalMappingFunction >
	gang_description (ResolutionFunction &&rf, const size_type size, PhysicalMappingFunction &&pf, const size_type nprocs)
	Creates a new gang_description object. More...
	gang_description (const size_type size, const process_id pid)
	Creates a new gang_description object that has size number of locations on the same process. More...
template<typename ResolutionFunction >
	gang_description (gang_description const &other, ResolutionFunction &&rf, const size_type size)
	Creates a new gang_description object from the given one and the mapping function. More...
size_type	get_num_locations (void) const noexcept
	Returns the number of locations of the gang.
boost::iterator_range< process_location_iterator >	get_location_ids (const process_id pid) const noexcept
	Returns a range of the locations that are on process pid.
size_type	get_num_processes (void) const noexcept
	Returns the number of processes the gang is on.
boost::iterator_range< process_iterator >	get_processes (void) const noexcept
	Returns a range of the processes the gang is on.
bool	is_on_shmem (void) const noexcept
	Returns true if all the locations are on the same process.
bool	is_on_distmem (void) const noexcept
	Returns true if no two locations are on the same process.
process_id	get_process_id (const location_id lid) const noexcept
	Returns the id of the process that the location id is on.
process_id	get_nth_process_id (const size_type index) const noexcept
	Returns the nth process of the gang.
size_type	get_location_local_index (const location_id lid) const noexcept
	Returns the local index of the location lid. More...
size_type	get_num_locations (const process_id pid) const noexcept
	Returns the number of locations that are on the process pid. More...
size_type	get_process_id_index (const process_id pid) const noexcept
	Returns the index in the process set of the process with the given id. More...

Public Types
using	size_type = std::size_t

Detailed Description

Contains information about the locations of a gang.

Constructor & Destructor Documentation

gang_description() [1/3]

template<typename ResolutionFunction , typename PhysicalMappingFunction >

stapl::runtime::gang_description::gang_description	(	ResolutionFunction &&	rf,
		const size_type	size,
		PhysicalMappingFunction &&	pf,
		const size_type	nprocs
	)

Creates a new gang_description object.

Parameters

rf	Function to return on which process a location is on.
size	Size of the new gang.
pf	Function to return the process id based on its index.
nprocs	Number of processes.

gang_description() [2/3]

stapl::runtime::gang_description::gang_description	(	const size_type	size,
		const process_id	pid
	)

Creates a new gang_description object that has size number of locations on the same process.

Parameters

size	Size of the new gang.
pid	Process id.

gang_description() [3/3]

template<typename ResolutionFunction >

stapl::runtime::gang_description::gang_description	(	gang_description const &	other,
		ResolutionFunction &&	rf,
		const size_type	size
	)

Creates a new gang_description object from the given one and the mapping function.

Warning

This function will perform a linear search of the location id space to find which of the locations are on the same process and build the necessary mapping functions.

Parameters

other	gang_description to base the created one on.
rf	Function that translates location ids of the created gang to location ids of other.
size	Size of the new gang.

Member Function Documentation

get_location_local_index()

size_type stapl::runtime::gang_description::get_location_local_index ( const location_id  lid ) const

noexcept

Returns the local index of the location lid.

Warning

This function will perform a linear search of the location id space to find which locations are on the same process.

get_num_locations()

size_type stapl::runtime::gang_description::get_num_locations ( const process_id  pid ) const

noexcept

Returns the number of locations that are on the process pid.

Warning

This function will perform a linear search of the location id space to find which locations are on the same process.

get_process_id_index()

size_type stapl::runtime::gang_description::get_process_id_index ( const process_id  pid ) const

noexcept

Returns the index in the process set of the process with the given id.

Warning

This function will perform a linear search of the process id space to find the index.

---

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

• gang_description.hpp