STAPL: stapl::vector_distribution< Container

Defines the vector distribution. More...

Public Member Functions
	STAPL_IMPORT_TYPE (typename it_base_t, iterator)

	vector_distribution (vector_distribution const &other)
	Copy construction of this distribution. More...

	vector_distribution (partition_type const &partition, mapper_type const &mapper)
	Creates a distribution with default constructed elements. More...

	vector_distribution (partition_type const &partition, mapper_type const &mapper, value_type const &default_value)
	Creates a distribution with an initial value for elements. More...

	vector_distribution (directory_type const &directory, container_manager_type const &bcmangr)
	Creates a distribution with with the given `directory` and base container manager `bcmangr`. More...

void	set_domain (domain_type const &domain)

template<typename View >
void	insert (gid_type gid, value_type const &value, View *view)
	Inserts the given `value` at the given `gid` position. More...

template<typename View >
void	erase (gid_type gid, View *view)
	Removes the element at the given `gid` position. More...

void	clear (void)
	Remove all elements from the container. More...

template<typename View >
void	push_back (value_type const &value, View *view)
	Inserts the given `value` at the end of the container. More...

template<typename View >
void	pop_back (View *view)
	Removes the given `value` from the end of the container. More...

void	local_push_back (value_type const &value)
	Helper method to insert the given `value` locally.

void	update_domain (size_t num_elem)
	Updates the stored domain to represent a domain with `num_elem` number of elements.

void	synchronize_metadata (void)
	Method used to update the container's metadata (directory's registry, domain) based on the information in the base containers. More...

domain_type const &	domain (void) const

iterator	find (gid_type index)

size_t	local_size ()

