Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags > Class Template Reference

The class template unordered_multiset is an intrusive container, that mimics most of the interface of std::tr1::unordered_multiset as described in the C++ TR1. More...

#include <unordered_set.hpp>

Inheritance diagram for boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >:
Collaboration diagram for boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >:

Public Types

typedef
implementation_defined::value_type 
value_type
 
typedef
implementation_defined::value_traits 
value_traits
 
typedef
implementation_defined::bucket_traits 
bucket_traits
 
typedef
implementation_defined::pointer 
pointer
 
typedef
implementation_defined::const_pointer 
const_pointer
 
typedef
implementation_defined::reference 
reference
 
typedef
implementation_defined::const_reference 
const_reference
 
typedef
implementation_defined::difference_type 
difference_type
 
typedef
implementation_defined::size_type 
size_type
 
typedef
implementation_defined::key_type 
key_type
 
typedef
implementation_defined::key_equal 
key_equal
 
typedef
implementation_defined::hasher 
hasher
 
typedef
implementation_defined::bucket_type 
bucket_type
 
typedef
implementation_defined::bucket_ptr 
bucket_ptr
 
typedef
implementation_defined::iterator 
iterator
 
typedef
implementation_defined::const_iterator 
const_iterator
 
typedef
implementation_defined::insert_commit_data 
insert_commit_data
 
typedef
implementation_defined::local_iterator 
local_iterator
 
typedef
implementation_defined::const_local_iterator 
const_local_iterator
 
typedef
implementation_defined::node_traits 
node_traits
 
typedef
implementation_defined::node 
node
 
typedef
implementation_defined::node_ptr 
node_ptr
 
typedef
implementation_defined::const_node_ptr 
const_node_ptr
 
typedef
implementation_defined::node_algorithms 
node_algorithms
 
typedef data_type::value_equal value_equal
 
typedef pointer_traits
< pointer >::template
rebind_pointer< const
bucket_type >::type 
const_bucket_ptr
 
typedef pointer_traits
< bucket_ptr >::reference 
bucket_reference
 
typedef pointer_traits
< bucket_ptr >::reference 
const_bucket_reference
 
typedef slist_impl::iterator siterator
 
typedef slist_impl::const_iterator const_siterator
 
typedef pointer_traits
< node_ptr >::reference 
node_reference
 
typedef pointer_traits
< const_node_ptr >::reference 
const_node_reference
 

Public Member Functions

 unordered_multiset_impl (const bucket_traits &b_traits, const hasher &hash_func=hasher(), const key_equal &equal_func=key_equal(), const value_traits &v_traits=value_traits())
 Requires: buckets must not be being used by any other resource. More...
 
template<class Iterator >
 unordered_multiset_impl (Iterator b, Iterator e, const bucket_traits &b_traits, const hasher &hash_func=hasher(), const key_equal &equal_func=key_equal(), const value_traits &v_traits=value_traits())
 Requires: buckets must not be being used by any other resource and Dereferencing iterator must yield an lvalue of type value_type. More...
 
 unordered_multiset_impl (BOOST_RV_REF(unordered_multiset_impl) x)
 Effects: to-do More...
 
unordered_multiset_imploperator= (BOOST_RV_REF(unordered_multiset_impl) x)
 Effects: to-do More...
 
iterator insert (reference value)
 Requires: value must be an lvalue More...
 
template<class Iterator >
void insert (Iterator b, Iterator e)
 Requires: Dereferencing iterator must yield an lvalue of type value_type. More...
 
iterator begin ()
 Effects: Returns an iterator pointing to the beginning of the unordered_set. More...
 
const_iterator begin () const
 Effects: Returns a const_iterator pointing to the beginning of the unordered_set. More...
 
local_iterator begin (size_type n)
 Requires: n is in the range [0, this->bucket_count()). More...
 
const_local_iterator begin (size_type n) const
 Requires: n is in the range [0, this->bucket_count()). More...
 
const_iterator cbegin () const
 Effects: Returns a const_iterator pointing to the beginning of the unordered_set. More...
 
const_local_iterator cbegin (size_type n) const
 Requires: n is in the range [0, this->bucket_count()). More...
 
iterator end ()
 Effects: Returns an iterator pointing to the end of the unordered_set. More...
 
const_iterator end () const
 Effects: Returns a const_iterator pointing to the end of the unordered_set. More...
 
local_iterator end (size_type n)
 Requires: n is in the range [0, this->bucket_count()). More...
 
const_local_iterator end (size_type n) const
 Requires: n is in the range [0, this->bucket_count()). More...
 
const_iterator cend () const
 Effects: Returns a const_iterator pointing to the end of the unordered_set. More...
 
const_local_iterator cend (size_type n) const
 Requires: n is in the range [0, this->bucket_count()). More...
 
hasher hash_function () const
 Effects: Returns the hasher object used by the unordered_set. More...
 
key_equal key_eq () const
 Effects: Returns the key_equal object used by the unordered_set. More...
 
bool empty () const
 Effects: Returns true if the container is empty. More...
 
size_type size () const
 Effects: Returns the number of elements stored in the unordered_set. More...
 
void swap (hashtable_impl &other)
 Requires: the hasher and the equality function unqualified swap call should not throw. More...
 
