Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::split_node< TupleType, Allocator > Class Template Reference

split_node: accepts a tuple as input, forwards each element of the tuple to its More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::split_node< TupleType, Allocator >:
Collaboration diagram for tbb::flow::interface11::split_node< TupleType, Allocator >:

Public Types

typedef TupleType input_type
 
typedef Allocator allocator_type
 
typedef internal::wrap_tuple_elements< N, internal::multifunction_output, TupleType >::type output_ports_type
 
- Public Types inherited from tbb::flow::interface11::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 

Public Member Functions

__TBB_NOINLINE_SYM split_node (graph &g)
 
__TBB_NOINLINE_SYM split_node (const split_node &other)
 
output_ports_typeoutput_ports ()
 
- Public Member Functions inherited from tbb::flow::interface11::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from tbb::flow::interface11::receiver< TupleType >
bool try_put (const typename internal::async_helpers< TupleType >::filtered_type &t)
 Put an item to the receiver. More...
 
bool try_put (const typename internal::async_helpers< TupleType >::async_type &t)
 
- Public Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
virtual ~untyped_receiver ()
 Destructor. More...
 
template<typename X >
bool try_put (const X &t)
 Put an item to the receiver. More...
 
virtual bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 

Protected Member Functions

tasktry_put_task (const TupleType &t) __TBB_override
 Put item to successor; return task to run the successor if possible. More...
 
void reset_node (reset_flags f) __TBB_override
 
void reset_receiver (reset_flags) __TBB_override
 put receiver back in initial state More...
 
graphgraph_reference () const __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::receiver< TupleType >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual bool is_continue_receiver ()
 

Private Types

typedef receiver< TupleType > base_type
 

Private Attributes

output_ports_type my_output_ports
 

Static Private Attributes

static const int N = tbb::flow::tuple_size<TupleType>::value
 

Additional Inherited Members

- Public Attributes inherited from tbb::flow::interface11::receiver< TupleType >
__TBB_DEPRECATED typedef TupleType input_type
 The input type of this receiver. More...
 
__TBB_DEPRECATED typedef internal::async_helpers< TupleType >::filtered_type filtered_type
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Detailed Description

template<typename TupleType, typename Allocator = cache_aligned_allocator<TupleType>>
class tbb::flow::interface11::split_node< TupleType, Allocator >

split_node: accepts a tuple as input, forwards each element of the tuple to its

Definition at line 1347 of file flow_graph.h.

Member Typedef Documentation

◆ allocator_type

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
typedef Allocator tbb::flow::interface11::split_node< TupleType, Allocator >::allocator_type

Definition at line 1352 of file flow_graph.h.

◆ base_type

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
typedef receiver<TupleType> tbb::flow::interface11::split_node< TupleType, Allocator >::base_type
private

Definition at line 1349 of file flow_graph.h.

◆ input_type

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
typedef TupleType tbb::flow::interface11::split_node< TupleType, Allocator >::input_type

Definition at line 1351 of file flow_graph.h.

◆ output_ports_type

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
typedef internal::wrap_tuple_elements< N, internal::multifunction_output, TupleType >::type tbb::flow::interface11::split_node< TupleType, Allocator >::output_ports_type

Definition at line 1364 of file flow_graph.h.

Constructor & Destructor Documentation

◆ split_node() [1/2]

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
__TBB_NOINLINE_SYM tbb::flow::interface11::split_node< TupleType, Allocator >::split_node ( graph g)
inlineexplicit

Definition at line 1366 of file flow_graph.h.

References __TBB_NOINLINE_SYM, and CODEPTR.

1367  : graph_node(g),
1369  {
1370  tbb::internal::fgt_multioutput_node<N>(CODEPTR(), tbb::internal::FLOW_SPLIT_NODE, &this->my_graph,
1371  static_cast<receiver<input_type> *>(this), this->output_ports());
1372  }
output_ports_type & output_ports()
Definition: flow_graph.h:1395
#define CODEPTR()

◆ split_node() [2/2]

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
__TBB_NOINLINE_SYM tbb::flow::interface11::split_node< TupleType, Allocator >::split_node ( const split_node< TupleType, Allocator > &  other)
inline

Definition at line 1381 of file flow_graph.h.

References __TBB_override, CODEPTR, tbb::internal::fgt_multioutput_node_desc(), and name.

1382  : graph_node(other.my_graph), base_type(other),
1384  {
1385  tbb::internal::fgt_multioutput_node<N>(CODEPTR(), tbb::internal::FLOW_SPLIT_NODE, &this->my_graph,
1386  static_cast<receiver<input_type> *>(this), this->output_ports());
1387  }
receiver< TupleType > base_type
Definition: flow_graph.h:1349
output_ports_type & output_ports()
Definition: flow_graph.h:1395
#define CODEPTR()
Here is the call graph for this function:

Member Function Documentation

◆ graph_reference()

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
graph& tbb::flow::interface11::split_node< TupleType, Allocator >::graph_reference ( ) const
inlineprotectedvirtual

Implements tbb::flow::interface11::internal::untyped_receiver.

Definition at line 1410 of file flow_graph.h.

1410  {
1411  return my_graph;
1412  }

◆ output_ports()

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
output_ports_type& tbb::flow::interface11::split_node< TupleType, Allocator >::output_ports ( )
inline

Definition at line 1395 of file flow_graph.h.

1395 { return my_output_ports; }

◆ reset_node()

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
void tbb::flow::interface11::split_node< TupleType, Allocator >::reset_node ( reset_flags  f)
inlineprotectedvirtual

Implements tbb::flow::interface11::graph_node.

Definition at line 1403 of file flow_graph.h.

References __TBB_ASSERT, and tbb::flow::interface11::internal::clear_element< N >::clear_this().

1403  {
1404  if (f & rf_clear_edges)
1406 
1407  __TBB_ASSERT(!(f & rf_clear_edges) || internal::clear_element<N>::this_empty(my_output_ports), "split_node reset failed");
1408  }
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
Here is the call graph for this function:

◆ reset_receiver()

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
void tbb::flow::interface11::split_node< TupleType, Allocator >::reset_receiver ( reset_flags  f)
inlineprotectedvirtual

put receiver back in initial state

Implements tbb::flow::interface11::internal::untyped_receiver.

Definition at line 1409 of file flow_graph.h.

1409 {}

◆ try_put_task()

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
task* tbb::flow::interface11::split_node< TupleType, Allocator >::try_put_task ( const TupleType &  t)
inlineprotectedvirtual

Put item to successor; return task to run the successor if possible.

Implements tbb::flow::interface11::receiver< TupleType >.

Definition at line 1398 of file flow_graph.h.

1398  {
1399  // Sending split messages in parallel is not justified, as overheads would prevail.
1400  // Also, we do not have successors here. So we just tell the task returned here is successful.
1402  }
static task * emit_this(graph &g, const T &t, P &p)
Definition: flow_graph.h:733
output_ports_type & output_ports()
Definition: flow_graph.h:1395

Member Data Documentation

◆ my_output_ports

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
output_ports_type tbb::flow::interface11::split_node< TupleType, Allocator >::my_output_ports
private

Definition at line 1434 of file flow_graph.h.

◆ N

template<typename TupleType , typename Allocator = cache_aligned_allocator<TupleType>>
const int tbb::flow::interface11::split_node< TupleType, Allocator >::N = tbb::flow::tuple_size<TupleType>::value
staticprivate

Definition at line 1348 of file flow_graph.h.


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

Copyright © 2005-2019 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.