STAPL: stapl::metadata::flat_container< MD

Container for metadata used when the number of elements (metadata information) is known at the construction time. More...

Public Member Functions
	flat_container (size_t n)

iterator	begin ()
	Returns an iterator to the beginning of the local base container. More...

iterator	end ()
	Returns an iterator to the end of the local base container. More...

domain_type	domain (void) const

dimensions_type	dimensions (void) const

dimensions_type	local_dimensions (void) const

size_t	get_local_vid (size_t index)
	Returns the global index of the given local `index`. More...

location_type	get_location_element (size_t index) const
	Returns the location where the metadata indexed by `index` is located. More...

location_type	get_location_id () const

size_t	get_num_locations () const

size_t	local_size (void) const
	Returns the number of local elements (number of elements in the base container). More...

void	push_back_here (MD const &)

void	update ()
	Verify that all the elements that need to be stored in this location were assigned.

template<typename DistSpecView >
std::enable_if<(is_distribution_view< DistSpecView >::value\|\|detail::has_is_composed_dist_spec< DistSpecView >::value) &&is_view_based< partition_type >::value &&is_view_based< mapper_type >::value >::type	redistribute (DistSpecView const &dist_view)
	Redistribute the data stored in the container to match the distribution specified by the distribution view provided. More...

template<typename DistSpecView >
std::enable_if<(is_distribution_view< DistSpecView >::value\|\|detail::has_is_composed_dist_spec< DistSpecView >::value) &&is_view_based< partition_type >::value &&is_view_based< mapper_type >::value >::type	redistribute (DistSpecView const *dist_view)
	Redistribute the data stored in the container to match the distribution specified by the distribution view provided. More...

void	destroy (void)
	Used as a target method for rmis implementing one-sided destruction, as a pointer to member variable referring to the destructor cannot be initialized, per the standard. Used when container is an element of another container.

boost::shared_ptr< C >	shared_from_this ()

Element Manipulation
reference	operator[] (gid_type const &gid)
	Construct a reference to a specific index of the array. More...

const_reference	operator[] (gid_type const &gid) const
	Construct a const_reference to a specific index of the array. More...

reference	front ()
	Construct a reference to the first element of the array. More...

const_reference	front () const
	Construct a const_reference to the first element of the array. More...

reference	back ()
	Construct a reference to the last element of the array. More...

const_reference	back () const
	Construct a const_reference to the last element of the array. More...

reference	make_reference (gid_type const &gid)
	Construct a reference to a specific index of the array. More...

const_reference	make_reference (gid_type const &gid) const
	Construct a const_reference to a specific index of the array. More...

const_iterator	begin (void) const
	Construct an const_iterator to the beginning of the array. More...

const_iterator	cbegin (void) const
	Construct an const_iterator to the beginning of the array. More...

const_iterator	end (void) const
	Construct an const_iterator to one past the end of the array. More...

const_iterator	cend (void) const
	Construct an const_iterator to one past the end of the array. More...

iterator	make_iterator (index_type const &index)
	Construct an iterator to a specific index of the array. More...

const_iterator	make_iterator (index_type const &index) const
	Construct an iterator to a specific index of the array. More...

Element Manipulation
void	set_element (index_type const &idx, value_type const &val)
	Sets the element specified by the index to the provided value. More...

template<typename View >
void	set_elements (index_type const &idx, View &&vals)
	Sets a range of elements starting with a given index to a sequence of provided values. More...

value_type	get_element (index_type const &idx) const
	Returns the value of the element specified by the index. More...

future< value_type >	get_element_split (index_type const &idx)
	Returns a stapl::future holding the value of the element specified by the index. More...

template<typename F >
void	apply_set (gid_type const &gid, F const &f)
	Applies a function f to the element specified by the GID. More...

template<typename F >
F::result_type	apply_get (gid_type const &gid, F const &f)
	Applies a function f to the element specified by the GID, and returns the result. More...

template<typename F >
F::result_type	apply_get (gid_type const &gid, F const &f) const
	Applies a function f to the element specified by the GID, and returns the result. More...

Public Types
typedef indexed_domain< size_t >	domain_type

typedef domain_type::index_type	index_type

typedef MD	value_type

typedef std::size_t	dimensions_type

typedef base_container_type::iterator	iterator

typedef static_array_traits< MD, OptionalNoInitParam... >	traits_type