void clone_from (const hashtable_impl &src, Cloner cloner, Disposer disposer)
 Requires: Disposer::operator()(pointer) shouldn't throw Cloner should yield to nodes that compare equal and produce the same hash than the original node. More...
 
iterator insert_equal (reference value)
 Requires: value must be an lvalue More...
 
void insert_equal (Iterator b, Iterator e)
 Requires: Dereferencing iterator must yield an lvalue of type value_type. More...
 
std::pair< iterator, bool > insert_unique (reference value)
 Requires: value must be an lvalue More...
 
void insert_unique (Iterator b, Iterator e)
 Requires: Dereferencing iterator must yield an lvalue of type value_type. More...
 
std::pair< iterator, bool > insert_unique_check (const KeyType &key, KeyHasher hash_func, KeyValueEqual equal_func, insert_commit_data &commit_data)
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
iterator insert_unique_commit (reference value, const insert_commit_data &commit_data)
 Requires: value must be an lvalue of type value_type. More...
 
void erase (const_iterator i)
 Effects: Erases the element pointed to by i. More...
 
void erase (const_iterator b, const_iterator e)
 Effects: Erases the range pointed to by b end e. More...
 
size_type erase (const_reference value)
 Effects: Erases all the elements with the given value. More...
 
size_type erase (const KeyType &key, KeyHasher hash_func, KeyValueEqual equal_func)
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
void erase_and_dispose (const_iterator i, Disposer disposer)
 Requires: Disposer::operator()(pointer) shouldn't throw. More...
 
void erase_and_dispose (const_iterator b, const_iterator e, Disposer disposer)
 Requires: Disposer::operator()(pointer) shouldn't throw. More...
 
size_type erase_and_dispose (const_reference value, Disposer disposer)
 Requires: Disposer::operator()(pointer) shouldn't throw. More...
 
size_type erase_and_dispose (const KeyType &key, KeyHasher hash_func, KeyValueEqual equal_func, Disposer disposer)
 Requires: Disposer::operator()(pointer) shouldn't throw. More...
 
void clear ()
 Effects: Erases all of the elements. More...
 
void clear_and_dispose (Disposer disposer)
 Requires: Disposer::operator()(pointer) shouldn't throw. More...
 
size_type count (const_reference value) const
 Effects: Returns the number of contained elements with the given value More...
 
size_type count (const KeyType &key, const KeyHasher &hash_func, const KeyValueEqual &equal_func) const
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
iterator find (const_reference value)
 Effects: Finds an iterator to the first element is equal to "value" or end() if that element does not exist. More...
 
iterator find (const KeyType &key, KeyHasher hash_func, KeyValueEqual equal_func)
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
const_iterator find (const_reference value) const
 Effects: Finds a const_iterator to the first element whose key is "key" or end() if that element does not exist. More...
 
const_iterator find (const KeyType &key, KeyHasher hash_func, KeyValueEqual equal_func) const
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
std::pair< iterator, iteratorequal_range (const_reference value)
 Effects: Returns a range containing all elements with values equivalent to value. More...
 
std::pair< iterator, iteratorequal_range (const KeyType &key, KeyHasher hash_func, KeyValueEqual equal_func)
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
std::pair< const_iterator,
const_iterator
equal_range (const_reference value) const
 Effects: Returns a range containing all elements with values equivalent to value. More...
 
std::pair< const_iterator,
const_iterator
equal_range (const KeyType &key, KeyHasher hash_func, KeyValueEqual equal_func) const
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
iterator iterator_to (reference value)
 Requires: value must be an lvalue and shall be in a unordered_set of appropriate type. More...
 
const_iterator iterator_to (const_reference value) const
 Requires: value must be an lvalue and shall be in a unordered_set of appropriate type. More...
 
local_iterator local_iterator_to (reference value)
 Requires: value must be an lvalue and shall be in a unordered_set of appropriate type. More...
 
const_local_iterator local_iterator_to (const_reference value) const
 Requires: value must be an lvalue and shall be in a unordered_set of appropriate type. More...
 
size_type bucket_count () const
 Effects: Returns the number of buckets passed in the constructor or the last rehash function. More...
 
size_type bucket_size (size_type n) const
 Requires: n is in the range [0, this->bucket_count()). More...
 
size_type bucket (const key_type &k) const
 Effects: Returns the index of the bucket in which elements with keys equivalent to k would be found, if any such element existed. More...
 
size_type bucket (const KeyType &k, const KeyHasher &hash_func) const
 Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher. More...
 
bucket_ptr bucket_pointer () const
 Effects: Returns the bucket array pointer passed in the constructor or the last rehash function. More...
 
void rehash (const bucket_traits &new_bucket_traits)
 Requires: new_bucket_traits can hold a pointer to a new bucket array or the same as the old bucket array with a different length. More...
 
bool incremental_rehash (bool grow=true)
 Requires: More...
 
bool incremental_rehash (const bucket_traits &new_bucket_traits)
 Effects: If new_bucket_traits.bucket_count() is not this->bucket_count()/2 or this->bucket_count()*2, or this->split_bucket() != new_bucket_traits.bucket_count() returns false and does nothing. More...
 
size_type split_count () const
 Requires: More...
 

