Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
internal::multifunction_input< Input, OutputPortSet, Policy, A > Class Template Reference

Implements methods for a function node that takes a type Input as input. More...

#include <_flow_graph_node_impl.h>

Inheritance diagram for internal::multifunction_input< Input, OutputPortSet, Policy, A >:
Collaboration diagram for internal::multifunction_input< Input, OutputPortSet, Policy, A >:

Public Types

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. More...
 
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 Member Functions

template<typename Body >
 multifunction_input (graph &g, size_t max_concurrency,)
 
 multifunction_input (const multifunction_input &src)
 Copy constructor. More...
 
 ~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. 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
 
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::interface11::receiver< Input >
virtual ~receiver ()
 Destructor. More...
 
bool try_put (const Input &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...
 

Static Public Attributes

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

Protected Member Functions

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 void reset_receiver (reset_flags f=rf_reset_protocol)=0
 put receiver back in initial state More...
 
virtual bool is_continue_receiver ()
 

Protected Attributes

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
 

Additional Inherited Members

- Public Attributes inherited from tbb::flow::interface11::receiver< Input >
__TBB_DEPRECATED typedef Input input_type
 The input type of this receiver. More...
 
__TBB_DEPRECATED typedef sender< Input > predecessor_type
 The predecessor type for this node. More...
 

Detailed Description

template<typename Input, typename OutputPortSet, typename Policy, typename A>
class internal::multifunction_input< Input, OutputPortSet, Policy, A >

Implements methods for a function node that takes a type Input as input.

Definition at line 638 of file _flow_graph_node_impl.h.

Member Typedef Documentation

◆ base_type

template<typename Input , typename OutputPortSet , typename Policy , typename A >
typedef function_input_base<Input, Policy, A, my_class> internal::multifunction_input< Input, OutputPortSet, Policy, A >::base_type

Definition at line 645 of file _flow_graph_node_impl.h.

◆ input_queue_type

template<typename Input , typename OutputPortSet , typename Policy , typename A >
typedef function_input_queue<input_type, A> internal::multifunction_input< Input, OutputPortSet, Policy, A >::input_queue_type

Definition at line 646 of file _flow_graph_node_impl.h.

◆ input_type

template<typename Input , typename OutputPortSet , typename Policy , typename A >
typedef Input internal::multifunction_input< Input, OutputPortSet, Policy, A >::input_type

Definition at line 641 of file _flow_graph_node_impl.h.

◆ multifunction_body_type

template<typename Input , typename OutputPortSet , typename Policy , typename A >
typedef multifunction_body<input_type, output_ports_type> internal::multifunction_input< Input, OutputPortSet, Policy, A >::multifunction_body_type

Definition at line 643 of file _flow_graph_node_impl.h.

◆ my_class

template<typename Input , typename OutputPortSet , typename Policy , typename A >
typedef multifunction_input<Input, OutputPortSet, Policy, A> internal::multifunction_input< Input, OutputPortSet, Policy, A >::my_class

Definition at line 644 of file _flow_graph_node_impl.h.

◆ output_ports_type

template<typename Input , typename OutputPortSet , typename Policy , typename A >
typedef OutputPortSet internal::multifunction_input< Input, OutputPortSet, Policy, A >::output_ports_type

Definition at line 642 of file _flow_graph_node_impl.h.

Constructor & Destructor Documentation

◆ multifunction_input() [1/2]

template<typename Input , typename OutputPortSet , typename Policy , typename A >
template<typename Body >
internal::multifunction_input< Input, OutputPortSet, Policy, A >::multifunction_input ( graph &  g,
size_t  max_concurrency 
)
inline

◆ multifunction_input() [2/2]

template<typename Input , typename OutputPortSet , typename Policy , typename A >
internal::multifunction_input< Input, OutputPortSet, Policy, A >::multifunction_input ( const multifunction_input< Input, OutputPortSet, Policy, A > &  src)
inline

Copy constructor.

Definition at line 659 of file _flow_graph_node_impl.h.

659  :
660  base_type(src),
661  my_body( src.my_init_body->clone() ),
662  my_init_body(src.my_init_body->clone() ),
664  }

◆ ~multifunction_input()

template<typename Input , typename OutputPortSet , typename Policy , typename A >
internal::multifunction_input< Input, OutputPortSet, Policy, A >::~multifunction_input ( )
inline

Definition at line 666 of file _flow_graph_node_impl.h.

666  {
667  delete my_body;
668  delete my_init_body;
669  }

Member Function Documentation

◆ apply_body_impl_bypass()

template<typename Input , typename OutputPortSet , typename Policy , typename A >
task* internal::multifunction_input< Input, OutputPortSet, Policy, A >::apply_body_impl_bypass ( const input_type i)
inline

Definition at line 680 of file _flow_graph_node_impl.h.

680  {
682  (*my_body)(i, my_output_ports);
684  task* ttask = NULL;
687  }
688  return ttask ? ttask : SUCCESSFULLY_ENQUEUED;
689  }