size_t	size (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.

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...

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...

void	set_element (gid_type const &gid, value_type const &val)
	Update the element at a GID by replacing it with a given value. More...

void	set_elements (gid_type gid, SourceView &&source_view)
	Update a range of contiguous elements in the container, starting at `gid`. A total of `view.size()` elements will be updated with the values in `view`. More...

void	set_elements (gid_type gid, View &&view)
	Signature of set_elements used when underlying base container is not supported. Fall back to iterative use of set_element.

value_type	get_element (gid_type const &gid) const
	Return a copy of the element at a specific GID. Note that this is a blocking operation. More...

future< value_type >	get_element_split (gid_type const &gid)
	Return a future of the element at a specific GID. This is a non-blocking operation. More...

void	apply_set (gid_type const &gid, Functor const &f)
	Apply a function object to the element with the given GID. More...

void	unordered_apply_set (gid_type const &gid, Functor &&f)
	Apply a function object to the element with the given GID, disregarding RMI causal ordering. More...

void	unordered_apply (gid_type const &gid, Functor &&f)
	Apply a function object to the element with the given GID, passing along the distribution pointer and disregarding RMI causal ordering. More...

boost::result_of< Functor(value_type &)>::type	apply_get (gid_type const &gid, Functor const &f)
	Apply a function object to the element with the given GID and return the result. More...

boost::result_of< Functor(value_type &)>::type	apply_get (gid_type const &gid, Functor const &f) const
	Apply a function object to the element with the given GID and return the result. More...

iterator	make_iterator (gid_type const &gid)
	Construct an iterator to a specific GID of the container. More...

const_iterator	make_const_iterator (gid_type const &gid) const
	Construct a const_iterator to a specific GID of the container. More...

iterator	begin ()
	Construct an iterator to the beginning of the container. More...

const_iterator	begin () const
	Construct a const_iterator to the beginning of the container. More...

const_iterator	cbegin () const
	Construct a const_iterator to the beginning of the container. More...

iterator	end ()
	Construct an iterator to the end of the container. More...

const_iterator	end () const
	Construct a const_iterator to the end of the container. More...

const_iterator	cend () const
	Construct a const_iterator to the end of the container. More...

reference	operator[] (gid_type const &gid)
	Construct a reference to the element at a specific gid. More...

const_reference	operator[] (gid_type const &gid) const
	Construct a reference to the element at a specific gid. More...

reference	make_reference (gid_type const &gid)
	Construct a reference to the element at a specific gid. More...

const_reference	make_reference (gid_type const &gid) const
	Construct a reference to the element at a specific gid. More...

reference	make_reference (Indices const &... i)
	Construct a reference to the element at a specific gid. More...

const_reference	make_reference (Indices const &... i) const
	Construct a reference to the element at a specific gid. More...

Public Types
typedef gid_type	index_type

typedef Container	container_type

typedef metadata::static_container_extractor< vector_distribution >	loc_dist_metadata

typedef indexed_domain< gid_type >	domain_type

typedef directory_type::key_type	gid_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.

typedef std::random_access_iterator_tag	iterator_category

typedef traits_t::gid_type	gid_type

typedef container_accessor< container_t >	accessor_type

typedef const_container_accessor< container_t >	const_accessor_type

typedef container_iterator< container_t, accessor_type, iterator_category >	iterator

typedef const_container_iterator< container_t, const_accessor_type, iterator_category >	const_iterator

typedef referencer_t::result_type	reference

typedef const_referencer_t::result_type	const_reference

Protected Member Functions
template<typename View >
void	update_metadata (action_type action, location_type origin, View *view)
	Helper method to update the domain by increasing or reducing the number of elements in the domain based on the given `action`. More...

void	insert_bcast (gid_type gid, value_type const &value, cid_type dest, promise< void > p)
	Helper method to insert the given `value` at the given `gid` position, updating the domain.

void	try_insert (gid_type gid, value_type const &value, promise< void > p)
	Helper method to determine into which base container the.

void	erase_bcast (gid_type gid, promise< void > p)
	Helper method to remove the element at the given `gid` position, updating the domain.

template<typename View >
void	push_back_local (value_type const &value, location_type origin, View *view)
	Helper method to insert the given `value` locally. More...

template<typename View >
void	pop_back_local (location_type origin, View *view)
	Helper method to pop_back on current location. More...

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

Protected Types
enum	action_type { INSERT, DELETE }

typedef std::queue< std::pair< gid_type, value_type > >	insert_queue_type

typedef std::queue< gid_type >	erase_queue_type

Protected Attributes
insert_queue_type	m_insert_queue

erase_queue_type	m_erase_queue

domain_type	m_domain

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>
class stapl::vector_distribution< Container >

Defines the vector distribution.

Provides the functionality required to manage the data distributions of the vector.

Template Parameters

Container Type of the container that is managing this distribution.

Member Typedef Documentation

◆ loc_dist_metadata

template<typename Container >

typedef metadata::static_container_extractor< vector_distribution > stapl::vector_distribution< Container >::loc_dist_metadata

Distribution metadata type used for coarsening

Constructor & Destructor Documentation

◆ vector_distribution() [1/4]

template<typename Container >

stapl::vector_distribution< Container >::vector_distribution ( vector_distribution< Container > const & other )

Copy construction of this distribution.

Parameters

other Another distribution to copy from.

◆ vector_distribution() [2/4]

template<typename Container >

stapl::vector_distribution< Container >::vector_distribution	(	partition_type const &	partition,
		mapper_type const &	mapper
	)

Creates a distribution with default constructed elements.

Parameters

partition	Partition used by the container.
mapper	Mapper used by the container.

◆ vector_distribution() [3/4]

template<typename Container >

stapl::vector_distribution< Container >::vector_distribution	(	partition_type const &	partition,
		mapper_type const &	mapper,
		value_type const &	default_value
	)

Creates a distribution with an initial value for elements.

Parameters

partition	Partition used by the container.
mapper	Mapper used by the container.
default_value	The value that the elements in this distribution will be initialized with.

◆ vector_distribution() [4/4]

template<typename Container >

stapl::vector_distribution< Container >::vector_distribution	(	directory_type const &	directory,
		container_manager_type const &	bcmangr
	)

Creates a distribution with with the given directory and base container manager bcmangr.

Parameters

directory	Directory used by the container.
bcmangr	Base container manager used by the container.

Member Function Documentation

◆ update_metadata()

template<typename Container >

template<typename View >

void stapl::vector_distribution< Container >::update_metadata	(	action_type	action,
		location_type	origin,
		View *	view
	)

protected

Helper method to update the domain by increasing or reducing the number of elements in the domain based on the given action.

If a non-null view pointer is provided, the domain of the view will be updated as well.

◆ insert()

template<typename Container >

template<typename View >

void stapl::vector_distribution< Container >::insert	(	gid_type	gid,
		value_type const &	value,
		View *	view
	)

Inserts the given value at the given gid position.

If a non-null view pointer is provided, initiates an update of the view domain at all locations as well.

◆ erase()

template<typename Container >

template<typename View >

void stapl::vector_distribution< Container >::erase	(	gid_type	gid,
		View *	view
	)

Removes the element at the given gid position.

If a non-null view pointer is provided, initiates an update of the view domain at all locations as well.

◆ clear()

template<typename Container >

void stapl::vector_distribution< Container >::clear ( void )

Remove all elements from the container.

Note: This method must be called by all locations in the gang on which the container is instantiated.

◆ push_back_local()

template<typename Container >

template<typename View >

void stapl::vector_distribution< Container >::push_back_local	(	value_type const &	value,
		location_type	origin,
		View *	view
	)

protected

Helper method to insert the given value locally.

If a non-null view pointer is provided, initiates an update of the view domain at all locations as well.

◆ push_back()

template<typename Container >

template<typename View >

void stapl::vector_distribution< Container >::push_back	(	value_type const &	value,
		View *	view
	)

Inserts the given value at the end of the container.

If a non-null view pointer is provided, initiates an update of the view domain at all locations as well.

◆ pop_back_local()

template<typename Container >

template<typename View >

void stapl::vector_distribution< Container >::pop_back_local	(	location_type	origin,
		View *	view
	)

protected

Helper method to pop_back on current location.

If a non-null view pointer is provided, initiates an update of the view domain at all locations as well.

◆ pop_back()

template<typename Container >

template<typename View >

void stapl::vector_distribution< Container >::pop_back ( View * view )

Removes the given value from the end of the container.

If a non-null view pointer is provided, initiates an update of the view domain at all locations as well.

The pop_back is attempted at the location of current last GID. The method calls decreasing_invoke_where which first asks the key mapper for the location where GID is supposed to be registered and if it still is, it will query the registry at that location for the actual location where the GID is stored. Then, pop_back_local will be invoked via RMI at that location (or directly if the last GID happens to be stored on current location).

If the GID is no longer registered at the managing location, a pop_back from a different location already removed it (note that all locations initially start from the same GID and their domains are updated asynchronously). In this case, the whole process will be repeated with GID - 1, until a location with the GID in registry is found or all positive GIDs have been used.

◆ synchronize_metadata()

template<typename Container >

void stapl::vector_distribution< Container >::synchronize_metadata ( void )

Method used to update the container's metadata (directory's registry, domain) based on the information in the base containers.