Static Public Member Functions

static local_iterator s_local_iterator_to (reference value)
 Requires: value must be an lvalue and shall be in a unordered_set of appropriate type. More...
 
static const_local_iterator s_local_iterator_to (const_reference value)
 Requires: value must be an lvalue and shall be in a unordered_set of appropriate type. More...
 
static size_type suggested_upper_bucket_count (size_type n)
 Effects: Returns the nearest new bucket count optimized for the container that is bigger or equal than n. More...
 
static size_type suggested_lower_bucket_count (size_type n)
 Effects: Returns the nearest new bucket count optimized for the container that is smaller or equal than n. More...
 

Static Public Attributes

static const bool stateful_value_traits
 
static const bool store_hash
 
static const bool unique_keys
 
static const bool constant_time_size
 
static const bool cache_begin
 
static const bool compare_hash
 
static const bool incremental
 
static const bool power_2_buckets
 
static const bool optimize_multikey
 

Detailed Description

template<class ValueTraits, class Hash, class Equal, class SizeType, class BucketTraits, std::size_t BoolFlags>
class boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >

The class template unordered_multiset is an intrusive container, that mimics most of the interface of std::tr1::unordered_multiset as described in the C++ TR1.

unordered_multiset is a semi-intrusive container: each object to be stored in the container must contain a proper hook, but the container also needs additional auxiliary memory to work: unordered_multiset needs a pointer to an array of type bucket_type to be passed in the constructor. This bucket array must have at least the same lifetime as the container. This makes the use of unordered_multiset more complicated than purely intrusive containers. bucket_type is default-constructible, copyable and assignable

The template parameter T is the type to be managed by the container. The user can specify additional options and if no options are provided default options are used.

The container supports the following options: base_hook<>/member_hook<>/value_traits<>, constant_time_size<>, size_type<>, hash<> and equal<> bucket_traits<>, power_2_buckets<> and cache_begin<>.

unordered_multiset only provides forward iterators but it provides 4 iterator types: iterator and const_iterator to navigate through the whole container and local_iterator and const_local_iterator to navigate through the values stored in a single bucket. Local iterators are faster and smaller.

It's not recommended to use non constant-time size unordered_multisets because several key functions, like "empty()", become non-constant time functions. Non constant-time size unordered_multisets are mainly provided to support auto-unlink hooks.

unordered_multiset, unlike std::unordered_set, does not make automatic rehashings nor offers functions related to a load factor. Rehashing can be explicitly requested and the user must provide a new bucket array that will be used from that moment.

Since no automatic rehashing is done, iterators are never invalidated when inserting or erasing elements. Iterators are only invalidated when rehasing.

Member Typedef Documentation

template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::bucket_ptr boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::bucket_ptr
typedef pointer_traits<bucket_ptr>::reference boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::bucket_reference
inherited
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::bucket_traits boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::bucket_traits
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::bucket_type boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::bucket_type
typedef pointer_traits<pointer>::template rebind_pointer< const bucket_type >::type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::const_bucket_ptr
inherited
typedef pointer_traits<bucket_ptr>::reference boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::const_bucket_reference
inherited
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::const_iterator boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::const_iterator
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::const_local_iterator boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::const_local_iterator
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::const_node_ptr boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::const_node_ptr
typedef pointer_traits<const_node_ptr>::reference boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::const_node_reference
inherited
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::const_pointer boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::const_pointer
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::const_reference boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::const_reference
typedef slist_impl::const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::const_siterator
inherited
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::difference_type boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::difference_type
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::hasher boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::hasher
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::insert_commit_data boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::insert_commit_data
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::iterator boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::iterator
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::key_equal boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::key_equal
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::key_type boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::key_type
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::local_iterator boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::local_iterator
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::node boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::node
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::node_algorithms boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::node_algorithms
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::node_ptr boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::node_ptr
typedef pointer_traits<node_ptr>::reference boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::node_reference
inherited
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::node_traits boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::node_traits
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::pointer boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::pointer
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::reference boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::reference
typedef slist_impl::iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::siterator
inherited
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::size_type boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::size_type
typedef data_type::value_equal boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::value_equal
inherited
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::value_traits boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::value_traits
template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
typedef implementation_defined::value_type boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::value_type

Constructor & Destructor Documentation

template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::unordered_multiset_impl ( const bucket_traits b_traits,
const hasher hash_func = hasher(),
const key_equal equal_func = key_equal(),
const value_traits v_traits = value_traits() 
)
inlineexplicit

Requires: buckets must not be being used by any other resource.

Effects: Constructs an empty unordered_multiset, storing a reference to the bucket array and copies of the hasher and equal functors.

Complexity: Constant.

Throws: If value_traits::node_traits::node constructor throws (this does not happen with predefined Boost.Intrusive hooks) or the copy constructor or invocation of Hash or Equal throws.

Notes: buckets array must be disposed only after *this is disposed.

template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
template<class Iterator >
boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::unordered_multiset_impl ( Iterator  b,
Iterator  e,
const bucket_traits b_traits,
const hasher hash_func = hasher(),
const key_equal equal_func = key_equal(),
const value_traits v_traits = value_traits() 
)
inline

