STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Types | Static Public Attributes
stapl::skeletons::skeletons_impl::do_while_pd< ContCond > Class Template Reference

A do_while parametric dependency represents an element in the dependence graph that controls if the next iteration of a do-while loop should be spawned or not. It does that by wrapping user's ContCond by do_while_stub with and sending memento_stack to it. More...

Public Member Functions

 do_while_pd (ContCond op)
 
template<typename Coord , typename Visitor , typename In >
void case_of (Coord const &skeleton_size, Coord const &coord, Visitor &visitor, In &&in_flow) const
 If coord is <i, h, ...> it wraps the WF with the following inputs and sends it to the visitor along with the m_op. More...
 
template<typename Size , typename Coord , typename FlowIndex >
std::size_t consumer_count (Size const &, Coord const &, FlowIndex) const
 determines how many of the instances of this parametric dependency will be consuming from a producer with a given coordinate. This is a reverse query as compared to case_of. More...
 
template<typename Coord >
int get_result_id (Coord const &, Coord const &) const
 
template<typename Coord , typename Span >
void configure (Coord &&, Span &&)
 

Public Types

using op_type = do_while_stubs< ContCond >
 

Static Public Attributes

static constexpr std::size_t in_port_size = 1
 
static constexpr std::size_t op_arity = 2
 

Detailed Description

template<typename ContCond>
class stapl::skeletons::skeletons_impl::do_while_pd< ContCond >

A do_while parametric dependency represents an element in the dependence graph that controls if the next iteration of a do-while loop should be spawned or not. It does that by wrapping user's ContCond by do_while_stub with and sending memento_stack to it.

Template Parameters
ContConda user provided continuation functor
See also
do_while

Member Function Documentation

◆ case_of()

template<typename ContCond >
template<typename Coord , typename Visitor , typename In >
void stapl::skeletons::skeletons_impl::do_while_pd< ContCond >::case_of ( Coord const &  skeleton_size,
Coord const &  coord,
Visitor &  visitor,
In &&  in_flow 
) const

If coord is <i, h, ...> it wraps the WF with the following inputs and sends it to the visitor along with the m_op.

  • in<0>[i]
  • current memento_stack
Parameters
skeleton_size<n, m, p, ...> where each element is potentially multi-dimensional.
coord<i, j, k, ...> where i < n, j < m, k < p
visitorthe information about WF and input is passed so that later this information can be converted to a node in the dependence graph
in_flowa tuple of input flows to consume from

◆ consumer_count()

template<typename ContCond >
template<typename Size , typename Coord , typename FlowIndex >
std::size_t stapl::skeletons::skeletons_impl::do_while_pd< ContCond >::consumer_count ( Size const &  ,
Coord const &  ,
FlowIndex   
) const

determines how many of the instances of this parametric dependency will be consuming from a producer with a given coordinate. This is a reverse query as compared to case_of.

Template Parameters
FlowIndexthe flow index to which this request is sent

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