◆ metadata()

local_return_type stapl::distribution< Container, detail::nat1 , detail::nat2 , detail::nat3 , detail::nat4 >::metadata ( void )

inherited

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

See also: metadata_entry.

◆ is_local()

bool stapl::distribution< Container, detail::nat1 , detail::nat2 , detail::nat3 , detail::nat4 >::is_local ( Indices const &... i ) const

inherited

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, detail::nat1 , detail::nat2 , detail::nat3 , detail::nat4 >::defer_metadata_at	(	gid_type const &	gid,
		promise< dom_info_type >	p
	)

inherited

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, detail::nat1 , detail::nat2 , detail::nat3 , detail::nat4 >::metadata_of ( cid_type const & cid )

inherited

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()

void stapl::distribution< Container, detail::nat1 , detail::nat2 , detail::nat3 , detail::nat4 >::redistribute	(	std::shared_ptr< DistSpecView >	dist_view,
		typename std::enable_if< is_distribution_view< DistSpecView >::value >::type *	= `0`
	)

inherited

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, detail::nat1 , detail::nat2 , detail::nat3 , detail::nat4 >::update ( std::vector< std::tuple< std::pair< gid_type, gid_type >, cid_type, location_type >> const & updates )

inherited

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.

◆ set_element()

void stapl::operations::settable< vector_distribution< Container > >::set_element	(	gid_type const &	gid,
		value_type const &	val
	)

inherited

Update the element at a GID by replacing it with a given value.

