STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types
stapl::aggregated_edge_subview< ProxyContainer > Class Template Reference

View that provides access to an aggregated collection of task data flow values from the edge_container. More...

Public Member Functions

 aggregated_edge_subview (ProxyContainer ct)
 
 aggregated_edge_subview (aggregated_edge_subview const &other)=default
 
 aggregated_edge_subview (aggregated_edge_subview &&other)=default
 
reference operator[] (std::size_t idx) const
 Return one of the edge value proxies stored in this view class. More...
 
std::size_t size () const
 
constexpr bool is_local (void) const noexcept
 Required for proxies and views to perform dynamic localization in the PARAGRAPH. More...
 
template<typename... Args>
void release (Args &&... args)
 

Public Types

using reference = typename ProxyContainer::value_type::reference_type
 
using index_type = std::size_t
 

Detailed Description

template<typename ProxyContainer>
class stapl::aggregated_edge_subview< ProxyContainer >

View that provides access to an aggregated collection of task data flow values from the edge_container.

Template Parameters
ProxyContainerType of container used by class to store references to each edge value.

This class is the reference type of aggregated_edge_view and is the view type passed to user workfunctions when the associated and task uses the aggregated version of consume function of the public PARAGRAPH interface.

Member Function Documentation

◆ operator[]()

template<typename ProxyContainer >
reference stapl::aggregated_edge_subview< ProxyContainer >::operator[] ( std::size_t  idx) const

Return one of the edge value proxies stored in this view class.

Parameters
idxIndex of edge value to access. Not indexed by task identifier. Range is [0..size()-1].

◆ is_local()

template<typename ProxyContainer >
constexpr bool stapl::aggregated_edge_subview< ProxyContainer >::is_local ( void  ) const
noexcept

Required for proxies and views to perform dynamic localization in the PARAGRAPH.

Values backed by the edge_container are always available locally, as data flow is initialized to whatever location the associated task runs on.


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