Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::interface5::internal::hash_map_iterator< Container, Value > Class Template Reference

Meets requirements of a forward iterator for STL */. More...

#include <concurrent_hash_map.h>

Inheritance diagram for tbb::interface5::internal::hash_map_iterator< Container, Value >:
Collaboration diagram for tbb::interface5::internal::hash_map_iterator< Container, Value >:

Public Member Functions

 hash_map_iterator ()
 Construct undefined iterator. More...
 
 hash_map_iterator (const hash_map_iterator< Container, typename Container::value_type > &other)
 
Value & operator* () const
 
Value * operator-> () const
 
hash_map_iteratoroperator++ ()
 
hash_map_iterator operator++ (int)
 Post increment. More...
 

Private Types

typedef Container map_type
 
typedef Container::node node
 
typedef hash_map_base::node_base node_base
 
typedef hash_map_base::bucket bucket
 

Private Member Functions

void advance_to_next_bucket ()
 
 hash_map_iterator (const Container &map, size_t index, const bucket *b, node_base *n)
 

Private Attributes

const Container * my_map
 concurrent_hash_map over which we are iterating. More...
 
size_t my_index
 Index in hash table for current item. More...
 
const bucketmy_bucket
 Pointer to bucket. More...
 
nodemy_node
 Pointer to node that has current item. More...
 

Friends

template<typename C , typename U >
class hash_map_iterator
 
template<typename I >
class hash_map_range
 
template<typename Key , typename T , typename HashCompare , typename A >
class interface5::concurrent_hash_map
 
template<typename C , typename T , typename U >
bool operator== (const hash_map_iterator< C, T > &i, const hash_map_iterator< C, U > &j)
 
template<typename C , typename T , typename U >
bool operator!= (const hash_map_iterator< C, T > &i, const hash_map_iterator< C, U > &j)
 
template<typename C , typename T , typename U >
ptrdiff_t operator- (const hash_map_iterator< C, T > &i, const hash_map_iterator< C, U > &j)
 

Detailed Description

template<typename Container, typename Value>
class tbb::interface5::internal::hash_map_iterator< Container, Value >

Meets requirements of a forward iterator for STL */.

Value is either the T or const T type of the container.

Definition at line 327 of file concurrent_hash_map.h.

Member Typedef Documentation

◆ bucket

template<typename Container, typename Value>
typedef hash_map_base::bucket tbb::interface5::internal::hash_map_iterator< Container, Value >::bucket
private

Definition at line 333 of file concurrent_hash_map.h.

◆ map_type

template<typename Container, typename Value>
typedef Container tbb::interface5::internal::hash_map_iterator< Container, Value >::map_type
private

Definition at line 330 of file concurrent_hash_map.h.

◆ node

template<typename Container, typename Value>
typedef Container::node tbb::interface5::internal::hash_map_iterator< Container, Value >::node
private

Definition at line 331 of file concurrent_hash_map.h.

◆ node_base

template<typename Container, typename Value>
typedef hash_map_base::node_base tbb::interface5::internal::hash_map_iterator< Container, Value >::node_base
private

Definition at line 332 of file concurrent_hash_map.h.

Constructor & Destructor Documentation

◆ hash_map_iterator() [1/3]

template<typename Container , typename Value >
tbb::interface5::internal::hash_map_iterator< Container, Value >::hash_map_iterator ( const Container &  map,
size_t  index,
const bucket b,
node_base n 
)
private

Definition at line 411 of file concurrent_hash_map.h.

411  :
412  my_map(&map),
413  my_index(index),
414  my_bucket(b),
415  my_node( static_cast<node*>(n) )
416  {
417  if( b && !hash_map_base::is_valid(n) )
419  }
node * my_node
Pointer to node that has current item.
const Container * my_map
concurrent_hash_map over which we are iterating.
size_t my_index
Index in hash table for current item.
const bucket * my_bucket
Pointer to bucket.

References tbb::interface5::internal::hash_map_iterator< Container, Value >::advance_to_next_bucket(), and tbb::interface5::internal::hash_map_base::is_valid().

Here is the call graph for this function:

◆ hash_map_iterator() [2/3]

template<typename Container, typename Value>
tbb::interface5::internal::hash_map_iterator< Container, Value >::hash_map_iterator ( )
inline

Construct undefined iterator.

Definition at line 388 of file concurrent_hash_map.h.

388 : my_map(), my_index(), my_bucket(), my_node() {}
node * my_node
Pointer to node that has current item.
const Container * my_map
concurrent_hash_map over which we are iterating.
size_t my_index
Index in hash table for current item.
const bucket * my_bucket
Pointer to bucket.

◆ hash_map_iterator() [3/3]

template<typename Container, typename Value>
tbb::interface5::internal::hash_map_iterator< Container, Value >::hash_map_iterator ( const hash_map_iterator< Container, typename Container::value_type > &  other)
inline

Definition at line 389 of file concurrent_hash_map.h.

389  :
390  my_map(other.my_map),
391  my_index(other.my_index),
392  my_bucket(other.my_bucket),
393  my_node(other.my_node)
394  {}
node * my_node
Pointer to node that has current item.
const Container * my_map
concurrent_hash_map over which we are iterating.
size_t my_index
Index in hash table for current item.
const bucket * my_bucket
Pointer to bucket.

