stapl::map_factory< WF, b_coarse, SchedInfo > Struct Template Reference

Factory that generates the tasks needed for a map operation. A map operation applies the work function provided on each set of elements of the input views that have the same offset from the beginning of their respective view. More...

Public Member Functions
	map_factory (WF const &wf)
coarsener_type	get_coarsener () const
void	reset ()
	Reset all data members related to the number of tasks that have been generated in order to prepare the factory for PARAGRAPH reinvocation.
bool	finished () const
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
using	result_type = void
using	coarsener_type = typename std::conditional< b_coarse, default_coarsener, null_coarsener >::type
using	size_type = rmi_handle::size_type

Protected Member Functions
bool	initialized (void) const
void	reset_view_indices ()
	Reset the iterators over the view indices on this location. More...
void	set_view_index_iterator (std::size_t idx, view_index_iterator_base *ptr)
std::size_t	view_indices_size () const
view_index_iterator_base *	get_view_index_iterator (std::size_t n) const

Protected Attributes
bool	m_finished
	Stores whether the derived factory has finished specifying tasks.

Detailed Description

template<typename WF, bool b_coarse, typename SchedInfo>
struct stapl::map_factory< WF, b_coarse, SchedInfo >

Factory that generates the tasks needed for a map operation. A map operation applies the work function provided on each set of elements of the input views that have the same offset from the beginning of their respective view.

Template Parameters

WF	Fine-grain operation to be applied to each set of elements.
b_coarse	Indicates whether the work function provided is coarse-grain.
SchedInfo	Scheduling information required from each task by the scheduler that will determine the relative priorities of the tasks when they are ready to execute.

Member Function Documentation

reset_view_indices()

void stapl::task_factory_base::reset_view_indices ( )

protectedinherited

Reset the iterators over the view indices on this location.

This is used in factories where multiple tasks will be generated for each view element to be processed.

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 struct was generated from the following file:

• map_prototype.hpp