STAPL: stapl::distribution< Container, Op1, Op2, Op3, Op4

Base distribution class for the pContainers. Provides the base functionality for all distributions. More...

Public Member Functions
	distribution (partition_type const &partition, mapper_type const &mapper)
	Creates a distribution with the specified partition and mapper. More...

	distribution (partition_type const &partition, mapper_type const &mapper, value_type const &default_value)
	Creates a distribution with the specified partition and mapper and the default value for the elements. More...

	distribution (partition_type const &partition)
	Creates a distribution with the specified partition. The mapper is based on the domain of the partition (i.e. matches the distribution provided by the partition). More...

	distribution (directory_type const &directory, container_manager_type const &bcmngr)
	Creates a distribution with the specified directory and base container manager. More...

template<typename DistSpecView , typename PartitionContainer >
	distribution (std::shared_ptr< DistSpecView > dist_view, PartitionContainer const const part_cont, typename std::enable_if< std::is_same< typename PartitionContainer::value_type, arbitrary_partition_info >::value >::type =0)
	Creates an arbitrary distribution using the partition and mapping information specified by the elements of , which are instances of arb_partition_info. More...

template<typename DistSpecView , typename PartitionContainer >
	distribution (std::shared_ptr< DistSpecView > dist_view, PartitionContainer const const part_cont, value_type const &default_value, typename std::enable_if< std::is_same< typename PartitionContainer::value_type, arbitrary_partition_info >::value >::type =0)
	Creates an arbitrary distribution using the partition and mapping information specified by the elements of , which are instances of arb_partition_info. After construction all elements constructed will be equal to `default_value`. More...

size_t	size (void) const

domain_type const &	domain (void) const

partition_type &	partition ()

partition_type const &	partition () const

mapper_type &	mapper ()

directory_type &	directory (void)

directory_type const &	directory (void) const

container_manager_type &	container_manager (void)

container_manager_type const &	container_manager (void) const

container_type *	container (void)

container_type const *	container (void) const

local_return_type	metadata (void)
	Returns the metadata information for the base-containers on this location. More...

size_t	num_base_containers (void)
	Returns the global number of base-containers in this distribution.

template<typename... Indices>
bool	is_local (Indices const &... i) const

void	defer_metadata_at (gid_type const &gid, promise< dom_info_type > p)
	Returns the metadata associated with the given `gid` by setting the value of the promise. More...

future< dom_info_type >	metadata_at (gid_type const &gid)
	Returns the metadata associated with the given `index`.

dom_info_type	metadata_of (cid_type const &cid)
	Return the metadata associated with the specified component. More...

template<typename DistSpecView >
void	redistribute (std::shared_ptr< DistSpecView > dist_view, typename std::enable_if< is_distribution_view< DistSpecView >::value >::type *=0)
	Redistribute data to match the distribution specification provided. More...

void	update (std::vector< std::tuple< std::pair< gid_type, gid_type >, cid_type, location_type >> const &updates)
	Add information on the distribution of elements not yet in the container. Use in dynamic containers with view-based distributions to allow element distribution to be based on computation. More...

Public Types
typedef Container	container_type

typedef directory_type::key_type	gid_type

typedef partition_type::value_type	domain_type

typedef gid_type	index_type

typedef mapper_type::domain_type	map_dom_t

typedef metadata_entry< domain_type, base_container_type * >	dom_info_type
	The type of the coarsened domain.

typedef std::vector< dom_info_type >	local_return_type
	Type for returning collected metadata from all local base-containers.

Protected Member Functions
void	update_impl (std::vector< std::tuple< std::pair< gid_type, gid_type >, cid_type, location_type >> const &updates)

Protected Attributes
container_manager_type	m_container_manager
	Manages and owns the base-containers on this location. Base-containers store the actual data. Container manager also handles the mapping from gid to base-container.

Detailed Description

template<typename Container, template< typename > class Op1 = detail::nat1, template< typename > class Op2 = detail::nat2, template< typename > class Op3 = detail::nat3, template< typename > class Op4 = detail::nat4>
struct stapl::distribution< Container, Op1, Op2, Op3, Op4 >

Base distribution class for the pContainers. Provides the base functionality for all distributions.

Template Parameters

Container Type of the container that is managing this distribution.

Constructor & Destructor Documentation

◆ distribution() [1/6]

template<typename Container, template< typename > class Op1 = detail::nat1, template< typename > class Op2 = detail::nat2, template< typename > class Op3 = detail::nat3, template< typename > class Op4 = detail::nat4>

stapl::distribution< Container, Op1, Op2, Op3, Op4 >::distribution	(	partition_type const &	partition,
		mapper_type const &	mapper
	)

Creates a distribution with the specified partition and mapper.

Parameters

partition	The specified partition according to which the gids will be distributed.
mapper	The mapping from gid to location.

◆ distribution() [2/6]

stapl::distribution< Container, Op1, Op2, Op3, Op4 >::distribution	(	partition_type const &	partition,
		mapper_type const &	mapper,
		value_type const &	default_value
	)

Creates a distribution with the specified partition and mapper and the default value for the elements.

Parameters

partition	The specified partition according to which the gids will be distributed.
mapper	The mapping from gid to location.
default_value	The default value assigned to the elements.

◆ distribution() [3/6]

stapl::distribution< Container, Op1, Op2, Op3, Op4 >::distribution ( partition_type const & partition )