Requires: buckets must not be being used by any other resource and Dereferencing iterator must yield an lvalue of type value_type.

Effects: Constructs an empty unordered_multiset and inserts elements from [b, e).

Complexity: If N is std::distance(b, e): Average case is O(N) (with a good hash function and with buckets_len >= N),worst case O(N2).

Throws: If value_traits::node_traits::node constructor throws (this does not happen with predefined Boost.Intrusive hooks) or the copy constructor or invocation of hasher or key_equal throws.

Notes: buckets array must be disposed only after *this is disposed.

template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::unordered_multiset_impl ( BOOST_RV_REF(unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >)  x)
inline

Effects: to-do

Member Function Documentation

iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::begin ( void  )
inlineinherited

Effects: Returns an iterator pointing to the beginning of the unordered_set.

Complexity: Amortized constant time. Worst case (empty unordered_set): O(this->bucket_count())

Throws: Nothing.

const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::begin ( void  ) const
inlineinherited

Effects: Returns a const_iterator pointing to the beginning of the unordered_set.

Complexity: Amortized constant time. Worst case (empty unordered_set): O(this->bucket_count())

Throws: Nothing.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::cbegin().

local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::begin ( size_type  n)
inlineinherited

Requires: n is in the range [0, this->bucket_count()).

Effects: Returns a local_iterator pointing to the beginning of the sequence stored in the bucket n.

Complexity: Constant.

Throws: Nothing.

Note: [this->begin(n), this->end(n)) is a valid range containing all of the elements in the nth bucket.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::begin().

const_local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::begin ( size_type  n) const
inlineinherited

Requires: n is in the range [0, this->bucket_count()).

Effects: Returns a const_local_iterator pointing to the beginning of the sequence stored in the bucket n.

Complexity: Constant.

Throws: Nothing.

Note: [this->begin(n), this->end(n)) is a valid range containing all of the elements in the nth bucket.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::cbegin().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::bucket ( const key_type k) const
inlineinherited

Effects: Returns the index of the bucket in which elements with keys equivalent to k would be found, if any such element existed.

Complexity: Constant.

Throws: If the hash functor throws.

Note: the return value is in the range [0, this->bucket_count()).

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::bucket().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::bucket ( const KeyType &  k,
const KeyHasher &  hash_func 
) const
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

Effects: Returns the index of the bucket in which elements with keys equivalent to k would be found, if any such element existed.

Complexity: Constant.

Throws: If hash_func throws.

Note: the return value is in the range [0, this->bucket_count()).

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::bucket_count ( ) const
inlineinherited

Effects: Returns the number of buckets passed in the constructor or the last rehash function.

Complexity: Constant.

Throws: Nothing.

bucket_ptr boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::bucket_pointer ( ) const
inlineinherited

Effects: Returns the bucket array pointer passed in the constructor or the last rehash function.

Complexity: Constant.

Throws: Nothing.

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::bucket_size ( size_type  n) const
inlineinherited

Requires: n is in the range [0, this->bucket_count()).

Effects: Returns the number of elements in the nth bucket.

Complexity: Constant.

Throws: Nothing.

References boost::n.

const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::cbegin ( ) const
inlineinherited

Effects: Returns a const_iterator pointing to the beginning of the unordered_set.

Complexity: Amortized constant time. Worst case (empty unordered_set): O(this->bucket_count())

Throws: Nothing.

const_local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::cbegin ( size_type  n) const
inlineinherited

Requires: n is in the range [0, this->bucket_count()).

Effects: Returns a const_local_iterator pointing to the beginning of the sequence stored in the bucket n.

Complexity: Constant.

Throws: Nothing.

Note: [this->begin(n), this->end(n)) is a valid range containing all of the elements in the nth bucket.

References boost::intrusive::pointer_traits< Ptr >::const_cast_from(), and boost::n.

const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::cend ( ) const
inlineinherited

Effects: Returns a const_iterator pointing to the end of the unordered_set.

Complexity: Constant.

Throws: Nothing.

const_local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::cend ( size_type  n) const
inlineinherited

Requires: n is in the range [0, this->bucket_count()).

Effects: Returns a const_local_iterator pointing to the end of the sequence stored in the bucket n.

Complexity: Constant.

Throws: Nothing.

Note: [this->begin(n), this->end(n)) is a valid range containing all of the elements in the nth bucket.

References boost::intrusive::pointer_traits< Ptr >::const_cast_from(), and boost::n.

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::clear ( void  )
inlineinherited

Effects: Erases all of the elements.

Complexity: Linear to the number of elements on the container. if it's a safe-mode or auto-unlink value_type. Constant time otherwise.

Throws: Nothing.

Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::clear_and_dispose ( Disposer  disposer)
inlineinherited

Requires: Disposer::operator()(pointer) shouldn't throw.

Effects: Erases all of the elements.

Complexity: Linear to the number of elements on the container. Disposer::operator()(pointer) is called for the removed elements.

Throws: Nothing.

Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.

References boost::asio::b, boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::bucket_count(), and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::empty().

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::clone_from ( const hashtable_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags > &  src,
Cloner  cloner,
Disposer  disposer 
)
inlineinherited

