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< traits >	class_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_type >	buffer_type
Public Types inherited from tbb::flow::interface10::receiver< TraitsType::T >
typedef TraitsType::T	input_type
	The input type of this receiver. More...
typedef internal::async_helpers< TraitsType::T >::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 Types inherited from tbb::flow::interface10::internal::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_type *	pointer_type
typedef element_type *	list_array_type
typedef list_array_type *	pointer_array_type
typedef tbb::cache_aligned_allocator< typename aligned_pair< TraitsType::T, void * >::type > ::template rebind< list_array_type >::other	pointer_array_allocator_type
typedef tbb::cache_aligned_allocator< typename aligned_pair< TraitsType::T, void * >::type > ::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_type *	get_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 tbb::flow::interface10::receiver< TraitsType::T >
bool	try_put (const typename internal::async_helpers< TraitsType::T >::filtered_type &t)
	Put an item to the receiver. More...
bool	try_put (const typename internal::async_helpers< TraitsType::T >::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...
virtual bool	register_predecessor (predecessor_type &)
	Add a predecessor to the node. More...
virtual bool	remove_predecessor (predecessor_type &)
	Remove a predecessor from the node. More...
Public Member Functions inherited from tbb::flow::interface10::internal::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
task *	try_put_task (const input_type &v) __TBB_override
	Put item to successor; return task to run the successor if possible. More...
graph &	graph_reference () __TBB_override
Protected Member Functions inherited from tbb::flow::interface10::receiver< TraitsType::T >
virtual task *	try_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 >
task *	try_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 ()

Private Types
enum	op_type { try__put, get__item, res_port }
typedef internal::aggregating_functor< class_type, key_matching_port_operation >	handler_type

Private Member Functions
void	handle_operations (key_matching_port_operation *op_list)

Private Attributes
aggregator< handler_type, key_matching_port_operation >	my_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 tbb::flow::interface10::internal::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 650 of file _flow_graph_join_impl.h.

Member Typedef Documentation

buffer_type

template<class TraitsType >

typedef hash_buffer< key_type, input_type, type_to_key_func_type, hash_compare_type > internal::key_matching_port< TraitsType >::buffer_type

Definition at line 663 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 656 of file _flow_graph_join_impl.h.

handler_type

template<class TraitsType >

typedef internal::aggregating_functor<class_type, key_matching_port_operation> internal::key_matching_port< TraitsType >::handler_type

private

Definition at line 697 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 662 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 657 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 658 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 659 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 660 of file _flow_graph_join_impl.h.

traits

template<class TraitsType >

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

Definition at line 655 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 661 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 671 of file _flow_graph_join_impl.h.

                     { try__put, get__item, res_port
#if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
           , add_blt_pred, del_blt_pred, blt_pred_cnt, blt_pred_cpy
#endif
        };

Constructor & Destructor Documentation

key_matching_port() [1/2]

template<class TraitsType >

internal::key_matching_port< TraitsType >::key_matching_port ( )

inline

Definition at line 769 of file _flow_graph_join_impl.h.

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

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 775 of file _flow_graph_join_impl.h.

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

~key_matching_port()

template<class TraitsType >

internal::key_matching_port< TraitsType >::~key_matching_port ( )

inline

Definition at line 780 of file _flow_graph_join_impl.h.

{ }

Member Function Documentation

get_item()

template<class TraitsType >

bool internal::key_matching_port< TraitsType >::get_item ( input_type &  v )

inline

Definition at line 790 of file _flow_graph_join_impl.h.

References __TBB_override, p, and SUCCEEDED.

                                       {
            // aggregator uses current_key from FE for Key
            key_matching_port_operation op_data(&v, get__item);
            my_aggregator.execute(&op_data);
            return op_data.status == 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 788 of file _flow_graph_join_impl.h.

{ return this->get_key_func(); }

graph_reference()

template<class TraitsType >

graph& internal::key_matching_port< TraitsType >::graph_reference ( )

inlineprotectedvirtual

Implements tbb::flow::interface10::internal::untyped_receiver.

Definition at line 763 of file _flow_graph_join_impl.h.

                                                {
            return my_join->graph_ref;
        }

handle_operations()

template<class TraitsType >

void internal::key_matching_port< TraitsType >::handle_operations ( key_matching_port_operation *  op_list )

inlineprivate

Definition at line 701 of file _flow_graph_join_impl.h.

References __TBB_ASSERT, tbb::internal::__TBB_store_with_release(), FAILED, internal::key_matching_port< TraitsType >::key_matching_port_operation::my_arg, internal::key_matching_port< TraitsType >::key_matching_port_operation::my_val, SUCCEEDED, and internal::key_matching_port< TraitsType >::key_matching_port_operation::type.

                                                                     {
            key_matching_port_operation *current;
            while(op_list) {
                current = op_list;
                op_list = op_list->next;
                switch(current->type) {
                case try__put: {
                        bool was_inserted = this->insert_with_key(current->my_val);
                        // return failure if a duplicate insertion occurs
                        __TBB_store_with_release(current->status, was_inserted ? SUCCEEDED : FAILED);
                    }
                    break;
                case get__item:
                    // use current_key from FE for item
                    if(!this->find_with_key(my_join->current_key, *(current->my_arg))) {
                        __TBB_ASSERT(false, "Failed to find item corresponding to current_key.");
                    }
                    __TBB_store_with_release(current->status, SUCCEEDED);
                    break;
                case res_port:
                    // use current_key from FE for item
                    this->delete_with_key(my_join->current_key);
                    __TBB_store_with_release(current->status, SUCCEEDED);
                    break;
#if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
                case add_blt_pred:
                    my_built_predecessors.add_edge(*(current->pred));
                    __TBB_store_with_release(current->status, SUCCEEDED);
                    break;
                case del_blt_pred:
                    my_built_predecessors.delete_edge(*(current->pred));
                    __TBB_store_with_release(current->status, SUCCEEDED);
                    break;
                case blt_pred_cnt:
                    current->cnt_val = my_built_predecessors.edge_count();
                    __TBB_store_with_release(current->status, SUCCEEDED);
                    break;
                case blt_pred_cpy:
                    my_built_predecessors.copy_edges(*(current->plist));
                    __TBB_store_with_release(current->status, SUCCEEDED);
                    break;
#endif
                }
            }
        }

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 827 of file _flow_graph_join_impl.h.

                          {
            key_matching_port_operation op_data(res_port);
            my_aggregator.execute(&op_data);
            return;
        }

reset_receiver()

template<class TraitsType >

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

inline

Definition at line 839 of file _flow_graph_join_impl.h.

References tbb::flow::interface10::rf_clear_edges, and tbb::internal::suppress_unused_warning().

                                                           {
            tbb::internal::suppress_unused_warning(f);
            buffer_type::reset();
#if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
           if (f & rf_clear_edges)
              my_built_predecessors.clear();
#endif
        }

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 782 of file _flow_graph_join_impl.h.

                                                          {
            my_join = dynamic_cast<matching_forwarding_base<key_type>*>(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 786 of file _flow_graph_join_impl.h.

{ this->set_key_func(f); }

try_put_task()

template<class TraitsType >

task* internal::key_matching_port< TraitsType >::try_put_task ( const input_type &  t )

inlineprotectedvirtual

Put item to successor; return task to run the successor if possible.

Implements tbb::flow::interface10::receiver< TraitsType::T >.

Definition at line 751 of file _flow_graph_join_impl.h.

References SUCCEEDED, tbb::flow::internal::SUCCESSFULLY_ENQUEUED, and task.

                                                               {
            key_matching_port_operation op_data(v, try__put);
            task *rtask = NULL;
            my_aggregator.execute(&op_data);
            if(op_data.status == SUCCEEDED) {
                rtask = my_join->increment_key_count((*(this->get_key_func()))(v), false);  // may spawn
                // rtask has to reflect the return status of the try_put
                if(!rtask) rtask = SUCCESSFULLY_ENQUEUED;
            }
            return rtask;
        }

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 698 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 749 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 750 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 748 of file _flow_graph_join_impl.h.

Member Data Documentation

my_aggregator

template<class TraitsType >

aggregator<handler_type, key_matching_port_operation> internal::key_matching_port< TraitsType >::my_aggregator

private

Definition at line 699 of file _flow_graph_join_impl.h.

my_join

template<class TraitsType >

matching_forwarding_base<key_type>* internal::key_matching_port< TraitsType >::my_join

private

Definition at line 851 of file _flow_graph_join_impl.h.

---

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

• _flow_graph_join_impl.h