stapl::vector_container_manager< BContainer > Class Template Reference

Container manager used for the vector container. More...

Public Member Functions
template<typename Partition , typename Mapper >
	vector_container_manager (Partition const &partition, Mapper const &mapper)
	Constructor that initializes the initial metadata for the base container. More...
template<typename Partition , typename Mapper >
	vector_container_manager (Partition const &partition, Mapper const &mapper, value_type const &default_value)
	Create a container manager with a specific partition and mapper. More...
void	insert (gid_type gid, value_type const &value, cid_type dest)
	Inserts the given value in the given gid position, updating the base container metadata accordingly.
void	erase (gid_type gid)
	Removes the element associated to the given gid, updating the base container metadata accordingly.
gid_type	push_back (value_type const &value)
	Add an element at the end of the vector. More...
gid_type	pop_back (void)
	Removes the last element of the vector.
void	update_domains (size_t first)
	Adjusts the associated domain to each base container based on the given first position. More...
void	redistribute (Partition const &partition, Mapper const &mapper, typename std::enable_if< is_view_based< Partition >::value &&is_view_based< Mapper >::value >::type *=0)
	Performs redistribution of the container elements into a new set of bContainers on possibly different locations to match the distribution specified by the partition and mapper provided. More...
size_t	rank (base_container_type *bc)
	Return the global rank of this base container in the pContainer. More...
cid_type	within (gid_type const &gid)
	Return which base container a specified GID is in. More...
void	add_element (gid_type const &gid, value_type const &val)
	Adds an element (container element) to this base container manager. Updates metadata accordingly. More...
void	remove_element (gid_type const &gid)
	Removes an element from this base container manager. Updates metadata accordingly. More...
void	clear (void)
bool	contains (gid_type const &gid) const
	Returns whether or not this base container manager is responsible for an element. More...
size_t	num_elements (void) const
	Returns number of elements in all base containers owned by this base container manager.
template<typename Functor >
void	apply_set (gid_type const &gid, Functor const &f)
	Applies an arbitrary functor to the element with specified GID. More...
template<typename Functor , typename Container >
void	apply (gid_type const &gid, Functor const &f, Container *container)
	Applies a function f to the element specified by the GID. More...
template<typename Functor >
bool	contains_apply_set (gid_type const &gid, Functor const &f)
	Applies an arbitrary functor to the element at position GID if the element exists at this location. More...
template<typename Functor >
boost::result_of< Functor(value_type &)>::type	apply_get (gid_type const &gid, Functor const &f)
	Applies an arbitrary functor to the element with specified GID and returns the result. More...
template<typename Functor >
Functor::result_type	apply_get (gid_type const &gid, Functor const &f) const
	Applies an arbitrary functor to the element with specified GID and returns the result. More...
template<typename Functor >
boost::optional< typename Functor::result_type >	contains_apply_get (gid_type const &gid, Functor const &f)
	Applies an arbitrary functor to the element at position GID if the element exists at this location. More...
template<typename Functor >
boost::optional< typename boost::result_of< Functor(value_type &)>::type >	contains_apply_get (gid_type const &gid, Functor const &f) const
	Applies an arbitrary functor to the element at position GID if the element exists at this location. More...
template<typename Class , typename... PMFArgs, typename... Args>
bool	contains_invoke (gid_type const &gid, void(Class::*pmf)(PMFArgs...), Args &&... args)
	Invokes a base container method on the given gid if it is present on this location. More...
template<typename Class , typename Rtn , typename... PMFArgs, typename... Args>
boost::optional< Rtn >	contains_invoke (gid_type const &gid, Rtn(Class::*pmf)(PMFArgs...), Args &&... args)
	Invokes a base container method on the given gid if it is present on this location. More...
template<typename Class , typename... PMFArgs, typename... Args>
void	invoke (gid_type const &gid, void(Class::*const pmf)(PMFArgs...), Args &&... args)
	Invoke a base container method on an element at a certain GID. The element must exist in the current base container manager. More...