Requires: Disposer::operator()(pointer) shouldn't throw Cloner should yield to nodes that compare equal and produce the same hash than the original node.

Effects: Erases all the elements from *this calling Disposer::operator()(pointer), clones all the elements from src calling Cloner::operator()(const_reference ) and inserts them on *this. The hash function and the equality predicate are copied from the source.

If store_hash option is true, this method does not use the hash function.

If any operation throws, all cloned elements are unlinked and disposed calling Disposer::operator()(pointer).

Complexity: Linear to erased plus inserted elements.

Throws: If cloner or hasher throw or hash or equality predicate copying throws. Basic guarantee.

References boost::asio::b, boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::bucket_count(), boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::cbegin(), boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::cend(), boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::clear_and_dispose(), boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::empty(), and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::insert_equal().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::count ( const_reference  value) const
inlineinherited

Effects: Returns the number of contained elements with the given value

Complexity: Average case O(1), worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::count().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::count ( const KeyType &  key,
const KeyHasher &  hash_func,
const KeyValueEqual &  equal_func 
) const
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

"equal_func" must be a equality function that induces the same equality as key_equal. The difference is that "equal_func" compares an arbitrary key with the contained values.

Effects: Returns the number of contained elements with the given key

Complexity: Average case O(1), worst case O(this->size()).

Throws: If hash_func or equal throw.

bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::empty ( void  ) const
inlineinherited
iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::end ( void  )
inlineinherited

Effects: Returns an iterator pointing to the end of the unordered_set.

Complexity: Constant.

Throws: Nothing.

const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::end ( void  ) const
inlineinherited

Effects: Returns a const_iterator pointing to the end of the unordered_set.

Complexity: Constant.

Throws: Nothing.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::cend().

local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::end ( size_type  n)
inlineinherited

Requires: n is in the range [0, this->bucket_count()).

Effects: Returns a local_iterator pointing to the end of the sequence stored in the bucket n.

Complexity: Constant.

Throws: Nothing.

Note: [this->begin(n), this->end(n)) is a valid range containing all of the elements in the nth bucket.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::end().

const_local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::end ( size_type  n) const
inlineinherited

Requires: n is in the range [0, this->bucket_count()).

Effects: Returns a const_local_iterator pointing to the end of the sequence stored in the bucket n.

Complexity: Constant.

Throws: Nothing.

Note: [this->begin(n), this->end(n)) is a valid range containing all of the elements in the nth bucket.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::cend().

std::pair<iterator,iterator> boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::equal_range ( const_reference  value)
inlineinherited

Effects: Returns a range containing all elements with values equivalent to value.

Returns std::make_pair(this->end(), this->end()) if no such elements exist.

Complexity: Average case O(this->count(value)). Worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::equal_range().

std::pair<iterator,iterator> boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::equal_range ( const KeyType &  key,
KeyHasher  hash_func,
KeyValueEqual  equal_func 
)
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

"equal_func" must be a equality function that induces the same equality as key_equal. The difference is that "equal_func" compares an arbitrary key with the contained values.

Effects: Returns a range containing all elements with equivalent keys. Returns std::make_pair(this->end(), this->end()) if no such elements exist.

Complexity: Average case O(this->count(key, hash_func, equal_func)). Worst case O(this->size()).

Throws: If hash_func or the equal_func throw.

Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.

References boost::multiprecision::backends::this.

std::pair<const_iterator, const_iterator> boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::equal_range ( const_reference  value) const
inlineinherited

Effects: Returns a range containing all elements with values equivalent to value.

Returns std::make_pair(this->end(), this->end()) if no such elements exist.

Complexity: Average case O(this->count(value)). Worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::equal_range().

std::pair<const_iterator,const_iterator> boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::equal_range ( const KeyType &  key,
KeyHasher  hash_func,
KeyValueEqual  equal_func 
) const
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

"equal_func" must be a equality function that induces the same equality as key_equal. The difference is that "equal_func" compares an arbitrary key with the contained values.

Effects: Returns a range containing all elements with equivalent keys. Returns std::make_pair(this->end(), this->end()) if no such elements exist.

Complexity: Average case O(this->count(key, hash_func, equal_func)). Worst case O(this->size()).

Throws: If the hasher or equal_func throw.

Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.

References boost::multiprecision::backends::this.

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase ( const_iterator  i)
inlineinherited

Effects: Erases the element pointed to by i.

Complexity: Average case O(1), worst case O(this->size()).

Throws: Nothing.

Note: Invalidates the iterators (but not the references) to the erased element. No destructors are called.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::erase_and_dispose().

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase ( const_iterator  b,
const_iterator  e 
)
inlineinherited

Effects: Erases the range pointed to by b end e.

Complexity: Average case O(std::distance(b, e)), worst case O(this->size()).

Throws: Nothing.

Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::erase_and_dispose().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase ( const_reference  value)
inlineinherited

Effects: Erases all the elements with the given value.

Returns: The number of erased elements.

Complexity: Average case O(this->count(value)). Worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws. Basic guarantee.

Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::erase().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase ( const KeyType &  key,
KeyHasher  hash_func,
KeyValueEqual  equal_func 
)
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

