Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator > Class Template Reference

implements a function node that supports Input -> (set of outputs) More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >:
Collaboration diagram for tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >:

Public Types

typedef Input input_type
 
typedef null_type output_type
 
typedef internal::wrap_tuple_elements< N, internal::multifunction_output, Output >::type output_ports_type
 
typedef internal::multifunction_input< input_type, output_ports_type, Policy, Allocator > input_impl_type
 
typedef internal::function_input_queue< input_type, Allocator > input_queue_type
 
- Public Types inherited from tbb::flow::interface10::internal::multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator >
typedef Input input_type
 
typedef internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type output_ports_type
 
typedef multifunction_body< input_type, output_ports_typemultifunction_body_type
 
typedef multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator > my_class
 
typedef function_input_base< Input, Policy, Allocator, my_classbase_type
 
typedef function_input_queue< input_type, Allocator > input_queue_type
 
- Public Types inherited from tbb::flow::interface10::internal::function_input_base< Input, Policy, Allocator, multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator > >
typedef Input input_type
 The input type of this receiver. More...
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef predecessor_cache< input_type, null_mutexpredecessor_cache_type
 
typedef function_input_queue< input_type, Allocator > input_queue_type
 
typedef Allocator ::template rebind< input_queue_type >::other queue_allocator_type
 
- Public Types inherited from tbb::flow::interface10::receiver< Input >
typedef Input input_type
 The input type of this receiver. More...
 
typedef internal::async_helpers< Input >::filtered_type filtered_type
 
- Public Types inherited from tbb::flow::interface10::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 

Public Member Functions

template<typename Body >
 multifunction_node (graph &g, size_t concurrency,)
 
 multifunction_node (const multifunction_node &other)
 
- Public Member Functions inherited from tbb::flow::interface10::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from tbb::flow::interface10::internal::multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator >
 multifunction_input (graph &g, size_t max_concurrency,)
 
 multifunction_input (const multifunction_input &src)
 Copy constructor. More...
 
 ~multifunction_input ()
 
Body copy_function_object ()
 
taskapply_body_impl_bypass (const input_type &i)
 
output_ports_typeoutput_ports ()
 
- Public Member Functions inherited from tbb::flow::interface10::internal::function_input_base< Input, Policy, Allocator, multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator > >
 __TBB_STATIC_ASSERT (!((internal::has_policy< queueing, Policy >::value) &&(internal::has_policy< rejecting, Policy >::value)), "queueing and rejecting policies can't be specified simultaneously")
 
 function_input_base (graph &g, __TBB_FLOW_GRAPH_PRIORITY_ARG1(size_t max_concurrency, node_priority_t priority))
 Constructor for function_input_base. More...
 
 function_input_base (const function_input_base &src)
 Copy constructor. More...
 
virtual ~function_input_base ()
 Destructor. More...
 
tasktry_put_task (const input_type &t) __TBB_override
 Put item to successor; return task to run the successor if possible. More...
 
bool register_predecessor (predecessor_type &src) __TBB_override
 Adds src to the list of cached predecessors. More...
 
bool remove_predecessor (predecessor_type &src) __TBB_override
 Removes src from the list of cached predecessors. More...
 
- Public Member Functions inherited from tbb::flow::interface10::receiver< Input >
bool try_put (const typename internal::async_helpers< Input >::filtered_type &t)
 Put an item to the receiver. More...
 
bool try_put (const typename internal::async_helpers< Input >::async_type &t)
 
- Public Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
virtual ~untyped_receiver ()
 Destructor. More...
 
template<typename X >
bool try_put (const X &t)
 Put an item to the receiver. More...
 

Protected Member Functions

void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator >
void reset (reset_flags f)
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::function_input_base< Input, Policy, Allocator, multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator > >
void reset_function_input_base (reset_flags f)
 
void reset_receiver (reset_flags f) __TBB_override
 put receiver back in initial state More...
 
graphgraph_reference () __TBB_override
 
tasktry_get_postponed_task (const input_type &i)
 
- Protected Member Functions inherited from tbb::flow::interface10::receiver< Input >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual bool is_continue_receiver ()
 