Parameters

gid	GID of the element to replace
val	The new value for the element

◆ set_elements()

void stapl::operations::settable< vector_distribution< Container > >::set_elements	(	gid_type	gid,
		SourceView &&	source_view
	)

inherited

Update a range of contiguous elements in the container, starting at gid. A total of view.size() elements will be updated with the values in view.

Note: Implementation assumes partition::try_get_domain will not fail if partition::contained_in succeeds.

◆ get_element()

value_type stapl::operations::gettable< vector_distribution< Container > >::get_element ( gid_type const & gid ) const

inherited

Return a copy of the element at a specific GID. Note that this is a blocking operation.

Parameters

gid	GID of the element to retrieve

Returns: Copy of the element at gid

◆ get_element_split()

future<value_type> stapl::operations::gettable< vector_distribution< Container > >::get_element_split ( gid_type const & gid )

inherited

Return a future of the element at a specific GID. This is a non-blocking operation.

Parameters

gid	GID of the element to retrieve

Returns: Future of the element at gid

◆ apply_set()

void stapl::operations::applyable< vector_distribution< Container > >::apply_set	(	gid_type const &	gid,
		Functor const &	f
	)

inherited

Apply a function object to the element with the given GID.

Parameters

gid	GID of the element for which we want to apply the function object.
f	Function object to apply to the element.

Warning: The function operator of f has to be const qualified.

◆ unordered_apply_set()

void stapl::operations::applyable< vector_distribution< Container > >::unordered_apply_set	(	gid_type const &	gid,
		Functor &&	f
	)

inherited

Apply a function object to the element with the given GID, disregarding RMI causal ordering.

Parameters

gid	GID of the element for which we want to apply the function object.
f	Function object to apply to the element.

Warning: The function operator of f has to be const qualified.

◆ unordered_apply()

void stapl::operations::applyable< vector_distribution< Container > >::unordered_apply	(	gid_type const &	gid,
		Functor &&	f
	)

inherited

Apply a function object to the element with the given GID, passing along the distribution pointer and disregarding RMI causal ordering.

Parameters

gid	GID of the element for which we want to apply the function object.
f	Function object to apply to the element.

Warning: The function operator of f has to be const qualified.

◆ apply_get() [1/2]

boost::result_of<Functor(value_type&)>::type stapl::operations::applyable< vector_distribution< Container > >::apply_get	(	gid_type const &	gid,
		Functor const &	f
	)

inherited

Apply a function object to the element with the given GID and return the result.

Parameters

gid	GID of the element for which we want to apply the function object and return the result.
f	Function object to apply to the element.

Returns: The result of applying f to the element.

Warning: This function assumes that the Functor reflects a public type result_type and that the invocation of its function operator returns a value that is convertible to result_type. The function operator of f has to be const qualified.

◆ apply_get() [2/2]

boost::result_of<Functor(value_type&)>::type stapl::operations::applyable< vector_distribution< Container > >::apply_get	(	gid_type const &	gid,
		Functor const &	f
	)		const

inherited

Apply a function object to the element with the given GID and return the result.

Parameters

gid	GID of the element for which we want to apply the function object and return the result.
f	Function object to apply to the element.

Returns: The result of applying f to the element.

Warning: This function assumes that the Functor reflects a public type result_type and that the invocation of its function operator returns a value that is convertible to result_type. The function operator of f has to be const qualified.

◆ make_iterator()

iterator stapl::operations::iterable< vector_distribution< Container > >::make_iterator ( gid_type const & gid )

inherited

Construct an iterator to a specific GID of the container.

Parameters

gid	The GID for which to create the iterator

Returns: An iterator to the value at gid

◆ make_const_iterator()

const_iterator stapl::operations::iterable< vector_distribution< Container > >::make_const_iterator ( gid_type const & gid ) const

inherited

Construct a const_iterator to a specific GID of the container.

Parameters

gid	The GID for which to create the const_iterator

Returns: A const_iterator to the value at gid

◆ begin() [1/2]

iterator stapl::operations::iterable< vector_distribution< Container > >::begin ( void )

inherited

Construct an iterator to the beginning of the container.

Returns: A global iterator to the first GID in the domain