template<typename Class , typename Rtn , typename... PMFArgs, typename... Args>
Rtn	invoke (gid_type const &gid, Rtn(Class::*pmf)(PMFArgs...), Args &&... args)
	Invoke a base container method on an element at a certain GID. The the result. The element must exist in the current base container manager. More...
template<typename Class , typename Rtn , typename... PMFArgs, typename... Args>
Rtn	const_invoke (gid_type const &gid, Rtn(Class::*const pmf)(PMFArgs...), Args &&... args) const
	Invoke a base container method on an element at a certain GID. The the result. The element must exist in the current base container manager. More...
template<typename Comparator , typename Class , typename... PMFArgs, typename... Args>
void	min_invoke (Comparator const &comp, void(Class::*pmf)(PMFArgs...), Args &&... args)
	Invoke a base container method returning void on the base container that minimizes a user-defined comparator over the base containers. More...
template<typename Comparator , typename Class , typename Rtn , typename... PMFArgs, typename... Args>
Rtn	min_invoke (Comparator const &comp, Rtn(Class::*pmf)(PMFArgs...), Args &&... args)
	Invoke a base container method returning void on the base container that minimizes a user-defined comparator over the base containers. More...

Public Types
typedef BContainer	base_container_type
typedef BContainer::gid_type	gid_type
typedef BContainer::cid_type	cid_type
typedef BContainer::value_type	value_type
typedef base_type::storage_type	storage_type
typedef base_container_ordering	ordering_type
	Type of base container ordering that will be enforced.
typedef ordering_type::ptr_bcontainer_type	ptr_bcontainer_type

Public Attributes
ordering_type	m_ordering
	Handle ordering amongst base containers across all locations.

Protected Types
typedef base_type::interval_type	interval_type

Detailed Description

template<typename BContainer>
class stapl::vector_container_manager< BContainer >

Container manager used for the vector container.

Template Parameters

BContainer

The vector base container type.

Constructor & Destructor Documentation

vector_container_manager() [1/2]

template<typename BContainer >

template<typename Partition , typename Mapper >

stapl::vector_container_manager< BContainer >::vector_container_manager	(	Partition const &	partition,
		Mapper const &	mapper
	)

Constructor that initializes the initial metadata for the base container.

Parameters

partition	Partition object that translates elements to CIDs
mapper	Mapper object that translates CIDs to locations.

vector_container_manager() [2/2]

template<typename BContainer >

template<typename Partition , typename Mapper >

stapl::vector_container_manager< BContainer >::vector_container_manager	(	Partition const &	partition,
		Mapper const &	mapper,
		value_type const &	default_value
	)

Create a container manager with a specific partition and mapper.

Parameters

partition	Partition object that translates elements to CIDs
mapper	Mapper object that translates CIDs to locations.
default_value	The default value for all elements in the base container.

Member Function Documentation

push_back()

template<typename BContainer >

gid_type stapl::vector_container_manager< BContainer >::push_back

(

value_type const &

value

)

Add an element at the end of the vector.

Parameters

v	The element to add.

update_domains()

template<typename BContainer >

void stapl::vector_container_manager< BContainer >::update_domains

(

size_t

first

)

Adjusts the associated domain to each base container based on the given first position.

This method is invoked during the metadata synchronization (

See also

vector_distribution::synchronize_metadata).

redistribute()

void stapl::container_manager< BContainer, interval_container_registry<BContainer> >::redistribute ( Partition const &  partition, Mapper const &  mapper, typename std::enable_if< is_view_based< Partition >::value &&is_view_based< Mapper >::value >::type *  = 0  )

inherited

Performs redistribution of the container elements into a new set of bContainers on possibly different locations to match the distribution specified by the partition and mapper provided.

Parameters

partition	provides methods necessary to map element GIDs to the ids of the partitions (bContainers) that will store them.
mapper	provides the methods necessary to map partition ids to the ids of the locations that will store the partitions.