typedef base_type::distribution_type	distribution_type

typedef traits_type::gid_type	gid_type

typedef domain_type::size_type	size_type

typedef distribution_type::reference	reference

typedef distribution_type::const_reference	const_reference

typedef distribution_type::const_iterator	const_iterator

typedef static_array_metadata< distribution_type >	loc_dist_metadata

Memory and Domain Management
void	migrate (gid_type const &gid, location_type destination)
	Migrates the element specified by the gid to the destination location. More...

size_type	size (void) const
	Return the number of elements in the container. More...

bool	empty (void) const

distribution_type &	distribution (void)

distribution_type const &	distribution (void) const

distribution_type *	get_distribution (void)

locality_info	locality (gid_type gid)
	Return locality information about the element specified by the gid. More...

template<typename... Indices>
bool	is_local (Indices const &... i) const
	Returns true if the element specified by the GID formed from the index components provided is stored on this location, or false otherwise.

rmi_handle::reference	get_rmi_handle_reference (void)

template<typename DistSpecView >
std::shared_ptr< DistSpecView >	get_spec (DistSpecView const &dist_view, typename std::enable_if< !detail::has_is_composed_dist_spec< DistSpecView >::value >::type *=0)
	Return a shared_ptr to the distribution specification for this container instance. More...

template<typename ComposedSpec >
std::shared_ptr< typename ComposedSpec::distribution_spec >	get_spec (ComposedSpec const &dist_view, typename std::enable_if< detail::has_is_composed_dist_spec< ComposedSpec >::value >::type *=0)
	Return a shared_ptr to the distribution specification for this container instance that is part of a composed container instantiation. More...

Detailed Description

template<typename MD>
class stapl::metadata::flat_container< MD >

Container for metadata used when the number of elements (metadata information) is known at the construction time.

This container behaves as an array.

Template Parameters

MD	Type of the metadata used to store the metadata information.

Member Function Documentation

◆ begin() [1/2]

template<typename MD >

iterator stapl::metadata::flat_container< MD >::begin ( void )

Returns an iterator to the beginning of the local base container.

This iterator is used to traverse the local data.

Note: There is only one base container per location.

◆ end() [1/2]

template<typename MD >

iterator stapl::metadata::flat_container< MD >::end ( void )

Returns an iterator to the end of the local base container.

This iterator is used to traverse the local data.

Note: There is only one base container per location.

◆ get_local_vid()

template<typename MD >

size_t stapl::metadata::flat_container< MD >::get_local_vid ( size_t index )

Returns the global index of the given local index.

◆ get_location_element()

template<typename MD >

location_type stapl::metadata::flat_container< MD >::get_location_element ( size_t index ) const

Returns the location where the metadata indexed by index is located.

◆ local_size()

template<typename MD >

size_t stapl::metadata::flat_container< MD >::local_size ( void ) const

Returns the number of local elements (number of elements in the base container).

◆ operator[]() [1/2]

reference stapl::static_array< MD , OptionalNoInitParam >::operator[] ( gid_type const & gid )

inherited

Construct a reference to a specific index of the array.

Parameters

gid	The index for which to create the reference

Returns: A proxy of the value at gid

◆ operator[]() [2/2]

const_reference stapl::static_array< MD , OptionalNoInitParam >::operator[] ( gid_type const & gid ) const

inherited

Construct a const_reference to a specific index of the array.

Parameters

gid	The index for which to create the reference

Returns: A proxy of the value at gid

◆ front() [1/2]

reference stapl::static_array< MD , OptionalNoInitParam >::front ( )

inherited

Construct a reference to the first element of the array.

Returns: A proxy of the value of the element at the first index.

◆ front() [2/2]

const_reference stapl::static_array< MD , OptionalNoInitParam >::front ( ) const

inherited

Construct a const_reference to the first element of the array.

Returns: A proxy of the value of the element at the first index.

◆ back() [1/2]

reference stapl::static_array< MD , OptionalNoInitParam >::back ( )

inherited

Construct a reference to the last element of the array.

Returns: A proxy of the value of the element at the last index.

◆ back() [2/2]

const_reference stapl::static_array< MD , OptionalNoInitParam >::back ( ) const

inherited

Construct a const_reference to the last element of the array.

Returns: A proxy of the value of the element at the last index.

◆ make_reference() [1/2]