"equal_func" must be a equality function that induces the same equality as key_equal. The difference is that "equal_func" compares an arbitrary key with the contained values.

Effects: Erases all the elements that have the same hash and compare equal with the given key.

Returns: The number of erased elements.

Complexity: Average case O(this->count(value)). Worst case O(this->size()).

Throws: If hash_func or equal_func throw. Basic guarantee.

Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::erase_and_dispose().

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase_and_dispose ( const_iterator  i,
Disposer  disposer 
)
inlineinherited

Requires: Disposer::operator()(pointer) shouldn't throw.

Effects: Erases the element pointed to by i. Disposer::operator()(pointer) is called for the removed element.

Complexity: Average case O(1), worst case O(this->size()).

Throws: Nothing.

Note: Invalidates the iterators to the erased elements.

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase_and_dispose ( const_iterator  b,
const_iterator  e,
Disposer  disposer 
)
inlineinherited

Requires: Disposer::operator()(pointer) shouldn't throw.

Effects: Erases the range pointed to by b end e. Disposer::operator()(pointer) is called for the removed elements.

Complexity: Average case O(std::distance(b, e)), worst case O(this->size()).

Throws: Nothing.

Note: Invalidates the iterators to the erased elements.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::bucket_count(), and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::end().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase_and_dispose ( const_reference  value,
Disposer  disposer 
)
inlineinherited

Requires: Disposer::operator()(pointer) shouldn't throw.

Effects: Erases all the elements with the given value. Disposer::operator()(pointer) is called for the removed elements.

Returns: The number of erased elements.

Complexity: Average case O(this->count(value)). Worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws. Basic guarantee.

Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::erase_and_dispose().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::erase_and_dispose ( const KeyType &  key,
KeyHasher  hash_func,
KeyValueEqual  equal_func,
Disposer  disposer 
)
inlineinherited

Requires: Disposer::operator()(pointer) shouldn't throw.

Effects: Erases all the elements with the given key. according to the comparison functor "equal_func". Disposer::operator()(pointer) is called for the removed elements.

Returns: The number of erased elements.

Complexity: Average case O(this->count(value)). Worst case O(this->size()).

Throws: If hash_func or equal_func throw. Basic guarantee.

Note: Invalidates the iterators to the erased elements.

References boost::it, boost::last, boost::n, and boost::sinks::event_log::success.

iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::find ( const_reference  value)
inlineinherited

Effects: Finds an iterator to the first element is equal to "value" or end() if that element does not exist.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::find().

iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::find ( const KeyType &  key,
KeyHasher  hash_func,
KeyValueEqual  equal_func 
)
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

"equal_func" must be a equality function that induces the same equality as key_equal. The difference is that "equal_func" compares an arbitrary key with the contained values.

Effects: Finds an iterator to the first element whose key is "key" according to the given hash and equality functor or end() if that element does not exist.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If hash_func or equal_func throw.

Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.

const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::find ( const_reference  value) const
inlineinherited

Effects: Finds a const_iterator to the first element whose key is "key" or end() if that element does not exist.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::find().

const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::find ( const KeyType &  key,
KeyHasher  hash_func,
KeyValueEqual  equal_func 
) const
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

"equal_func" must be a equality function that induces the same equality as key_equal. The difference is that "equal_func" compares an arbitrary key with the contained values.

Effects: Finds an iterator to the first element whose key is "key" according to the given hasher and equality functor or end() if that element does not exist.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If hash_func or equal_func throw.

Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.

References boost::hash_value.

hasher boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::hash_function ( ) const
inlineinherited

Effects: Returns the hasher object used by the unordered_set.

Complexity: Constant.

Throws: If hasher copy-constructor throws.

bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::incremental_rehash ( bool  grow = true)
inlineinherited

Requires:

Effects:

Complexity:

Throws:

Note: this method is only available if incremental<true> option is activated.

References boost::BOOST_STATIC_ASSERT(), boost::multiprecision::backends::i, and boost::last.

bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::incremental_rehash ( const bucket_traits new_bucket_traits)
inlineinherited

Effects: If new_bucket_traits.bucket_count() is not this->bucket_count()/2 or this->bucket_count()*2, or this->split_bucket() != new_bucket_traits.bucket_count() returns false and does nothing.

Otherwise, copy assigns new_bucket_traits to the internal bucket_traits and transfers all the objects from old buckets to the new ones.

Complexity: Linear to size().

Throws: Nothing

Note: this method is only available if incremental<true> option is activated.

References boost::BOOST_STATIC_ASSERT(), boost::n, and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::split_count().

template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
iterator boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::insert ( reference  value)
inline

Requires: value must be an lvalue

Effects: Inserts value into the unordered_multiset.

Returns: An iterator to the new inserted value.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws. Strong guarantee.

Note: Does not affect the validity of iterators and references. No copy-constructors are called.

template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
template<class Iterator >
void boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::insert ( Iterator  b,
Iterator  e 
)
inline

Requires: Dereferencing iterator must yield an lvalue of type value_type.

Effects: Equivalent to this->insert(t) for each element in [b, e).

Complexity: Average case is O(N), where N is the size of the range.

Throws: If the internal hasher or the equality functor throws. Basic guarantee.