The method is only available when view-based partition and mapper instances are used. The distributor instance is given the partition and mapper information in the constructor. The distributor function operator is given the current set of bContainers and their ordering in order to perform the redistribution.

rank()

size_t stapl::container_manager< BContainer, interval_container_registry<BContainer> >::rank ( base_container_type *  bc )

inherited

Return the global rank of this base container in the pContainer.

within()

cid_type stapl::container_manager< BContainer, interval_container_registry<BContainer> >::within ( gid_type const &  gid )

inherited

Return which base container a specified GID is in.

add_element()

void stapl::container_manager< BContainer, interval_container_registry<BContainer> >::add_element ( gid_type const &  gid, value_type const &  val  )

inherited

Adds an element (container element) to this base container manager. Updates metadata accordingly.

Parameters

gid	GID of the element to be added.
val	Value of the element to be added.

remove_element()

void stapl::container_manager< BContainer, interval_container_registry<BContainer> >::remove_element ( gid_type const &  gid )

inherited

Removes an element from this base container manager. Updates metadata accordingly.

Parameters

gid	GID of the element to be removed.

contains()

template<typename Registry>

bool stapl::container_manager_base< Registry >::contains ( gid_type const &  gid ) const

inherited

Returns whether or not this base container manager is responsible for an element.

Parameters

gid	GID for the element in question.

apply_set()

template<typename Registry>

template<typename Functor >

void stapl::container_manager_base< Registry >::apply_set ( gid_type const &  gid, Functor const &  f  )

inherited

Applies an arbitrary functor to the element with specified GID.

Parameters

gid	GID of the element on which to apply the functor
f	Functor to apply

apply()

template<typename Registry>

template<typename Functor , typename Container >

void stapl::container_manager_base< Registry >::apply ( gid_type const &  gid, Functor const &  f, Container *  container  )

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.

contains_apply_set()

template<typename Registry>

template<typename Functor >

bool stapl::container_manager_base< Registry >::contains_apply_set ( gid_type const &  gid, Functor const &  f  )

inherited

Applies an arbitrary functor to the element at position GID if the element exists at this location.

Parameters

gid	GID of the element on which to apply the functor.
f	Functor to apply.

apply_get() [1/2]

template<typename Registry>

template<typename Functor >

boost::result_of<Functor(value_type&)>::type stapl::container_manager_base< Registry >::apply_get ( gid_type const &  gid, Functor const &  f  )

inherited

Applies an arbitrary functor to the element with specified GID and returns the result.

Parameters

gid	GID of the element on which to apply the functor
f	Functor to apply

Returns

Result of applying the functor to the element

apply_get() [2/2]

template<typename Registry>

template<typename Functor >

Functor::result_type stapl::container_manager_base< Registry >::apply_get ( gid_type const &  gid, Functor const &  f  ) const

inherited

Applies an arbitrary functor to the element with specified GID and returns the result.

Parameters

gid	GID of the element on which to apply the functor
f	Functor to apply

Returns

Result of applying the functor to the element

contains_apply_get() [1/2]

template<typename Registry>

template<typename Functor >

boost::optional<typename Functor::result_type> stapl::container_manager_base< Registry >::contains_apply_get ( gid_type const &  gid, Functor const &  f  )

inherited

Applies an arbitrary functor to the element at position GID if the element exists at this location.

Parameters

gid	GID of the element on which to apply the functor.
f	Functor to apply.

contains_apply_get() [2/2]

template<typename Registry>

template<typename Functor >

boost::optional<typename boost::result_of<Functor(value_type&)>::type> stapl::container_manager_base< Registry >::contains_apply_get ( gid_type const &  gid, Functor const &  f  ) const

inherited

Applies an arbitrary functor to the element at position GID if the element exists at this location.

Parameters

gid	GID of the element on which to apply the functor.
f	Functor to apply.

contains_invoke() [1/2]

template<typename Registry>

