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, ImplType >
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 A::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_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, ImplType >
 __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...
 

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, ImplType >
void reset_function_input_base (reset_flags f)
 
void reset_receiver (reset_flags f) __TBB_override
 
graph & graph_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 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, ImplType >
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 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 565 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 572 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 573 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 568 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 570 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 571 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 569 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

Definition at line 577 of file _flow_graph_node_impl.h.

582  }
leaf for multifunction. OutputSet can be a std::tuple or a vector.
multifunction_body_type * my_body
int max_concurrency()
Returns the maximal number of threads that can work inside the arena.
Definition: task_arena.h:413
multifunction_body_type * my_init_body
#define __TBB_FLOW_GRAPH_PRIORITY_ARG1(arg1, priority)
function_input_base< Input, Policy, A, my_class > base_type

◆ 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 585 of file _flow_graph_node_impl.h.

585  :
586  base_type(src),
587  my_body( src.my_init_body->clone() ),
588  my_init_body(src.my_init_body->clone() ) {
589  }
multifunction_body_type * my_body
multifunction_body_type * my_init_body
function_input_base< Input, Policy, A, my_class > base_type

◆ ~multifunction_input()

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

Definition at line 591 of file _flow_graph_node_impl.h.

591  {
592  delete my_body;
593  delete my_init_body;
594  }
multifunction_body_type * my_body
multifunction_body_type * my_init_body

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 605 of file _flow_graph_node_impl.h.

References tbb::internal::fgt_begin_body(), tbb::internal::fgt_end_body(), tbb::flow::internal::SUCCESSFULLY_ENQUEUED, and task.

605  {
607  (*my_body)(i, my_output_ports);
609  task* ttask = NULL;
612  }
613  return ttask ? ttask : SUCCESSFULLY_ENQUEUED;
614  }
static void fgt_end_body(void *)
multifunction_body_type * my_body
task * try_get_postponed_task(const input_type &i)
static tbb::task *const SUCCESSFULLY_ENQUEUED
static void fgt_begin_body(void *)
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
Here is the call graph for this function:

◆ 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 597 of file _flow_graph_node_impl.h.

597  {
598  multifunction_body_type &body_ref = *this->my_body;
599  return *static_cast<Body*>(dynamic_cast< internal::multifunction_body_leaf<input_type, output_ports_type, Body> & >(body_ref).get_body_ptr());
600  }
leaf for multifunction. OutputSet can be a std::tuple or a vector.
multifunction_body_type * my_body
multifunction_body< input_type, output_ports_type > multifunction_body_type

◆ 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 616 of file _flow_graph_node_impl.h.

616 { 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 625 of file _flow_graph_node_impl.h.

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

625  {
628  if(f & rf_reset_bodies) {
630  delete my_body;
631  my_body = tmp;
632  }
633  __TBB_ASSERT(!(f & rf_clear_edges) || clear_element<N>::this_empty(my_output_ports), "multifunction_node reset failed");
634  }
virtual multifunction_body * clone()=0
multifunction_body_type * my_body
multifunction_body< input_type, output_ports_type > multifunction_body_type
void reset_function_input_base(reset_flags f)
multifunction_body_type * my_init_body
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
Here is the call graph for this function:

Member Data Documentation

◆ my_body

template<typename Input , typename OutputPortSet , typename Policy , typename A >
multifunction_body_type* internal::multifunction_input< Input, OutputPortSet, Policy, A >::my_body
protected

Definition at line 636 of file _flow_graph_node_impl.h.

◆ my_init_body

template<typename Input , typename OutputPortSet , typename Policy , typename A >
multifunction_body_type* internal::multifunction_input< Input, OutputPortSet, Policy, A >::my_init_body
protected

Definition at line 637 of file _flow_graph_node_impl.h.

◆ my_output_ports

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

Definition at line 638 of file _flow_graph_node_impl.h.

◆ 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 567 of file _flow_graph_node_impl.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.