Note: Does not affect the validity of iterators and references. No copy-constructors are called.

iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::insert_equal ( reference  value)
inlineinherited

Requires: value must be an lvalue

Effects: Inserts the value into the unordered_set.

Returns: An iterator to the inserted value.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws. Strong guarantee.

Note: Does not affect the validity of iterators and references. No copy-constructors are called.

References boost::hash_value.

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::insert_equal ( Iterator  b,
Iterator  e 
)
inlineinherited

Requires: Dereferencing iterator must yield an lvalue of type value_type.

Effects: Equivalent to this->insert_equal(t) for each element in [b, e).

Complexity: Average case O(N), where N is std::distance(b, e). Worst case O(N*this->size()).

Throws: If the internal hasher or the equality functor throws. Basic guarantee.

Note: Does not affect the validity of iterators and references. No copy-constructors are called.

References boost::asio::b, and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::insert_equal().

std::pair<iterator, bool> boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::insert_unique ( reference  value)
inlineinherited

Requires: value must be an lvalue

Effects: Tries to inserts value into the unordered_set.

Returns: If the value is not already present inserts it and returns a pair containing the iterator to the new value and true. If there is an equivalent value returns a pair containing an iterator to the already present value and false.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If the internal hasher or the equality functor throws. Strong guarantee.

Note: Does not affect the validity of iterators and references. No copy-constructors are called.

References boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::insert_unique_check(), and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::insert_unique_commit().

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::insert_unique ( Iterator  b,
Iterator  e 
)
inlineinherited

Requires: Dereferencing iterator must yield an lvalue of type value_type.

Effects: Equivalent to this->insert_unique(t) for each element in [b, e).

Complexity: Average case O(N), where N is std::distance(b, e). Worst case O(N*this->size()).

Throws: If the internal hasher or the equality functor throws. Basic guarantee.

Note: Does not affect the validity of iterators and references. No copy-constructors are called.

References boost::asio::b, and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::insert_unique().

std::pair<iterator, bool> boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::insert_unique_check ( const KeyType &  key,
KeyHasher  hash_func,
KeyValueEqual  equal_func,
insert_commit_data commit_data 
)
inlineinherited

Requires: "hash_func" must be a hash function that induces the same hash values as the stored hasher.

The difference is that "hash_func" hashes the given key instead of the value_type.

"equal_func" must be a equality function that induces the same equality as key_equal. The difference is that "equal_func" compares an arbitrary key with the contained values.

Effects: Checks if a value can be inserted in the unordered_set, using a user provided key instead of the value itself.

Returns: If there is an equivalent value returns a pair containing an iterator to the already present value and false. If the value can be inserted returns true in the returned pair boolean and fills "commit_data" that is meant to be used with the "insert_commit" function.

Complexity: Average case O(1), worst case O(this->size()).

Throws: If hash_func or equal_func throw. Strong guarantee.

Notes: This function is used to improve performance when constructing a value_type is expensive: if there is an equivalent value the constructed object must be discarded. Many times, the part of the node that is used to impose the hash or the equality is much cheaper to construct than the value_type and this function offers the possibility to use that the part to check if the insertion will be successful.

If the check is successful, the user can construct the value_type and use "insert_commit" to insert the object in constant-time.

"commit_data" remains valid for a subsequent "insert_commit" only if no more objects are inserted or erased from the unordered_set.

After a successful rehashing insert_commit_data remains valid.

References boost::sinks::event_log::success.

iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::insert_unique_commit ( reference  value,
const insert_commit_data commit_data 
)
inlineinherited

Requires: value must be an lvalue of type value_type.

commit_data must have been obtained from a previous call to "insert_check". No objects should have been inserted or erased from the unordered_set between the "insert_check" that filled "commit_data" and the call to "insert_commit".

Effects: Inserts the value in the unordered_set using the information obtained from the "commit_data" that a previous "insert_check" filled.

Returns: An iterator to the newly inserted object.

Complexity: Constant time.

Throws: Nothing.

Notes: This function has only sense if a "insert_check" has been previously executed to fill "commit_data". No value should be inserted or erased between the "insert_check" and "insert_commit" calls.

After a successful rehashing insert_commit_data remains valid.

References boost::n, boost::intrusive::pointer_traits< Ptr >::pointer_to(), and boost::geometry::unique().

iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::iterator_to ( reference  value)
inlineinherited

Requires: value must be an lvalue and shall be in a unordered_set of appropriate type.

Otherwise the behavior is undefined.

Effects: Returns: a valid iterator belonging to the unordered_set that points to the value

Complexity: Constant.

Throws: If the internal hash function throws.

const_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::iterator_to ( const_reference  value) const
inlineinherited

Requires: value must be an lvalue and shall be in a unordered_set of appropriate type.

Otherwise the behavior is undefined.

Effects: Returns: a valid const_iterator belonging to the unordered_set that points to the value

Complexity: Constant.

Throws: If the internal hash function throws.

References boost::intrusive::pointer_traits< Ptr >::const_cast_from().

key_equal boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::key_eq ( ) const
inlineinherited

Effects: Returns the key_equal object used by the unordered_set.

Complexity: Constant.

Throws: If key_equal copy-constructor throws.