◆ copy_function_object()

template<typename Input , typename OutputPortSet , typename Policy , typename A >
template<typename Body >
Body internal::multifunction_input< Input, OutputPortSet, Policy, A >::copy_function_object ( )
inline

Definition at line 672 of file _flow_graph_node_impl.h.

672  {
673  multifunction_body_type &body_ref = *this->my_body;
674  return *static_cast<Body*>(dynamic_cast< internal::multifunction_body_leaf<input_type, output_ports_type, Body> & >(body_ref).get_body_ptr());
675  }

◆ output_ports()

template<typename Input , typename OutputPortSet , typename Policy , typename A >
output_ports_type& internal::multifunction_input< Input, OutputPortSet, Policy, A >::output_ports ( )
inline

Definition at line 691 of file _flow_graph_node_impl.h.

691 { return my_output_ports; }

◆ reset()

template<typename Input , typename OutputPortSet , typename Policy , typename A >
void internal::multifunction_input< Input, OutputPortSet, Policy, A >::reset ( reset_flags  f)
inlineprotected

Definition at line 700 of file _flow_graph_node_impl.h.

700  {
703  if(f & rf_reset_bodies) {
705  delete my_body;
706  my_body = tmp;
707  }
708  __TBB_ASSERT(!(f & rf_clear_edges) || clear_element<N>::this_empty(my_output_ports), "multifunction_node reset failed");
709  }

Referenced by tbb::flow::interface11::multifunction_node< Input, tuple< Output >, queueing_lightweight, __TBB_DEFAULT_NODE_ALLOCATOR(Input) >::reset_node().

Here is the caller graph for this function:

Member Data Documentation

◆ my_body

◆ my_init_body

◆ my_output_ports

◆ N

template<typename Input , typename OutputPortSet , typename Policy , typename A >
const int internal::multifunction_input< Input, OutputPortSet, Policy, A >::N = tbb::flow::tuple_size<OutputPortSet>::value
static

Definition at line 640 of file _flow_graph_node_impl.h.


The documentation for this class was generated from the following file:
internal::multifunction_input::my_body
multifunction_body_type * my_body
Definition: _flow_graph_node_impl.h:711
__TBB_ASSERT
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
internal::multifunction_input::my_init_body
multifunction_body_type * my_init_body
Definition: _flow_graph_node_impl.h:712
__TBB_FLOW_GRAPH_PRIORITY_ARG1
#define __TBB_FLOW_GRAPH_PRIORITY_ARG1(arg1, priority)
Definition: _flow_graph_impl.h:40
internal::multifunction_body_leaf
leaf for multifunction. OutputSet can be a std::tuple or a vector.
Definition: _flow_graph_body_impl.h:202
internal::multifunction_input::my_output_ports
output_ports_type my_output_ports
Definition: _flow_graph_node_impl.h:713
tbb::flow::internal::SUCCESSFULLY_ENQUEUED
static tbb::task *const SUCCESSFULLY_ENQUEUED
Definition: _flow_graph_impl.h:61
tbb::internal::fgt_begin_body
static void fgt_begin_body(void *)
Definition: _flow_graph_trace_impl.h:336
internal::clear_element::clear_this
static void clear_this(P &p)
Definition: _flow_graph_node_impl.h:526
internal::function_input_base::my_max_concurrency
const size_t my_max_concurrency
Definition: _flow_graph_node_impl.h:181
internal::function_input_base::try_get_postponed_task
task * try_get_postponed_task(const input_type &i)
Definition: _flow_graph_node_impl.h:198
internal::function_input_base::reset_function_input_base
void reset_function_input_base(reset_flags f)
Definition: _flow_graph_node_impl.h:171
tbb::this_task_arena::max_concurrency
int max_concurrency()
Returns the maximal number of threads that can work inside the arena.
Definition: task_arena.h:490
internal::multifunction_input::base_type
function_input_base< Input, Policy, A, my_class > base_type
Definition: _flow_graph_node_impl.h:645
task
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task * task
Definition: ittnotify_static.h:119
internal::init_output_ports::call
static OutputTuple call(graph &g, const tbb::flow::tuple< Args... > &)
Definition: _flow_graph_node_impl.h:566
tbb::flow::interface11::rf_clear_edges
@ rf_clear_edges
Definition: _flow_graph_impl.h:161
tbb::internal::fgt_end_body
static void fgt_end_body(void *)
Definition: _flow_graph_trace_impl.h:337
tbb::flow::interface11::rf_reset_bodies
@ rf_reset_bodies
Definition: _flow_graph_impl.h:160
internal::multifunction_input::multifunction_body_type
multifunction_body< input_type, output_ports_type > multifunction_body_type
Definition: _flow_graph_node_impl.h:643
internal::clear_element::this_empty
static bool this_empty(P &p)
Definition: _flow_graph_node_impl.h:530
internal::multifunction_body::clone
virtual multifunction_body * clone()=0

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.