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 internal::wrap_tuple_elements< N, internal::multifunction_output, TupleType >::type output_ports_type
 

Public Member Functions

 __TBB_STATIC_ASSERT ((tbb::internal::is_same_type< Allocator, null_type >::value), "Allocator template parameter for flow graph nodes is deprecated and will be removed. " "Specify TBB_DEPRECATED_FLOW_NODE_ALLOCATOR to temporary enable the deprecated interface.")
 
__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 >
virtual ~receiver ()
 Destructor. More...
 
bool try_put (const TupleType &t)
 Put an item to the receiver. More...
 
virtual __TBB_DEPRECATED bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual __TBB_DEPRECATED bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 

Protected Member Functions

tasktry_put_task (const TupleType &t) __TBB_override
 
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 graphgraph_reference () const=0
 
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 sender< TupleType > predecessor_type
 The predecessor type for this node. More...
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Detailed Description

template<typename TupleType, typename Allocator = __TBB_DEFAULT_NODE_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 1673 of file flow_graph.h.

Member Typedef Documentation

◆ base_type

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

Definition at line 1675 of file flow_graph.h.

◆ input_type

template<typename TupleType , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(TupleType)>
typedef TupleType tbb::flow::interface11::split_node< TupleType, Allocator >::input_type

Definition at line 1677 of file flow_graph.h.

◆ output_ports_type

template<typename TupleType , typename Allocator = __TBB_DEFAULT_NODE_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 1698 of file flow_graph.h.

Constructor & Destructor Documentation

◆ split_node() [1/2]

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

Definition at line 1700 of file flow_graph.h.

1701  : graph_node(g),
1703  {
1704  tbb::internal::fgt_multioutput_node<N>(CODEPTR(), tbb::internal::FLOW_SPLIT_NODE, &this->my_graph,
1705  static_cast<receiver<input_type> *>(this), this->output_ports());
1706  }

References CODEPTR, tbb::flow::interface11::graph_node::my_graph, and tbb::flow::interface11::split_node< TupleType, Allocator >::output_ports().

Here is the call graph for this function:

◆ split_node() [2/2]

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

Definition at line 1715 of file flow_graph.h.

1716  : graph_node(other.my_graph), base_type(other),
1718  {
1719  tbb::internal::fgt_multioutput_node<N>(CODEPTR(), tbb::internal::FLOW_SPLIT_NODE, &this->my_graph,
1720  static_cast<receiver<input_type> *>(this), this->output_ports());
1721  }

References CODEPTR, tbb::flow::interface11::graph_node::my_graph, and tbb::flow::interface11::split_node< TupleType, Allocator >::output_ports().

Here is the call graph for this function:

Member Function Documentation

◆ __TBB_STATIC_ASSERT()

template<typename TupleType , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(TupleType)>
tbb::flow::interface11::split_node< TupleType, Allocator >::__TBB_STATIC_ASSERT ( (tbb::internal::is_same_type< Allocator, null_type >::value ,
"Allocator template parameter for flow graph nodes is deprecated and will be removed. " "Specify TBB_DEPRECATED_FLOW_NODE_ALLOCATOR to temporary enable the deprecated interface."   
)

◆ graph_reference()

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

Definition at line 1744 of file flow_graph.h.

1744  {
1745  return my_graph;
1746  }

References tbb::flow::interface11::graph_node::my_graph.

◆ output_ports()

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

Definition at line 1729 of file flow_graph.h.

1729 { return my_output_ports; }

References tbb::flow::interface11::split_node< TupleType, Allocator >::my_output_ports.

Referenced by tbb::flow::interface11::split_node< TupleType, Allocator >::split_node(), and tbb::flow::interface11::split_node< TupleType, Allocator >::try_put_task().

Here is the caller graph for this function:

◆ reset_node()

template<typename TupleType , typename Allocator = __TBB_DEFAULT_NODE_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 1737 of file flow_graph.h.

1737  {
1738  if (f & rf_clear_edges)
1740 
1742  }

References __TBB_ASSERT, internal::clear_element< N >::clear_this(), tbb::flow::interface11::split_node< TupleType, Allocator >::my_output_ports, and tbb::flow::interface11::rf_clear_edges.

Here is the call graph for this function:

◆ reset_receiver()

template<typename TupleType , typename Allocator = __TBB_DEFAULT_NODE_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::receiver< TupleType >.

Definition at line 1743 of file flow_graph.h.

1743 {}

◆ try_put_task()

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

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

Definition at line 1732 of file flow_graph.h.

1732  {
1733  // Sending split messages in parallel is not justified, as overheads would prevail.
1734  // Also, we do not have successors here. So we just tell the task returned here is successful.
1736  }

References internal::emit_element< N >::emit_this(), tbb::flow::interface11::graph_node::my_graph, and tbb::flow::interface11::split_node< TupleType, Allocator >::output_ports().

Here is the call graph for this function:

Member Data Documentation

◆ my_output_ports

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

◆ N

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

Definition at line 1674 of file flow_graph.h.


The documentation for this class was generated from the following file:
tbb::flow::interface11::split_node::my_output_ports
output_ports_type my_output_ports
Definition: flow_graph.h:1768
CODEPTR
#define CODEPTR()
Definition: _flow_graph_trace_impl.h:297
__TBB_ASSERT
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
tbb::flow::interface11::graph_node::my_graph
graph & my_graph
Definition: _flow_graph_impl.h:464
internal::init_output_ports
Definition: _flow_graph_node_impl.h:563
internal::clear_element
Definition: _flow_graph_node_impl.h:525
internal::clear_element::clear_this
static void clear_this(P &p)
Definition: _flow_graph_node_impl.h:526
tbb::flow::interface11::split_node::output_ports
output_ports_type & output_ports()
Definition: flow_graph.h:1729
internal::emit_element::emit_this
static task * emit_this(graph &g, const T &t, P &p)
Definition: _flow_graph_node_impl.h:733
tbb::flow::interface11::graph_node::graph_node
graph_node(graph &g)
Definition: flow_graph.h:887
tbb::flow::interface11::rf_clear_edges
@ rf_clear_edges
Definition: _flow_graph_impl.h:161
tbb::flow::interface11::split_node::base_type
receiver< TupleType > base_type
Definition: flow_graph.h:1675

Copyright © 2005-2020 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.