local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::local_iterator_to ( reference  value)
inlineinherited

Requires: value must be an lvalue and shall be in a unordered_set of appropriate type.

Otherwise the behavior is undefined.

Effects: Returns: a valid local_iterator belonging to the unordered_set that points to the value

Complexity: Constant.

Throws: Nothing.

const_local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::local_iterator_to ( const_reference  value) const
inlineinherited

Requires: value must be an lvalue and shall be in a unordered_set of appropriate type.

Otherwise the behavior is undefined.

Effects: Returns: a valid const_local_iterator belonging to the unordered_set that points to the value

Complexity: Constant.

Throws: Nothing.

References boost::intrusive::pointer_traits< Ptr >::const_cast_from().

template<class ValueTraits , class Hash , class Equal , class SizeType , class BucketTraits , std::size_t BoolFlags>
unordered_multiset_impl& boost::intrusive::unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >::operator= ( BOOST_RV_REF(unordered_multiset_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags >)  x)
inline
void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::rehash ( const bucket_traits new_bucket_traits)
inlineinherited

Requires: new_bucket_traits can hold a pointer to a new bucket array or the same as the old bucket array with a different length.

new_size is the length of the the array pointed by new_buckets. If new_bucket_traits.bucket_begin() == this->bucket_pointer() new_bucket_traits.bucket_count() can be bigger or smaller than this->bucket_count(). 'new_bucket_traits' copy constructor should not throw.

Effects: Updates the internal reference with the new bucket, erases the values from the old bucket and inserts then in the new one. Bucket traits hold by *this is assigned from new_bucket_traits. If the container is configured as incremental<>, the split bucket is set to the new bucket_count().

If store_hash option is true, this method does not use the hash function.

Complexity: Average case linear in this->size(), worst case quadratic.

Throws: If the hasher functor throws. Basic guarantee.

References boost::hash_value, boost::multiprecision::backends::i, boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::incremental, boost::last, and boost::n.

static local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::s_local_iterator_to ( reference  value)
inlinestaticinherited

Requires: value must be an lvalue and shall be in a unordered_set of appropriate type.

Otherwise the behavior is undefined.

Effects: Returns: a valid local_iterator belonging to the unordered_set that points to the value

Complexity: Constant.

Throws: Nothing.

Note: This static function is available only if the value traits is stateless.

References boost::BOOST_STATIC_ASSERT().

static const_local_iterator boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::s_local_iterator_to ( const_reference  value)
inlinestaticinherited

Requires: value must be an lvalue and shall be in a unordered_set of appropriate type.

Otherwise the behavior is undefined.

Effects: Returns: a valid const_local_iterator belonging to the unordered_set that points to the value

Complexity: Constant.

Throws: Nothing.

Note: This static function is available only if the value traits is stateless.

References boost::BOOST_STATIC_ASSERT(), and boost::intrusive::pointer_traits< Ptr >::const_cast_from().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::size ( void  ) const
inlineinherited

Effects: Returns the number of elements stored in the unordered_set.

Complexity: Linear to elements contained in *this if constant_time_size is false. Constant-time otherwise.

Throws: Nothing.

References boost::asio::b, boost::python::len(), boost::n, and boost::interprocess::to_raw_pointer().

size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::split_count ( ) const
inlineinherited

Requires:

Effects:

Complexity:

Throws:

References boost::BOOST_STATIC_ASSERT().

static size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::suggested_lower_bucket_count ( size_type  n)
inlinestaticinherited

Effects: Returns the nearest new bucket count optimized for the container that is smaller or equal than n.

This suggestion can be used to create bucket arrays with a size that will usually improve container's performance. If such value does not exist, the lowest possible value is returned.

Complexity: Amortized constant time.

Throws: Nothing.

References boost::numeric::ublas::detail::upper_bound().

static size_type boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::suggested_upper_bucket_count ( size_type  n)
inlinestaticinherited

Effects: Returns the nearest new bucket count optimized for the container that is bigger or equal than n.

This suggestion can be used to create bucket arrays with a size that will usually improve container's performance. If such value does not exist, the higher possible value is returned.

Complexity: Amortized constant time.

Throws: Nothing.

References boost::numeric::ublas::detail::lower_bound().

void boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::swap ( hashtable_impl< ValueTraits, Hash, Equal, SizeType, BucketTraits, BoolFlags > &  other)
inlineinherited

Requires: the hasher and the equality function unqualified swap call should not throw.

Effects: Swaps the contents of two unordered_sets. Swaps also the contained bucket array and equality and hasher functors.

Complexity: Constant.

Throws: If the swap() call for the comparison or hash functors found using ADL throw. Basic guarantee.

References boost::swap, and boost::intrusive::hashtable_impl< ValueTraits, VoidOrKeyHash, VoidOrKeyEqual, SizeType, BucketTraits, BoolFlags >::swap().

Member Data Documentation

const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::cache_begin
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::compare_hash
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::constant_time_size
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::incremental
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::optimize_multikey
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::power_2_buckets
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::stateful_value_traits
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::store_hash
staticinherited
const bool boost::intrusive::hashtable_impl< ValueTraits, Hash , Equal , SizeType, BucketTraits, BoolFlags >::unique_keys
staticinherited

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