Static Protected Attributes

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

Private Types

typedef internal::multifunction_input< input_type, output_ports_type, Policy, Allocator > base_type
 

Additional Inherited Members

- Static Public Attributes inherited from tbb::flow::interface10::internal::multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator >
static const int N
 
- Protected Attributes inherited from tbb::flow::interface10::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 
- Protected Attributes inherited from tbb::flow::interface10::internal::multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator >
multifunction_body_typemy_body
 
multifunction_body_typemy_init_body
 
output_ports_type my_output_ports
 
- Protected Attributes inherited from tbb::flow::interface10::internal::function_input_base< Input, Policy, Allocator, multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator > >
graphmy_graph_ref
 
const size_t my_max_concurrency
 
size_t my_concurrency
 
input_queue_typemy_queue
 
predecessor_cache< input_type, null_mutexmy_predecessors
 

Detailed Description

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
class tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >

implements a function node that supports Input -> (set of outputs)

Definition at line 1196 of file flow_graph.h.

Member Typedef Documentation

◆ base_type

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
typedef internal::multifunction_input<input_type, output_ports_type, Policy, Allocator> tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::base_type
private

Definition at line 1218 of file flow_graph.h.

◆ input_impl_type

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
typedef internal::multifunction_input<input_type, output_ports_type, Policy, Allocator> tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::input_impl_type

Definition at line 1215 of file flow_graph.h.

◆ input_queue_type

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
typedef internal::function_input_queue<input_type, Allocator> tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::input_queue_type

Definition at line 1216 of file flow_graph.h.

◆ input_type

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
typedef Input tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::input_type

Definition at line 1212 of file flow_graph.h.

◆ output_ports_type

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
typedef internal::wrap_tuple_elements<N,internal::multifunction_output, Output>::type tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::output_ports_type

Definition at line 1214 of file flow_graph.h.

◆ output_type

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
typedef null_type tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::output_type

Definition at line 1213 of file flow_graph.h.

Constructor & Destructor Documentation

◆ multifunction_node() [1/2]

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
template<typename Body >
tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::multifunction_node ( graph g,
size_t  concurrency 
)
inline

Definition at line 1222 of file flow_graph.h.

1225  : graph_node(g), base_type(g, concurrency, __TBB_FLOW_GRAPH_PRIORITY_ARG1(body, priority)) {
1226  tbb::internal::fgt_multioutput_node_with_body<N>(
1227  tbb::internal::FLOW_MULTIFUNCTION_NODE,
1228  &this->my_graph, static_cast<receiver<input_type> *>(this),
1229  this->output_ports(), this->my_body
1230  );
1231  }
concurrency
An enumeration the provides the two most common concurrency levels: unlimited and serial.
Definition: flow_graph.h:88
internal::multifunction_input< input_type, output_ports_type, Policy, Allocator > base_type
Definition: flow_graph.h:1218
#define __TBB_FLOW_GRAPH_PRIORITY_ARG1(arg1, priority)

◆ multifunction_node() [2/2]

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::multifunction_node ( const multifunction_node< Input, Output, Policy, Allocator > &  other)
inline

Definition at line 1233 of file flow_graph.h.

1233  :
1234  graph_node(other.my_graph), base_type(other) {
1235  tbb::internal::fgt_multioutput_node_with_body<N>( tbb::internal::FLOW_MULTIFUNCTION_NODE,
1236  &this->my_graph, static_cast<receiver<input_type> *>(this),
1237  this->output_ports(), this->my_body );
1238  }
internal::multifunction_input< input_type, output_ports_type, Policy, Allocator > base_type
Definition: flow_graph.h:1218

Member Function Documentation

◆ reset_node()

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
void tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::reset_node ( reset_flags  f)
inlineprotectedvirtual

Implements tbb::flow::interface10::graph_node.

Definition at line 1254 of file flow_graph.h.

Member Data Documentation

◆ N

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = cache_aligned_allocator<Input>>
const int tbb::flow::interface10::multifunction_node< Input, Output, Policy, Allocator >::N = tbb::flow::tuple_size<Output>::value
staticprotected

Definition at line 1210 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.