Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
internal::key_matching_port< TraitsType > Class Template Reference

#include <_flow_graph_join_impl.h>

Inheritance diagram for internal::key_matching_port< TraitsType >:
Collaboration diagram for internal::key_matching_port< TraitsType >:

Classes

class  key_matching_port_operation
 

Public Types

typedef TraitsType traits
 
typedef key_matching_port< traitsclass_type
 
typedef TraitsType::T input_type
 
typedef TraitsType::K key_type
 
typedef tbb::internal::strip< key_type >::type noref_key_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef TraitsType::TtoK type_to_key_func_type
 
typedef TraitsType::KHash hash_compare_type
 
typedef hash_buffer< key_type, input_type, type_to_key_func_type, hash_compare_typebuffer_type
 
- Public Types inherited from hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >
typedef TraitsType::T value_type
 
typedef buffer_element_type< value_type >::type element_type
 
typedef value_typepointer_type
 
typedef element_typelist_array_type
 
typedef list_array_typepointer_array_type
 
typedef Allocator::template rebind< list_array_type >::other pointer_array_allocator_type
 
typedef Allocator::template rebind< element_type >::other elements_array_allocator
 
typedef tbb::internal::strip< TraitsType::K >::type Knoref
 

Public Member Functions

 key_matching_port ()
 
 key_matching_port (const key_matching_port &)
 
 ~key_matching_port ()
 
void set_join_node_pointer (forwarding_base *join)
 
void set_my_key_func (type_to_key_func_type *f)
 
type_to_key_func_typeget_my_key_func ()
 
bool get_item (input_type &v)
 
void reset_port ()
 
void reset_receiver (reset_flags f) __TBB_override
 
- Public Member Functions inherited from hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >
 hash_buffer ()
 
 ~hash_buffer ()
 
void reset ()
 
void set_key_func (TraitsType::TtoK *vtk)
 
TraitsType::TtoK * get_key_func ()
 
bool insert_with_key (const value_type &v)
 
bool find_ref_with_key (const Knoref &k, pointer_type &v)
 
bool find_with_key (const Knoref &k, value_type &v)
 
void delete_with_key (const Knoref &k)
 

Protected Member Functions

tasktry_put_task (const input_type &v) __TBB_override
 
graph & graph_reference () const __TBB_override
 

Private Types

enum  op_type { try__put , get__item , res_port }
 
typedef internal::aggregating_functor< class_type, key_matching_port_operationhandler_type
 

Private Member Functions

void handle_operations (key_matching_port_operation *op_list)
 

Private Attributes

aggregator< handler_type, key_matching_port_operationmy_aggregator
 
matching_forwarding_base< key_type > * my_join
 

Friends

class internal::aggregating_functor< class_type, key_matching_port_operation >
 
template<typename R , typename B >
class run_and_put_task
 
template<typename X , typename Y >
class internal::broadcast_cache
 
template<typename X , typename Y >
class internal::round_robin_cache
 

Additional Inherited Members

- Static Public Attributes inherited from hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >
static const size_t INITIAL_SIZE
 

Detailed Description

template<class TraitsType>
class internal::key_matching_port< TraitsType >

Definition at line 658 of file _flow_graph_join_impl.h.

Member Typedef Documentation

◆ buffer_type

Definition at line 671 of file _flow_graph_join_impl.h.

◆ class_type

template<class TraitsType >
typedef key_matching_port<traits> internal::key_matching_port< TraitsType >::class_type

Definition at line 664 of file _flow_graph_join_impl.h.

◆ handler_type

Definition at line 705 of file _flow_graph_join_impl.h.

◆ hash_compare_type

template<class TraitsType >
typedef TraitsType::KHash internal::key_matching_port< TraitsType >::hash_compare_type

Definition at line 670 of file _flow_graph_join_impl.h.

◆ input_type

template<class TraitsType >
typedef TraitsType::T internal::key_matching_port< TraitsType >::input_type

Definition at line 665 of file _flow_graph_join_impl.h.

◆ key_type

template<class TraitsType >
typedef TraitsType::K internal::key_matching_port< TraitsType >::key_type

Definition at line 666 of file _flow_graph_join_impl.h.

◆ noref_key_type

template<class TraitsType >
typedef tbb::internal::strip<key_type>::type internal::key_matching_port< TraitsType >::noref_key_type

Definition at line 667 of file _flow_graph_join_impl.h.

◆ predecessor_type

template<class TraitsType >
typedef receiver<input_type>::predecessor_type internal::key_matching_port< TraitsType >::predecessor_type

Definition at line 668 of file _flow_graph_join_impl.h.

◆ traits

template<class TraitsType >
typedef TraitsType internal::key_matching_port< TraitsType >::traits

Definition at line 663 of file _flow_graph_join_impl.h.

◆ type_to_key_func_type

template<class TraitsType >
typedef TraitsType::TtoK internal::key_matching_port< TraitsType >::type_to_key_func_type