◆ begin() [2/2]

const_iterator stapl::operations::iterable< vector_distribution< Container > >::begin ( void ) const

inherited

Construct a const_iterator to the beginning of the container.

Returns: A global const_iterator to the first GID in the domain

◆ cbegin()

const_iterator stapl::operations::iterable< vector_distribution< Container > >::cbegin ( ) const

inherited

Construct a const_iterator to the beginning of the container.

Returns: A global const_iterator to the first GID in the domain

◆ end() [1/2]

iterator stapl::operations::iterable< vector_distribution< Container > >::end ( void )

inherited

Construct an iterator to the end of the container.

Returns: A global iterator to the one past the last GID in the domain

◆ end() [2/2]

const_iterator stapl::operations::iterable< vector_distribution< Container > >::end ( void ) const

inherited

Construct a const_iterator to the end of the container.

Returns: A global const_iterator to the one past the last GID in the domain

◆ cend()

const_iterator stapl::operations::iterable< vector_distribution< Container > >::cend ( ) const

inherited

Construct a const_iterator to the end of the container.

Returns: A global const_iterator to the one past the last GID in the domain

◆ operator[]() [1/2]

reference stapl::operations::random_access< vector_distribution< Container > >::operator[] ( gid_type const & gid )

inherited

Construct a reference to the element at a specific gid.

Parameters

gid	The index for which to create the reference

Returns: A proxy over the element.

◆ operator[]() [2/2]

const_reference stapl::operations::random_access< vector_distribution< Container > >::operator[] ( gid_type const & gid ) const

inherited

Construct a reference to the element at a specific gid.

Parameters

gid	The index for which to create the reference

Returns: A proxy over the element.

◆ make_reference() [1/4]

reference stapl::operations::random_access< vector_distribution< Container > >::make_reference ( gid_type const & gid )

inherited

Construct a reference to the element at a specific gid.

Parameters

gid	The GID of the element

Returns: Proxy over the element.

◆ make_reference() [2/4]

const_reference stapl::operations::random_access< vector_distribution< Container > >::make_reference ( gid_type const & gid ) const

inherited

Construct a reference to the element at a specific gid.

Parameters

gid	The GID of the element

Returns: Proxy over the element.

◆ make_reference() [3/4]

reference stapl::operations::random_access< vector_distribution< Container > >::make_reference ( Indices const &... i )

inherited

Construct a reference to the element at a specific gid.

Parameters

i	The indices of the gid at which the element resides.

Returns: Proxy over the element.

◆ make_reference() [4/4]

const_reference stapl::operations::random_access< vector_distribution< Container > >::make_reference ( Indices const &... i ) const

inherited

Construct a reference to the element at a specific gid.

Parameters

i	The indices of the gid at which the element resides.

Returns: Proxy over the element.

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

vector/distribution.hpp

Public Member Functions

Public Types

Protected Member Functions

Protected Types

Protected Attributes

Detailed Description

template<typename Container> class stapl::vector_distribution< Container >

Member Typedef Documentation

◆ loc_dist_metadata

Constructor & Destructor Documentation

◆ vector_distribution() [1/4]

◆ vector_distribution() [2/4]

◆ vector_distribution() [3/4]

◆ vector_distribution() [4/4]

Member Function Documentation

◆ update_metadata()

◆ insert()

◆ erase()

◆ clear()

◆ push_back_local()

◆ push_back()

◆ pop_back_local()

◆ pop_back()

◆ synchronize_metadata()

◆ metadata()

◆ is_local()

◆ defer_metadata_at()

◆ metadata_of()

◆ redistribute()

◆ update()

◆ set_element()

◆ set_elements()

◆ get_element()

◆ get_element_split()

◆ apply_set()

◆ unordered_apply_set()

◆ unordered_apply()

◆ apply_get() [1/2]

◆ apply_get() [2/2]

◆ make_iterator()

◆ make_const_iterator()

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ end() [1/2]

◆ end() [2/2]

◆ cend()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ make_reference() [1/4]

◆ make_reference() [2/4]

◆ make_reference() [3/4]

◆ make_reference() [4/4]

template<typename Container>
class stapl::vector_distribution< Container >