Creates a distribution with the specified partition. The mapper is based on the domain of the partition (i.e. matches the distribution provided by the partition).

Parameters

partition The specified partition according to which the gids will be distributed.

◆ distribution() [4/6]

stapl::distribution< Container, Op1, Op2, Op3, Op4 >::distribution	(	directory_type const &	directory,
		container_manager_type const &	bcmngr
	)

Creates a distribution with the specified directory and base container manager.

Parameters

directory	The specified directory for this distribution.
bcmngr	The base container manager for this distribution.

◆ distribution() [5/6]

template<typename DistSpecView , typename PartitionContainer >

stapl::distribution< Container, Op1, Op2, Op3, Op4 >::distribution	(	std::shared_ptr< DistSpecView >	dist_view,
		PartitionContainer const *const	part_cont,
		typename std::enable_if< std::is_same< typename PartitionContainer::value_type, arbitrary_partition_info >::value >::type *	= `0`
	)

Creates an arbitrary distribution using the partition and mapping information specified by the elements of , which are instances of arb_partition_info.

The partition container is provided along with the view-based distribution specification to allow the efficient extraction of partition information in the container mananger.

Parameters

dist_view	View-based specification of the distribution that the container elements will match after method completion.
part_cont	Container of arb_partition_info elements that specifies an arbitrary distribution

◆ distribution() [6/6]

template<typename DistSpecView , typename PartitionContainer >

stapl::distribution< Container, Op1, Op2, Op3, Op4 >::distribution	(	std::shared_ptr< DistSpecView >	dist_view,
		PartitionContainer const *const	part_cont,
		value_type const &	default_value,
		typename std::enable_if< std::is_same< typename PartitionContainer::value_type, arbitrary_partition_info >::value >::type *	= `0`
	)

Creates an arbitrary distribution using the partition and mapping information specified by the elements of , which are instances of arb_partition_info. After construction all elements constructed will be equal to default_value.

The partition container is provided along with the view-based distribution specification to allow the efficient extraction of partition information in the container mananger.

Parameters

dist_view	View-based specification of the distribution that the container elements will match after method completion.
part_cont	Container of arb_partition_info elements that specifies an arbitrary distribution
default_value	Initial value for all elements constructed

Member Function Documentation

◆ metadata()

local_return_type stapl::distribution< Container, Op1, Op2, Op3, Op4 >::metadata ( void )

Returns the metadata information for the base-containers on this location.

See also: metadata_entry.

◆ is_local()

template<typename... Indices>

bool stapl::distribution< Container, Op1, Op2, Op3, Op4 >::is_local ( Indices const &... i ) const

Returns if the element with the specified gid is stored on this location.

Parameters

i	components of a gid if it is multidimensional, otherwise i is the gid.

◆ defer_metadata_at()

void stapl::distribution< Container, Op1, Op2, Op3, Op4 >::defer_metadata_at	(	gid_type const &	gid,
		promise< dom_info_type >	p
	)

Returns the metadata associated with the given gid by setting the value of the promise.

Parameters

gid	Id of the element of interest
p	Promise that will return the locality information to the location that invoked the method.

◆ metadata_of()

dom_info_type stapl::distribution< Container, Op1, Op2, Op3, Op4 >::metadata_of ( cid_type const & cid )

Return the metadata associated with the specified component.

Parameters

cid	id of the base container for which metadata is requested.

Returns: Metadata of the base container if it is stored on this location.

◆ redistribute()

template<typename DistSpecView >

void stapl::distribution< Container, Op1, Op2, Op3, Op4 >::redistribute	(	std::shared_ptr< DistSpecView >	dist_view,
		typename std::enable_if< is_distribution_view< DistSpecView >::value >::type *	= `0`
	)

Redistribute data to match the distribution specification provided.

Parameters

dist_view View-based specification of the distribution that the container elements will match after method completion.

◆ update()

void stapl::distribution< Container, Op1, Op2, Op3, Op4 >::update ( std::vector< std::tuple< std::pair< gid_type, gid_type >, cid_type, location_type >> const & updates )

Add information on the distribution of elements not yet in the container. Use in dynamic containers with view-based distributions to allow element distribution to be based on computation.

Parameters

updates Explicit mapping information of sets of contiguous GIDs to partition ids and location ids.

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

distribution/distribution.hpp

Public Member Functions

Public Types

Protected Member Functions

Protected Attributes

Detailed Description

template<typename Container, template< typename > class Op1 = detail::nat1, template< typename > class Op2 = detail::nat2, template< typename > class Op3 = detail::nat3, template< typename > class Op4 = detail::nat4> struct stapl::distribution< Container, Op1, Op2, Op3, Op4 >

Constructor & Destructor Documentation

◆ distribution() [1/6]

◆ distribution() [2/6]

◆ distribution() [3/6]

◆ distribution() [4/6]

◆ distribution() [5/6]

◆ distribution() [6/6]

Member Function Documentation

◆ metadata()

◆ is_local()

◆ defer_metadata_at()

◆ metadata_of()

◆ redistribute()

◆ update()

template<typename Container, template< typename > class Op1 = detail::nat1, template< typename > class Op2 = detail::nat2, template< typename > class Op3 = detail::nat3, template< typename > class Op4 = detail::nat4>
struct stapl::distribution< Container, Op1, Op2, Op3, Op4 >