Intel(R) Threading Building Blocks Doxygen Documentation version 4.2.3
Loading...
Searching...
No Matches
tbb::flow::interface11::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::interface11::multifunction_node< Input, Output, Policy, Allocator >:
Collaboration diagram for tbb::flow::interface11::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, internals_allocatorinput_impl_type
 
typedef internal::function_input_queue< input_type, internals_allocatorinput_queue_type
 
- Public Types inherited from internal::multifunction_input< Input, OutputPortSet, Policy, A >
typedef Input input_type
 
typedef OutputPortSet output_ports_type
 
typedef multifunction_body< input_type, output_ports_typemultifunction_body_type
 
typedef multifunction_input< Input, OutputPortSet, Policy, A > my_class
 
typedef function_input_base< Input, Policy, A, my_classbase_type
 
typedef function_input_queue< input_type, A > input_queue_type
 
- Public Types inherited from internal::function_input_base< Input, Policy, A, multifunction_input< Input, OutputPortSet, Policy, A > >
typedef Input input_type
 The input type of this receiver.
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef predecessor_cache< input_type, null_mutex > predecessor_cache_type
 
typedef function_input_queue< input_type, A > input_queue_type
 
typedef tbb::internal::allocator_rebind< A, input_queue_type >::type queue_allocator_type
 
- Public Types inherited from tbb::flow::interface11::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node.
 

Public Member Functions

template<typename Body >
__TBB_NOINLINE_SYM multifunction_node (graph &g, size_t concurrency,)
 
__TBB_NOINLINE_SYM multifunction_node (const multifunction_node &other)
 
- Public Member Functions inherited from tbb::flow::interface11::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from internal::multifunction_input< Input, OutputPortSet, Policy, A >
template<typename Body >
 multifunction_input (graph &g, size_t max_concurrency,)
 
 multifunction_input (const multifunction_input &src)
 Copy constructor.
 
 ~multifunction_input ()
 
template<typename Body >
Body copy_function_object ()
 
taskapply_body_impl_bypass (const input_type &i)
 
output_ports_typeoutput_ports ()
 
- Public Member Functions inherited from internal::function_input_base< Input, Policy, A, multifunction_input< Input, OutputPortSet, Policy, A > >
 __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.
 
 function_input_base (const function_input_base &src)
 Copy constructor.
 
virtual ~function_input_base ()
 Destructor.
 
tasktry_put_task (const input_type &t) __TBB_override
 Put item to successor; return task to run the successor if possible.
 
bool register_predecessor (predecessor_type &src) __TBB_override
 Adds src to the list of cached predecessors.
 
bool remove_predecessor (predecessor_type &src) __TBB_override
 Removes src from the list of cached predecessors.
 
- Public Member Functions inherited from tbb::flow::interface11::receiver< Input >
bool try_put (const typename internal::async_helpers< Input >::filtered_type &t)
 Put an item to the receiver.
 
bool try_put (const typename internal::async_helpers< Input >::async_type &t)
 
- Public Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
virtual ~untyped_receiver ()
 Destructor.
 
template<typename X >
bool try_put (const X &t)
 Put an item to the receiver.
 
virtual bool register_predecessor (predecessor_type &)
 Add a predecessor to the node.
 
virtual bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node.
 

Protected Member Functions

void reset_node (reset_flags f) __TBB_override
 
virtual void reset_node (reset_flags f=rf_reset_protocol)=0
 
- Protected Member Functions inherited from internal::multifunction_input< Input, OutputPortSet, Policy, A >
void reset (reset_flags f)
 
- Protected Member Functions inherited from internal::function_input_base< Input, Policy, A, multifunction_input< Input, OutputPortSet, Policy, A > >
void reset_function_input_base (reset_flags f)
 
void reset_receiver (reset_flags f) __TBB_override
 
graph & graph_reference () const __TBB_override
 
tasktry_get_postponed_task (const input_type &i)
 
- Protected Member Functions inherited from tbb::flow::interface11::receiver< Input >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
virtual tasktry_put_task (const Input &t)=0
 Put item to successor; return task to run the successor if possible.
 
- Protected Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual tasktry_put_task_wrapper (const void *p, bool is_async)=0
 
virtual graphgraph_reference () const =0
 
virtual void reset_receiver (reset_flags f=rf_reset_protocol)=0
 put receiver back in initial state
 
virtual bool is_continue_receiver ()
 

Static Protected Attributes

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

Private Types

typedef cache_aligned_allocator< Input > internals_allocator
 

Private 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.")
 

Additional Inherited Members

