STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Classes | Public Member Functions | Public Types | Public Attributes | Protected Member Functions
stapl::partitioned_mix_view< View, Part, CC > Class Template Reference

Represents a view over the partitioned distributed locality metadata used to specify the data used in the tasks. More...

Classes

struct  loc_dist_metadata
 Functor to extract locality metadata from the partitioned mix view. More...
 

Public Member Functions

 partitioned_mix_view (partitioned_mix_view const &other)
 
template<typename Cont >
 partitioned_mix_view (Cont *c)
 
location_type get_location_element (index_type const &index) const
 Returns the location associated with the elements indexed with the given index.
 
bool is_valid (void) const
 
view_container_typeget_container (void) const
 
view_container_typecontainer (void)
 
view_container_typecontainer (void) const
 
domain_type const & domain (void) const
 
domain_type & domain (void)
 
void set_domain (domain_type const &dom)
 
map_func_type const & mapfunc (void) const
 
size_type size (void) const
 Returns the number of elements referenced for the view.
 
bool empty (void) const
 Returns true if the view does not reference any element.
 
size_t get_num_subviews () const
 Returns the number of elements referenced by the view. More...
 
size_t get_num_local_subviews () const
 Returns the number of elements stored locally, referenced for the view.
 
value_t get_subview (cid_type const &i) const
 Returns the element associated with the position i. More...
 
cid_type get_local_vid (cid_type const &index) const
 Returns the global index of the given local index.
 
View Read Operations
value_type get_element (index_t const &index) const
 Get the element index from the container. More...
 
future< value_type > get_element_split (index_t const &index) const
 Get the element index from the container. More...
 
Functor::result_type apply_get (index_t const &index, Functor f)
 Applies the provided function to the value referenced for the given index and returns the result of the operation. More...
 
Functor::result_type apply_get (index_t const &index, Functor f) const
 
View Subscript Operations
reference_t operator[] (index_t const &index) const
 The bracket operator is the basic access method.
 
reference_t make_reference (index_t const &index) const
 
Sequence Iterator
Warning
Methods in the Sequence Iterator group should only be used inside a work function which is processing a segmented view.
iterator begin (void)
 
const_iterator begin (void) const
 
iterator end (void)
 
const_iterator end (void) const
 
iterator make_iterator (index_t i)
 
index_t next (index_t const &index) const
 Computes the next index based on the given index. More...
 
index_t prev (index_t const &index) const
 Computes the previous index based on the given index. More...
 
index_t advance (index_t const &index, Distance n) const
 Computes the new index after advance n positions from the given index. More...
 
long distance (index_t const &index1, index_t const &index2) const
 
bool less_than (index_t const &index1, index_t const &index2) const
 

Public Types

typedef container_t view_container_type
 
typedef container_t::value_type value_type
 
typedef base_type::domain_type domain_type
 
typedef base_type::map_func_type map_func_type
 
typedef value_type subview_type
 
typedef value_type reference
 
typedef domain_type::size_type size_type
 
typedef domain_type::index_type index_type
 
typedef map_func_type::gid_type gid_type
 
typedef dimension_traits< View >::type dimension_type
 
using cid_type = index_type
 
typedef partitioned_mix_view fast_view_type
 
typedef sequence_op_type::iterator iterator
 
typedef sequence_op_type::const_iterator const_iterator
 
using reference_t = typename view_traits< array_ro_view< C, OptionalParams... > >::reference
 
typedef detail::make_iterator< view_traits< array_ro_view< C, OptionalParams... > >::derived_type, iteratormake_iterator_t
 

Public Attributes

C * m_ptr
 
sptr_type m_sptr
 

Protected Member Functions

C * container_ptr (void) const
 Returns the container's pointer.
 

Detailed Description

template<typename View, typename Part, typename CC>
class stapl::partitioned_mix_view< View, Part, CC >

Represents a view over the partitioned distributed locality metadata used to specify the data used in the tasks.

Template Parameters
ViewType of the original view used to extract the locality metadata.
PartPartition generated during the metadata extraction.
CCContainer used for this view (default is a coarsen_container).

Member Function Documentation

◆ get_container()

view_container_type* stapl::core_view< C, view_traits< array_ro_view< C, OptionalParams... > >::domain_type , view_traits< array_ro_view< C, OptionalParams... > >::map_function >::get_container ( void  ) const
inherited

◆ container()

view_container_type& stapl::core_view< C, view_traits< array_ro_view< C, OptionalParams... > >::domain_type , view_traits< array_ro_view< C, OptionalParams... > >::map_function >::container ( void  ) const
inherited

◆ get_element()

value_type stapl::view_operations::read< array_ro_view< C, OptionalParams... > >::get_element ( index_t const &  index) const
inherited

Get the element index from the container.

Parameters
indexof element to get

◆ get_element_split()

future<value_type> stapl::view_operations::read< array_ro_view< C, OptionalParams... > >::get_element_split ( index_t const &  index) const
inherited

Get the element index from the container.

Parameters
indexof element to get

◆ apply_get() [1/2]

Functor::result_type stapl::view_operations::read< array_ro_view< C, OptionalParams... > >::apply_get ( index_t const &  index,
Functor  f 
)
inherited

Applies the provided function to the value referenced for the given index and returns the result of the operation.

Parameters
indexof element to apply the function
ffunction to apply
Returns
result of evaluate the function f on the value referenced for the index

◆ apply_get() [2/2]

Functor::result_type stapl::view_operations::read< array_ro_view< C, OptionalParams... > >::apply_get ( index_t const &  index,
Functor  f 
) const
inherited

◆ next()

index_t stapl::view_operations::sequence< view_traits< array_ro_view< C, OptionalParams... > >::derived_type , use_default >::next ( index_t const &  index) const
inherited

Computes the next index based on the given index.

Overwriting this method allows produce a different way to traverse the elements referenced by the view.

◆ prev()

index_t stapl::view_operations::sequence< view_traits< array_ro_view< C, OptionalParams... > >::derived_type , use_default >::prev ( index_t const &  index) const
inherited

Computes the previous index based on the given index.

Overwriting this method allows produce a different way to traverse the elements referenced by the view.

◆ advance()

index_t stapl::view_operations::sequence< view_traits< array_ro_view< C, OptionalParams... > >::derived_type , use_default >::advance ( index_t const &  index,
Distance  n 
) const
inherited

Computes the new index after advance n positions from the given index.

Overwriting this method allows produce a different way to traverse the elements referenced by the view.

◆ get_num_subviews()

size_t stapl::view_operations::paragraph_required_operation< partitioned_mix_view< View, Part, CC > >::get_num_subviews ( ) const
inherited

Returns the number of elements referenced by the view.

◆ get_subview()

value_t stapl::view_operations::paragraph_required_operation< partitioned_mix_view< View, Part, CC > >::get_subview ( cid_type const &  i) const
inherited

Returns the element associated with the position i.


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