template<typename Class , typename... PMFArgs, typename... Args>

bool stapl::container_manager_base< Registry >::contains_invoke ( gid_type const &  gid, void(Class::*)(PMFArgs...)  pmf, Args &&...  args  )

inherited

Invokes a base container method on the given gid if it is present on this location.

Parameters

gid	The GID of the element to invoke the method on.
pmf	A pointer to a base container's member method.
args	Arguments to pmf.

Returns

True if gid was found and functor applied, otherwise return false.

contains_invoke() [2/2]

template<typename Registry>

template<typename Class , typename Rtn , typename... PMFArgs, typename... Args>

boost::optional<Rtn> stapl::container_manager_base< Registry >::contains_invoke ( gid_type const &  gid, Rtn(Class::*)(PMFArgs...)  pmf, Args &&...  args  )

inherited

Invokes a base container method on the given gid if it is present on this location.

Parameters

gid	The GID of the element to invoke the method on.
pmf	A pointer to a base container's member method.
args	Arguments to pmf.

Returns

boost::optional with result of invocation if element was found.

invoke() [1/2]

template<typename Registry>

template<typename Class , typename... PMFArgs, typename... Args>

void stapl::container_manager_base< Registry >::invoke ( gid_type const &  gid, void(Class::*)(PMFArgs...)  pmf, Args &&...  args  )

inherited

Invoke a base container method on an element at a certain GID. The element must exist in the current base container manager.

Parameters

gid	The GID of the element to invoke the method on.
pmf	A pointer to a base container's member method.
args	Arguments to pmf.

invoke() [2/2]

template<typename Registry>

template<typename Class , typename Rtn , typename... PMFArgs, typename... Args>

Rtn stapl::container_manager_base< Registry >::invoke ( gid_type const &  gid, Rtn(Class::*)(PMFArgs...)  pmf, Args &&...  args  )

inherited

Invoke a base container method on an element at a certain GID. The the result. The element must exist in the current base container manager.

Parameters

gid	The GID of the element to invoke the method on.
pmf	A pointer to a base container's member method.
args	Arguments to pmf.

Returns

The result of invoking the function pointer.

const_invoke()

template<typename Registry>

template<typename Class , typename Rtn , typename... PMFArgs, typename... Args>

Rtn stapl::container_manager_base< Registry >::const_invoke ( gid_type const &  gid, Rtn(Class::*)(PMFArgs...)  pmf, Args &&...  args  ) const

inherited

Invoke a base container method on an element at a certain GID. The the result. The element must exist in the current base container manager.

Parameters

gid	The GID of the element to invoke the method on.
pmf	A pointer to a base container's member method.
args	Arguments to pmf.

Returns

The result of invoking the function pointer.

min_invoke() [1/2]

template<typename Registry>

template<typename Comparator , typename Class , typename... PMFArgs, typename... Args>

void stapl::container_manager_base< Registry >::min_invoke ( Comparator const &  comp, void(Class::*)(PMFArgs...)  pmf, Args &&...  args  )

inherited

Invoke a base container method returning void on the base container that minimizes a user-defined comparator over the base containers.

Parameters

comp	Comparator that receives two base containers and returns the more optimal of the two.
pmf	A pointer to a base container's member method.
args	Arguments to pmf.

min_invoke() [2/2]

template<typename Registry>

template<typename Comparator , typename Class , typename Rtn , typename... PMFArgs, typename... Args>

Rtn stapl::container_manager_base< Registry >::min_invoke ( Comparator const &  comp, Rtn(Class::*)(PMFArgs...)  pmf, Args &&...  args  )

inherited

Invoke a base container method returning void on the base container that minimizes a user-defined comparator over the base containers.

Parameters

comp	Comparator that receives two base containers and returns the more optimal of the two.
pmf	A pointer to a base container's member method.
args	Arguments to pmf.

Returns

The result of invoking the function pointer

---

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

• vector_container_manager.hpp