Definition at line 669 of file _flow_graph_join_impl.h.

Member Enumeration Documentation

◆ op_type

template<class TraitsType >
enum internal::key_matching_port::op_type
private
Enumerator
try__put 
get__item 
res_port 

Definition at line 679 of file _flow_graph_join_impl.h.

680 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
681  , add_blt_pred, del_blt_pred, blt_pred_cnt, blt_pred_cpy
682 #endif
683  };

Constructor & Destructor Documentation

◆ key_matching_port() [1/2]

template<class TraitsType >
internal::key_matching_port< TraitsType >::key_matching_port ( )
inline

Definition at line 777 of file _flow_graph_join_impl.h.

777  : receiver<input_type>(), buffer_type() {
778  my_join = NULL;
779  my_aggregator.initialize_handler(handler_type(this));
780  }
matching_forwarding_base< key_type > * my_join
aggregator< handler_type, key_matching_port_operation > my_aggregator
internal::aggregating_functor< class_type, key_matching_port_operation > handler_type
hash_buffer< key_type, input_type, type_to_key_func_type, hash_compare_type > buffer_type

References internal::key_matching_port< TraitsType >::my_aggregator, and internal::key_matching_port< TraitsType >::my_join.

◆ key_matching_port() [2/2]

template<class TraitsType >
internal::key_matching_port< TraitsType >::key_matching_port ( const key_matching_port< TraitsType > &  )
inline

Definition at line 783 of file _flow_graph_join_impl.h.

783  : receiver<input_type>(), buffer_type() {
784  my_join = NULL;
785  my_aggregator.initialize_handler(handler_type(this));
786  }

References internal::key_matching_port< TraitsType >::my_aggregator, and internal::key_matching_port< TraitsType >::my_join.

◆ ~key_matching_port()

template<class TraitsType >
internal::key_matching_port< TraitsType >::~key_matching_port ( )
inline

Definition at line 788 of file _flow_graph_join_impl.h.

788 { }

Member Function Documentation

◆ get_item()

template<class TraitsType >
bool internal::key_matching_port< TraitsType >::get_item ( input_type v)
inline

Definition at line 798 of file _flow_graph_join_impl.h.

798  {
799  // aggregator uses current_key from FE for Key
800  key_matching_port_operation op_data(&v, get__item);
801  my_aggregator.execute(&op_data);
802  return op_data.status == SUCCEEDED;
803  }

References internal::key_matching_port< TraitsType >::get__item, internal::key_matching_port< TraitsType >::my_aggregator, tbb::interface6::internal::aggregated_operation< Derived >::status, and internal::SUCCEEDED.

◆ get_my_key_func()

template<class TraitsType >
type_to_key_func_type* internal::key_matching_port< TraitsType >::get_my_key_func ( )
inline

Definition at line 796 of file _flow_graph_join_impl.h.

References hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >::get_key_func().

Here is the call graph for this function:

◆ graph_reference()

template<class TraitsType >
graph& internal::key_matching_port< TraitsType >::graph_reference ( ) const
inlineprotected

◆ handle_operations()

template<class TraitsType >
void internal::key_matching_port< TraitsType >::handle_operations ( key_matching_port_operation op_list)
inlineprivate

Definition at line 709 of file _flow_graph_join_impl.h.

709  {
710  key_matching_port_operation *current;
711  while(op_list) {
712  current = op_list;
713  op_list = op_list->next;
714  switch(current->type) {
715  case try__put: {
716  bool was_inserted = this->insert_with_key(current->my_val);
717  // return failure if a duplicate insertion occurs
718  __TBB_store_with_release(current->status, was_inserted ? SUCCEEDED : FAILED);
719  }
720  break;
721  case get__item:
722  // use current_key from FE for item
723  if(!this->find_with_key(my_join->current_key, *(current->my_arg))) {
724  __TBB_ASSERT(false, "Failed to find item corresponding to current_key.");
725  }
726  __TBB_store_with_release(current->status, SUCCEEDED);
727  break;
728  case res_port:
729  // use current_key from FE for item
731  __TBB_store_with_release(current->status, SUCCEEDED);
732  break;
733 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
734  case add_blt_pred:
735  my_built_predecessors.add_edge(*(current->pred));
736  __TBB_store_with_release(current->status, SUCCEEDED);
737  break;
738  case del_blt_pred:
739  my_built_predecessors.delete_edge(*(current->pred));
740  __TBB_store_with_release(current->status, SUCCEEDED);
741  break;
742  case blt_pred_cnt:
743  current->cnt_val = my_built_predecessors.edge_count();
744  __TBB_store_with_release(current->status, SUCCEEDED);
745  break;
746  case blt_pred_cpy:
747  my_built_predecessors.copy_edges(*(current->plist));
748  __TBB_store_with_release(current->status, SUCCEEDED);
749  break;
750 #endif
751  }
752  }
753  }
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713

