Home ⌂Doc Index ◂Up ▴
Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::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.h>

Inheritance diagram for tbb::flow::interface11::internal::multifunction_input< Input, OutputPortSet, Policy, A >:
Collaboration diagram for tbb::flow::interface11::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 tbb::flow::interface11::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_mutexpredecessor_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. 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 tbb::flow::interface11::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
 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::interface11::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::interface11::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 tbb::flow::interface11::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
 put receiver back in initial state More...
 
graphgraph_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
 
- Protected Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
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 tbb::flow::interface11::internal::function_input_base< Input, Policy, A, multifunction_input< Input, OutputPortSet, Policy, A > >
graphmy_graph_ref
 
const size_t my_max_concurrency
 
size_t my_concurrency
 
input_queue_typemy_queue
 
predecessor_cache< input_type, null_mutexmy_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 internal::async_helpers< Input >::filtered_type filtered_type
 

Detailed Description

template<typename Input, typename OutputPortSet, typename Policy, typename A>
class tbb::flow::interface11::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.h.

Member Typedef Documentation

◆ base_type

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

Definition at line 645 of file flow_graph.h.

◆ input_queue_type

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

Definition at line 646 of file flow_graph.h.

◆ input_type

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

Definition at line 641 of file flow_graph.h.

◆ multifunction_body_type

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

Definition at line 643 of file flow_graph.h.

◆ my_class

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

Definition at line 644 of file flow_graph.h.

◆ output_ports_type

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

Definition at line 642 of file flow_graph.h.

Constructor & Destructor Documentation

◆ multifunction_input() [1/2]

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

Definition at line 650 of file flow_graph.h.

650  {
651  spin_mutex::scoped_lock l(my_mutex);
652  my_built_predecessors.delete_edge(s);
653  }
654 
655  __TBB_DEPRECATED void copy_predecessors( predecessor_list_type &v) __TBB_override {
656  spin_mutex::scoped_lock l(my_mutex);
#define __TBB_DEPRECATED
Definition: tbb_config.h:636
#define __TBB_override
Definition: tbb_stddef.h:240
void const char const char int ITT_FORMAT __itt_group_sync s
friend class scoped_lock
Definition: spin_mutex.h:179

◆ multifunction_input() [2/2]

template<typename Input, typename OutputPortSet, typename Policy, typename A>
tbb::flow::interface11::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.h.

660  {
661  spin_mutex::scoped_lock l(my_mutex);
662  return my_built_predecessors.edge_count();
663  }
664 
friend class scoped_lock
Definition: spin_mutex.h:179

◆ ~multifunction_input()

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

Definition at line 666 of file flow_graph.h.

667  :
668  template< typename R, typename B > friend class run_and_put_task;
669  template<typename X, typename Y> friend class internal::broadcast_cache;
A cache of successors that are broadcast to.

Member Function Documentation

◆ apply_body_impl_bypass()

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

Definition at line 680 of file flow_graph.h.

682  }
683 
684 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
685  // continue_receiver must contain its own built_predecessors because it does
686  // not have a node_cache.
687  built_predecessors_type my_built_predecessors;
688 #endif
689  spin_mutex my_mutex;
static tbb::task *const SUCCESSFULLY_ENQUEUED

◆ copy_function_object()

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

Definition at line 672 of file flow_graph.h.

672  {
673  {
675  if ( ++my_current_count < my_predecessor_count )
friend class scoped_lock
Definition: spin_mutex.h:179

◆ output_ports()

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

Definition at line 691 of file flow_graph.h.

◆ reset()

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

Definition at line 700 of file flow_graph.h.

700  {
701 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
702  my_built_predecessors.clear();
703 #endif
704  my_predecessor_count = my_initial_predecessor_count;
705  }
706  }
707 
709 

Referenced by tbb::flow::interface11::multifunction_node< indexer_node_output_type, kernel_input_tuple >::reset_node().

Here is the caller graph for this function:

Member Data Documentation

◆ my_body

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

Definition at line 711 of file flow_graph.h.

◆ my_init_body

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

Definition at line 712 of file flow_graph.h.

◆ my_output_ports

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

Definition at line 713 of file flow_graph.h.

◆ N

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

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