Member Function Documentation

◆ advance_to_next_bucket()

template<typename Container, typename Value>
void tbb::interface5::internal::hash_map_iterator< Container, Value >::advance_to_next_bucket ( )
inlineprivate

Definition at line 350 of file concurrent_hash_map.h.

350  { // TODO?: refactor to iterator_base class
351  size_t k = my_index+1;
352  __TBB_ASSERT( my_bucket, "advancing an invalid iterator?");
353  while( k <= my_map->my_mask ) {
354  // Following test uses 2's-complement wizardry
355  if( k&(k-2) ) // not the beginning of a segment
356  ++my_bucket;
357  else my_bucket = my_map->get_bucket( k );
358  my_node = static_cast<node*>( my_bucket->node_list );
360  my_index = k; return;
361  }
362  ++k;
363  }
364  my_bucket = 0; my_node = 0; my_index = k; // the end
365  }
node * my_node
Pointer to node that has current item.
const Container * my_map
concurrent_hash_map over which we are iterating.
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:169
size_t my_index
Index in hash table for current item.
const bucket * my_bucket
Pointer to bucket.

References __TBB_ASSERT, and tbb::interface5::internal::hash_map_base::is_valid().

Referenced by tbb::interface5::internal::hash_map_iterator< Container, Value >::hash_map_iterator().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator*()

template<typename Container, typename Value>
Value& tbb::interface5::internal::hash_map_iterator< Container, Value >::operator* ( ) const
inline

Definition at line 395 of file concurrent_hash_map.h.

395  {
396  __TBB_ASSERT( hash_map_base::is_valid(my_node), "iterator uninitialized or at end of container?" );
397  return my_node->value();
398  }
node * my_node
Pointer to node that has current item.
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:169

References __TBB_ASSERT, and tbb::interface5::internal::hash_map_base::is_valid().

Here is the call graph for this function:

◆ operator++() [1/2]

template<typename Container , typename Value >
hash_map_iterator< Container, Value > & tbb::interface5::internal::hash_map_iterator< Container, Value >::operator++ ( )

Definition at line 422 of file concurrent_hash_map.h.

422  {
423  my_node = static_cast<node*>( my_node->next );
425  return *this;
426  }
node * my_node
Pointer to node that has current item.

◆ operator++() [2/2]

template<typename Container, typename Value>
hash_map_iterator tbb::interface5::internal::hash_map_iterator< Container, Value >::operator++ ( int  )
inline

Post increment.

Definition at line 403 of file concurrent_hash_map.h.

403  {
404  hash_map_iterator old(*this);
405  operator++();
406  return old;
407  }
hash_map_iterator()
Construct undefined iterator.

◆ operator->()

template<typename Container, typename Value>
Value* tbb::interface5::internal::hash_map_iterator< Container, Value >::operator-> ( ) const
inline

Definition at line 399 of file concurrent_hash_map.h.

Friends And Related Function Documentation

◆ hash_map_iterator

template<typename Container, typename Value>
template<typename C , typename U >
friend class hash_map_iterator
friend

Definition at line 345 of file concurrent_hash_map.h.

◆ hash_map_range

template<typename Container, typename Value>
template<typename I >
friend class hash_map_range
friend

Definition at line 348 of file concurrent_hash_map.h.

◆ interface5::concurrent_hash_map

template<typename Container, typename Value>
template<typename Key , typename T , typename HashCompare , typename A >
friend class interface5::concurrent_hash_map
friend

Definition at line 368 of file concurrent_hash_map.h.

◆ operator!=

template<typename Container, typename Value>
template<typename C , typename T , typename U >
bool operator!= ( const hash_map_iterator< C, T > &  i,
const hash_map_iterator< C, U > &  j 
)
friend

◆ operator-

template<typename Container, typename Value>
template<typename C , typename T , typename U >
ptrdiff_t operator- ( const hash_map_iterator< C, T > &  i,
const hash_map_iterator< C, U > &  j 
)
friend

◆ operator==

template<typename Container, typename Value>
template<typename C , typename T , typename U >
bool operator== ( const hash_map_iterator< C, T > &  i,
const hash_map_iterator< C, U > &  j 
)
friend

Member Data Documentation

◆ my_bucket

template<typename Container, typename Value>
const bucket* tbb::interface5::internal::hash_map_iterator< Container, Value >::my_bucket
private

Pointer to bucket.

Definition at line 379 of file concurrent_hash_map.h.

◆ my_index

template<typename Container, typename Value>
size_t tbb::interface5::internal::hash_map_iterator< Container, Value >::my_index
private

Index in hash table for current item.

Definition at line 376 of file concurrent_hash_map.h.

◆ my_map

template<typename Container, typename Value>
const Container* tbb::interface5::internal::hash_map_iterator< Container, Value >::my_map
private

concurrent_hash_map over which we are iterating.

Definition at line 373 of file concurrent_hash_map.h.

Referenced by tbb::interface5::internal::operator!=(), and tbb::interface5::internal::operator==().

◆ my_node

template<typename Container, typename Value>
node* tbb::interface5::internal::hash_map_iterator< Container, Value >::my_node
private

Pointer to node that has current item.

Definition at line 382 of file concurrent_hash_map.h.

Referenced by tbb::interface5::internal::operator!=(), and tbb::interface5::internal::operator==().


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.