reference stapl::static_array< MD , OptionalNoInitParam >::make_reference ( gid_type const & gid )

inherited

Construct a reference to a specific index of the array.

Parameters

gid	The index for which to create the reference

Returns: A proxy of the value at gid

◆ make_reference() [2/2]

const_reference stapl::static_array< MD , OptionalNoInitParam >::make_reference ( gid_type const & gid ) const

inherited

Construct a const_reference to a specific index of the array.

Parameters

gid	The index for which to create the reference

Returns: A proxy of the value at gid

◆ begin() [2/2]

const_iterator stapl::static_array< MD , OptionalNoInitParam >::begin ( void ) const

inherited

Construct an const_iterator to the beginning of the array.

Returns: A global const_iterator to GID 0

◆ cbegin()

const_iterator stapl::static_array< MD , OptionalNoInitParam >::cbegin ( void ) const

inherited

Construct an const_iterator to the beginning of the array.

Returns: A global const_iterator to GID 0

◆ end() [2/2]

const_iterator stapl::static_array< MD , OptionalNoInitParam >::end ( void ) const

inherited

Construct an const_iterator to one past the end of the array.

Returns: A global const_iterator of the end

◆ cend()

const_iterator stapl::static_array< MD , OptionalNoInitParam >::cend ( void ) const

inherited

Construct an const_iterator to one past the end of the array.

Returns: A global const_iterator of the end

◆ make_iterator() [1/2]

iterator stapl::static_array< MD , OptionalNoInitParam >::make_iterator ( index_type const & index )

inherited

Construct an iterator to a specific index of the array.

Parameters

index The index for which to create the iterator

Returns: An iterator to the value at index

◆ make_iterator() [2/2]

const_iterator stapl::static_array< MD , OptionalNoInitParam >::make_iterator ( index_type const & index ) const

inherited

Construct an iterator to a specific index of the array.

Parameters

index The index for which to create the iterator

Returns: An iterator to the value at index

◆ redistribute() [1/2]

template<typename C, bool = is_p_object< typename detail::get_nested_stored_value_type< container_traits<C> >::type>::value>

template<typename DistSpecView >

std::enable_if< (is_distribution_view<DistSpecView>::value || detail::has_is_composed_dist_spec<DistSpecView>::value) && is_view_based<partition_type>::value && is_view_based<mapper_type>::value>::type stapl::container< C, bool >::redistribute ( DistSpecView const & dist_view )

inherited

Redistribute the data stored in the container to match the distribution specified by the distribution view provided.

Parameters

dist_view View-based specification of the desired distribution.

Note: The method is only available in array instances that use view_based_partition and view_based_mapper as their partition and mapper types, respectively.

◆ redistribute() [2/2]

template<typename C, bool = is_p_object< typename detail::get_nested_stored_value_type< container_traits<C> >::type>::value>

template<typename DistSpecView >

inherited

Redistribute the data stored in the container to match the distribution specified by the distribution view provided.

Parameters

dist_view View-based specification of the desired distribution.

This function is invoked from the proxy when nested containers are being redistributed.

Note: The method is only available in array instances that use view_based_partition and view_based_mapper as their partition and mapper types, respectively.

◆ set_element()

template<typename C>

void stapl::detail::container_impl< C >::set_element	(	index_type const &	idx,
		value_type const &	val
	)

inherited

Sets the element specified by the index to the provided value.

Parameters

idx	GID of the element to be set.
val	The new value of the element.

◆ set_elements()

template<typename C>

template<typename View >

void stapl::detail::container_impl< C >::set_elements	(	index_type const &	idx,
		View &&	vals
	)

inherited

Sets a range of elements starting with a given index to a sequence of provided values.

Parameters

idx	GID of start of element range to be set.
vals	The new values to be assigned to the element range.

◆ get_element()

template<typename C>

value_type stapl::detail::container_impl< C >::get_element ( index_type const & idx ) const

inherited

Returns the value of the element specified by the index.

Parameters

idx	GID of the element to be retrieved.

Returns: The value of the element.

◆ get_element_split()

template<typename C>

future<value_type> stapl::detail::container_impl< C >::get_element_split ( index_type const & idx )

inherited

Returns a stapl::future holding the value of the element specified by the index.

Parameters

idx	GID of the element to be set.

Returns: The future holding the value of the element.

◆ apply_set()

