STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types | Protected Member Functions | Protected Attributes
stapl::task_factory_base Class Reference

Intermediate class of the task factory hierarchy that provides the edge_mf_type for all factories that derive from it. More...

Public Member Functions

 task_factory_base (bool b_incremental_generation=false)
 
bool finished () const
 
virtual void reset ()
 
runtime::location_md const & get_location_md (void) const noexcept
 Returns the location metadata of the location this object registered in.
 
runtime::location_mdget_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 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_baseget_view_index_iterator (std::size_t n) const
 

Protected Attributes

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

Detailed Description

Intermediate class of the task factory hierarchy that provides the edge_mf_type for all factories that derive from it.

Member Function Documentation

◆ reset_view_indices()

void stapl::task_factory_base::reset_view_indices ( )
protected

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