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 342 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 348 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 345 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 346 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 347 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 426 of file concurrent_hash_map.h.

426  :
427  my_map(&map),
428  my_index(index),
429  my_bucket(b),
430  my_node( static_cast<node*>(n) )
431  {
432  if( b && !hash_map_base::is_valid(n) )
434  }
node * my_node
Pointer to node that has current item.
size_t my_index
Index in hash table for current item.
const Container * my_map
concurrent_hash_map over which we are iterating.
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 403 of file concurrent_hash_map.h.

403 : my_map(), my_index(), my_bucket(), my_node() {}
node * my_node
Pointer to node that has current item.
size_t my_index
Index in hash table for current item.
const Container * my_map
concurrent_hash_map over which we are iterating.
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 404 of file concurrent_hash_map.h.

404  :
405  my_map(other.my_map),
406  my_index(other.my_index),
407  my_bucket(other.my_bucket),
408  my_node(other.my_node)
409  {}
node * my_node
Pointer to node that has current item.
size_t my_index
Index in hash table for current item.
const Container * my_map
concurrent_hash_map over which we are iterating.
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 365 of file concurrent_hash_map.h.

365  { // TODO?: refactor to iterator_base class
366  size_t k = my_index+1;
367  __TBB_ASSERT( my_bucket, "advancing an invalid iterator?");
368  while( k <= my_map->my_mask ) {
369  // Following test uses 2's-complement wizardry
370  if( k&(k-2) ) // not the beginning of a segment
371  ++my_bucket;
372  else my_bucket = my_map->get_bucket( k );
373  my_node = static_cast<node*>( my_bucket->node_list );
375  my_index = k; return;
376  }
377  ++k;
378  }
379  my_bucket = 0; my_node = 0; my_index = k; // the end
380  }
node * my_node
Pointer to node that has current item.
size_t my_index
Index in hash table for current item.
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
const Container * my_map
concurrent_hash_map over which we are iterating.
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 410 of file concurrent_hash_map.h.

410  {
411  __TBB_ASSERT( hash_map_base::is_valid(my_node), "iterator uninitialized or at end of container?" );
412  return my_node->value();
413  }
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:165

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 437 of file concurrent_hash_map.h.

437  {
438  my_node = static_cast<node*>( my_node->next );
440  return *this;
441  }
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 418 of file concurrent_hash_map.h.

418  {
419  hash_map_iterator old(*this);
420  operator++();
421  return old;
422  }
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 414 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 360 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 363 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 383 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 394 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 391 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 388 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 397 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.