template<typename C>

template<typename F >

void stapl::detail::container_impl< C >::apply_set	(	gid_type const &	gid,
		F const &	f
	)

inherited

Applies a function f to the element specified by the GID.

Parameters

gid	The GID of the element.
f	The Functor to apply on the element.

◆ apply_get() [1/2]

template<typename C>

template<typename F >

F::result_type stapl::detail::container_impl< C >::apply_get	(	gid_type const &	gid,
		F const &	f
	)

inherited

Applies a function f to the element specified by the GID, and returns the result.

Parameters

gid	The GID of the element.
f	The Functor to apply on the element.

Returns: The result of applying the functor to the element.

◆ apply_get() [2/2]

template<typename C>

template<typename F >

F::result_type stapl::detail::container_impl< C >::apply_get	(	gid_type const &	gid,
		F const &	f
	)		const

inherited

Applies a function f to the element specified by the GID, and returns the result.

Parameters

gid	The GID of the element.
f	The Functor to apply on the element.

Returns: The result of applying the functor to the element.

◆ migrate()

template<typename C>

void stapl::detail::container_impl< C >::migrate	(	gid_type const &	gid,
		location_type	destination
	)

inherited

Migrates the element specified by the gid to the destination location.

Parameters

gid	GID of the element to be migrated.
destination	Id of the location where the element is to be migrated.

◆ size()

template<typename C>

size_type stapl::detail::container_impl< C >::size ( void ) const

inherited

Return the number of elements in the container.

This method is one-sided, If other locations may be concurrently performing operations that change their local size and the effects are desired to be observed in a deterministic way, then appropriate synchronization, e.g. a fence, may be required before or after the call to size, to enforce appropriate ordering.

◆ locality()

template<typename C>

locality_info stapl::detail::container_impl< C >::locality ( gid_type gid )

inherited

Return locality information about the element specified by the gid.

Returns: A locality_qualifier, affinity specifier, as well as this object's handle and associated location for this affinity.

◆ get_spec() [1/2]

template<typename C>

template<typename DistSpecView >

std::shared_ptr<DistSpecView> stapl::detail::container_impl< C >::get_spec	(	DistSpecView const &	dist_view,
		typename std::enable_if< !detail::has_is_composed_dist_spec< DistSpecView >::value >::type *	= `0`
	)

protectedinherited

Return a shared_ptr to the distribution specification for this container instance.

This function is called by redistribute when the distribution specification provided is for a single container instance instead of a collection of composed container instance.

Parameters

dist_view Instantiation of distribution_spec that describes the target distribution for redistribute

Returns: shared_ptr to the distribution specification

◆ get_spec() [2/2]

template<typename C>

template<typename ComposedSpec >

std::shared_ptr<typename ComposedSpec::distribution_spec> stapl::detail::container_impl< C >::get_spec	(	ComposedSpec const &	dist_view,
		typename std::enable_if< detail::has_is_composed_dist_spec< ComposedSpec >::value >::type *	= `0`
	)

protectedinherited

Return a shared_ptr to the distribution specification for this container instance that is part of a composed container instantiation.

This function is called by redistribute when the distribution specification provided is for all container instances of a composed container.

Parameters

dist_view Instantiation of composed_dist_spec that describes the target distributions for redistribute for all container instances in a composed container

Returns: shared_ptr to the distribution specification for this container instance

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

flat.hpp

Public Member Functions

Public Types

Memory and Domain Management

Detailed Description

template<typename MD> class stapl::metadata::flat_container< MD >

Member Function Documentation

◆ begin() [1/2]

◆ end() [1/2]

◆ get_local_vid()

◆ get_location_element()

◆ local_size()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ make_reference() [1/2]

◆ make_reference() [2/2]

◆ begin() [2/2]

◆ cbegin()

◆ end() [2/2]

◆ cend()

◆ make_iterator() [1/2]

◆ make_iterator() [2/2]

◆ redistribute() [1/2]

◆ redistribute() [2/2]

◆ set_element()

◆ set_elements()

◆ get_element()

◆ get_element_split()

◆ apply_set()

◆ apply_get() [1/2]

◆ apply_get() [2/2]

◆ migrate()

◆ size()

◆ locality()

◆ get_spec() [1/2]

◆ get_spec() [2/2]

template<typename MD>
class stapl::metadata::flat_container< MD >