- Public Attributes inherited from tbb::flow::interface11::receiver< Input >
__TBB_DEPRECATED typedef Input input_type
 The input type of this receiver.
 
__TBB_DEPRECATED typedef internal::async_helpers< Input >::filtered_type filtered_type
 
- Static Public Attributes inherited from internal::multifunction_input< Input, OutputPortSet, Policy, A >
static const int N = tbb::flow::tuple_size<OutputPortSet>::value
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 
- Protected Attributes inherited from internal::multifunction_input< Input, OutputPortSet, Policy, A >
multifunction_body_typemy_body
 
multifunction_body_typemy_init_body
 
output_ports_type my_output_ports
 
- Protected Attributes inherited from internal::function_input_base< Input, Policy, A, multifunction_input< Input, OutputPortSet, Policy, A > >
graph & my_graph_ref
 
const size_t my_max_concurrency
 
size_t my_concurrency
 
input_queue_typemy_queue
 
predecessor_cache< input_type, null_mutex > my_predecessors
 

Detailed Description

template<typename Input, typename Output, typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
class tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >

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

Definition at line 1576 of file flow_graph.h.

Member Typedef Documentation

◆ input_impl_type

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
typedef internal::multifunction_input< input_type, output_ports_type, Policy, internals_allocator> tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >::input_impl_type

Definition at line 1612 of file flow_graph.h.

◆ input_queue_type

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
typedef internal::function_input_queue<input_type, internals_allocator> tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >::input_queue_type

Definition at line 1613 of file flow_graph.h.

◆ input_type

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
typedef Input tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >::input_type

Definition at line 1608 of file flow_graph.h.

◆ internals_allocator

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
typedef cache_aligned_allocator<Input> tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >::internals_allocator
private

Definition at line 1596 of file flow_graph.h.

◆ output_ports_type

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
typedef internal::wrap_tuple_elements<N,internal::multifunction_output,Output>::type tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >::output_ports_type

Definition at line 1610 of file flow_graph.h.

◆ output_type

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
typedef null_type tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >::output_type

Definition at line 1609 of file flow_graph.h.

Constructor & Destructor Documentation

◆ multifunction_node() [1/2]

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

Definition at line 1618 of file flow_graph.h.

1626 tbb::internal::fgt_multioutput_node_with_body<N>(
1627 CODEPTR(), tbb::internal::FLOW_MULTIFUNCTION_NODE,
1628 &this->my_graph, static_cast<receiver<input_type> *>(this),
1629 this->output_ports(), this->my_body
1630 );
1631 }
#define CODEPTR()
#define __TBB_FLOW_GRAPH_PRIORITY_ARG1(arg1, priority)
concurrency
An enumeration the provides the two most common concurrency levels: unlimited and serial.
Definition flow_graph.h:106
internal::multifunction_input< input_type, output_ports_type, Policy, internals_allocator > input_impl_type
multifunction_body_type * my_body

References CODEPTR, internal::multifunction_input< Input, OutputPortSet, Policy, A >::my_body, tbb::flow::interface11::graph_node::my_graph, and internal::multifunction_input< Input, OutputPortSet, Policy, A >::output_ports().

Here is the call graph for this function:

◆ multifunction_node() [2/2]

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

Definition at line 1654 of file flow_graph.h.

1654 :
1655 graph_node(other.my_graph), input_impl_type(other) {
1656 tbb::internal::fgt_multioutput_node_with_body<N>( CODEPTR(), tbb::internal::FLOW_MULTIFUNCTION_NODE,
1657 &this->my_graph, static_cast<receiver<input_type> *>(this),
1658 this->output_ports(), this->my_body );
1659 }

References CODEPTR, internal::multifunction_input< Input, OutputPortSet, Policy, A >::my_body, tbb::flow::interface11::graph_node::my_graph, and internal::multifunction_input< Input, OutputPortSet, Policy, A >::output_ports().

Here is the call graph for this function:

Member Function Documentation

◆ __TBB_STATIC_ASSERT()

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
tbb::flow::interface11::multifunction_node< Input, Output, Policy, 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."   
)
private

◆ reset_node()

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

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

Definition at line 1675 of file flow_graph.h.

References internal::multifunction_input< Input, OutputPortSet, Policy, A >::reset().

Here is the call graph for this function:

Member Data Documentation

◆ N

template<typename Input , typename Output , typename Policy = queueing, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(Input)>
const int tbb::flow::interface11::multifunction_node< Input, Output, Policy, Allocator >::N = tbb::flow::tuple_size<Output>::value
staticprotected

Definition at line 1606 of file flow_graph.h.


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

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.