References __TBB_ASSERT, tbb::internal::__TBB_store_with_release(), internal::matching_forwarding_base< KeyType >::current_key, hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >::delete_with_key(), internal::FAILED, hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >::find_with_key(), internal::key_matching_port< TraitsType >::get__item, hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >::insert_with_key(), internal::key_matching_port< TraitsType >::key_matching_port_operation::my_arg, internal::key_matching_port< TraitsType >::my_join, internal::key_matching_port< TraitsType >::key_matching_port_operation::my_val, tbb::interface6::internal::aggregated_operation< Derived >::next, internal::key_matching_port< TraitsType >::res_port, tbb::interface6::internal::aggregated_operation< Derived >::status, internal::SUCCEEDED, internal::key_matching_port< TraitsType >::try__put, and internal::key_matching_port< TraitsType >::key_matching_port_operation::type.

Here is the call graph for this function:

◆ reset_port()

template<class TraitsType >
void internal::key_matching_port< TraitsType >::reset_port ( )
inline

Definition at line 835 of file _flow_graph_join_impl.h.

835  {
836  key_matching_port_operation op_data(res_port);
837  my_aggregator.execute(&op_data);
838  return;
839  }

References internal::key_matching_port< TraitsType >::my_aggregator, and internal::key_matching_port< TraitsType >::res_port.

◆ reset_receiver()

template<class TraitsType >
void internal::key_matching_port< TraitsType >::reset_receiver ( reset_flags  f)
inline

Definition at line 847 of file _flow_graph_join_impl.h.

847  {
850 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
851  if (f & rf_clear_edges)
852  my_built_predecessors.clear();
853 #endif
854  }
void suppress_unused_warning(const T1 &)
Utility template function to prevent "unused" warnings by various compilers.
Definition: tbb_stddef.h:398

References hash_buffer< Key, ValueType, ValueToKey, HashCompare, Allocator >::reset(), tbb::flow::interface11::rf_clear_edges, and tbb::internal::suppress_unused_warning().

Here is the call graph for this function:

◆ set_join_node_pointer()

template<class TraitsType >
void internal::key_matching_port< TraitsType >::set_join_node_pointer ( forwarding_base join)
inline

Definition at line 790 of file _flow_graph_join_impl.h.

790  {
791  my_join = dynamic_cast<matching_forwarding_base<key_type>*>(join);
792  }

References internal::key_matching_port< TraitsType >::my_join.

◆ set_my_key_func()

template<class TraitsType >
void internal::key_matching_port< TraitsType >::set_my_key_func ( type_to_key_func_type f)
inline

Definition at line 794 of file _flow_graph_join_impl.h.

References hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >::set_key_func().

Here is the call graph for this function:

◆ try_put_task()

template<class TraitsType >
task* internal::key_matching_port< TraitsType >::try_put_task ( const input_type v)
inlineprotected

Definition at line 759 of file _flow_graph_join_impl.h.

759  {
760  key_matching_port_operation op_data(v, try__put);
761  task *rtask = NULL;
762  my_aggregator.execute(&op_data);
763  if(op_data.status == SUCCEEDED) {
764  rtask = my_join->increment_key_count((*(this->get_key_func()))(v), false); // may spawn
765  // rtask has to reflect the return status of the try_put
766  if(!rtask) rtask = SUCCESSFULLY_ENQUEUED;
767  }
768  return rtask;
769  }
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
static tbb::task *const SUCCESSFULLY_ENQUEUED
virtual task * increment_key_count(current_key_type const &, bool)=0

References hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >::get_key_func(), internal::matching_forwarding_base< KeyType >::increment_key_count(), internal::key_matching_port< TraitsType >::my_aggregator, internal::key_matching_port< TraitsType >::my_join, tbb::interface6::internal::aggregated_operation< Derived >::status, internal::SUCCEEDED, tbb::flow::internal::SUCCESSFULLY_ENQUEUED, task, and internal::key_matching_port< TraitsType >::try__put.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ internal::aggregating_functor< class_type, key_matching_port_operation >

template<class TraitsType >
friend class internal::aggregating_functor< class_type, key_matching_port_operation >
friend

Definition at line 705 of file _flow_graph_join_impl.h.

◆ internal::broadcast_cache

template<class TraitsType >
template<typename X , typename Y >
friend class internal::broadcast_cache
friend

Definition at line 757 of file _flow_graph_join_impl.h.

◆ internal::round_robin_cache

template<class TraitsType >
template<typename X , typename Y >
friend class internal::round_robin_cache
friend

Definition at line 758 of file _flow_graph_join_impl.h.

◆ run_and_put_task

template<class TraitsType >
template<typename R , typename B >
friend class run_and_put_task
friend

Definition at line 756 of file _flow_graph_join_impl.h.

Member Data Documentation

◆ my_aggregator

◆ my_join


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.