stapl::view_coarsen_impl::coarsen_container< View, CP > Class Template Reference

Defines a container used to produce subviews with extra information about locality (mix_views), based on the given the metadata information (metadata container). More...

Public Member Functions
View *	get_container (void) const
View const &	container (void) const
coarsen_partition_type const &	get_partition (void) const
	coarsen_container (View const &view, coarsen_partition_type const &new_part)
value_type	operator[] (gid_type const &index)
const_reference	operator[] (gid_type const &index) const
value_type	get_element (gid_type const &index)
	Returns a view based on the metadata associated with the position index. More...
const_reference	get_element (gid_type const &index) const
	Returns a const view based on the metadata associated with the position index. More...
size_t	size (void) const
gid_type	dimensions (void) const
domain_type	domain () const
size_t	local_size (void) const
	Returns the number of local elements associated with this location.
size_t	get_local_vid (gid_type const &index) const
	Returns the global index of the given local index.
locality_info	locality (gid_type const &index)
	Return locality information about the element specified by the gid. More...
location_type	get_location_element (gid_type const &index) const
	Returns the location where the metadata indexed by index is located.
runtime::location_md const &	get_location_md (void) const noexcept
	Returns the location metadata of the location this object registered in.
runtime::location_md &	get_location_md (void) noexcept
	Returns the location metadata of the location this object registered in. noexcept More...
Distributed Object Management
rmi_handle::const_reference const &	get_rmi_handle (void) const noexcept
	Returns the associated rmi_handle.
rmi_handle::reference const &	get_rmi_handle (void) noexcept
	Returns the associated rmi_handle.
size_type	get_location_id (void) const noexcept
	Returns the location id of the local sub-object.
size_type	get_num_locations (void) const noexcept
	Returns the number of locations of the gang of this p_object.
void	advance_epoch (void)
	Advances the epoch of the object. More...
void	unlock (void)
	Used by lock_guard functionality in method of derived classes to request atomicity with respect to incoming RMIs. More...
void	lock (void)
	Used by lock_guard functionality in method of derived classes to request atomicity with respect to incoming RMIs. More...
bool	try_lock (void)
	Attempt to maintain atomicity with respect to incoming RMIs. More...

Public Types
typedef select_coarsen_container_domain< dimension_t::value, metadata_traits< CP >::is_isomorphic::value &&dimension_t::value !=1 >::type	domain_type
typedef domain_type::gid_type	gid_type
typedef dimension_traits< gid_type >::type	dimension_type
typedef mix_view< View, md_info_t, gid_type >	value_type
typedef value_type	reference
typedef const value_type	const_reference
using	size_type = rmi_handle::size_type

Detailed Description

template<typename View, typename CP>
class stapl::view_coarsen_impl::coarsen_container< View, CP >

Defines a container used to produce subviews with extra information about locality (mix_views), based on the given the metadata information (metadata container).

Template Parameters

View	Type of view that is used to extract locality.
CP	Metadata container type.

Member Function Documentation

get_element() [1/2]

template<typename View , typename CP >

value_type stapl::view_coarsen_impl::coarsen_container< View, CP >::get_element

(

gid_type const &

index

)

Returns a view based on the metadata associated with the position index.

The view behaves as is defined by the type View and contains extra information about data locality of the elements the generated view references.

get_element() [2/2]

template<typename View , typename CP >

const_reference stapl::view_coarsen_impl::coarsen_container< View, CP >::get_element

(

gid_type const &

index

)

const

Returns a const view based on the metadata associated with the position index.

The view behaves as is defined by the type View and contains extra information about data locality of the elements the generated view references.

locality()

template<typename View , typename CP >

locality_info stapl::view_coarsen_impl::coarsen_container< View, CP >::locality

(

gid_type const &

index

)

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

runtime::location_md& stapl::p_object::get_location_md ( void  )

noexceptinherited

Returns the location metadata of the location this object registered in. noexcept

noexcept

advance_epoch()

void stapl::p_object::advance_epoch ( void  )

inherited

Advances the epoch of the object.

Advancing the epoch will flush any pending RMIs. It will also increase the epoch of the current gang if the object is not a named object.

unlock()

void stapl::p_object::unlock ( void  )

inherited

Used by lock_guard functionality in method of derived classes to request atomicity with respect to incoming RMIs.

Mutates counter in the associated runqueue.

lock()

void stapl::p_object::lock ( void  )

inherited

Used by lock_guard functionality in method of derived classes to request atomicity with respect to incoming RMIs.

Mutates counter in the associated runqueue.

try_lock()

bool stapl::p_object::try_lock ( void  )

inherited

Attempt to maintain atomicity with respect to incoming RMIs.

Mutates counter in the associated runqueue.

Returns

true if the lock was able to be acquired. false if it is already locked.

---

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

• coarsen_container.hpp