rw_hashset< T, Hash, EQ, A > Class Template Reference

Maintains a collection of some type A, in which there cannot be more than one occurrence of some given instance of A. More...

#include <rw/stdex/hashset.h>

Public Types
typedef A	allocator_type
typedef impl_type::const_iterator	const_iterator
typedef impl_type::const_pointer	const_pointer
typedef impl_type::const_reference	const_reference
typedef impl_type::difference_type	difference_type
typedef Hash	hasher
typedef impl_type::const_iterator	iterator
typedef EQ	key_equal_type
typedef Hash	key_hash_type
typedef T	key_type
typedef impl_type::pointer	pointer
typedef impl_type::const_reference	reference
typedef impl_type::size_type	size_type
typedef T	value_type

Public Member Functions
template<typename InputIterator >
	rw_hashset (InputIterator first, InputIterator last, size_type sz=64, const hasher &h=hasher(), const key_equal_type &eq=key_equal_type())
	rw_hashset (size_type sz=64, const hasher &h=hasher(), const key_equal_type &eq=key_equal_type())
	rw_hashset (const rw_hashset< T, Hash, EQ, A > &set)
	rw_hashset (rw_hashset< T, Hash, EQ, A > &&set)
	~rw_hashset ()
iterator	begin ()
const_iterator	begin () const
	More...
size_type	capacity () const
const_iterator	cbegin () const
	More...
const_iterator	cend () const
	More...
void	clear ()
size_type	count (const_reference key) const
bool	empty () const
iterator	end ()
const_iterator	end () const
	More...
std::pair< iterator, iterator >	equal_range (const_reference key) const
size_type	erase (const_reference key)
iterator	erase (iterator iter)
iterator	erase (iterator first, iterator bound)
float	fill_ratio () const
iterator	find (const_reference key) const
std::pair< iterator, bool >	insert (const_reference val)
std::pair< iterator, bool >	insert (value_type &&val)
	More...
size_type	insert (const value_type *first, const value_type *bound)
template<typename InputIterator >
size_type	insert (InputIterator first, InputIterator last)
iterator	lower_bound (const_reference key) const
rw_hashset< T, Hash, EQ, A > &	operator= (const rw_hashset< T, Hash, EQ, A > &rhs)
rw_hashset< T, Hash, EQ, A > &	operator= (rw_hashset< T, Hash, EQ, A > &&rhs)
void	resize (size_type sz)
size_type	size () const
void	swap (rw_hashset< T, Hash, EQ, A > &other)
iterator	upper_bound (const_reference key) const

Related Functions
(Note that these are not member functions.)
template<class T , class Hash , class EQ , class A >
bool	operator!= (const rw_hashset< T, Hash, EQ, A > &lhs, const rw_hashset< T, Hash, EQ, A > &rhs)
template<class T , class Hash , class EQ , class A >
bool	operator== (const rw_hashset< T, Hash, EQ, A > &lhs, const rw_hashset< T, Hash, EQ, A > &rhs)

Detailed Description

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>
class rw_hashset< T, Hash, EQ, A >

Class rw_hashset<T,Hash,EQ,A> maintains a collection of T, implemented as a hash table in which there may not be more than one instance of any given T. Since this is a value-based collection, objects are copied into and out of the collection. As with all classes that meet the ANSI associative container specification, rw_hashset<T,Hash,EQ,A> provides for iterators that reference its elements. Operations that alter the contents of rw_hashset<T,Hash,EQ,A> may invalidate other iterators that reference the container. Since the contents of rw_hashset<T,Hash,EQ,A> are in pseudo-random order, the only iterator ranges that will usually make sense are the results of calling equal_range(), and the entire range from begin() to end().

Hash must provide a const function that takes a single argument convertible to type T and returns a value of type size_t.

Note

Any two elements that are equivalent must hash to the same value.

Element equality is determined by an equality function of type EQ, which takes two arguments convertible to type T and returns a value of type bool.

Note

Any two elements that are equivalent are disallowed for this container.

Synopsis

#include <rw/stdex/hashset.h>
rw_hashset<T,Hash,EQ,A=std::allocator<T> >;

Persistence

None

Member Typedef Documentation

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef A rw_hashset< T, Hash, EQ, A >::allocator_type

A type representing the allocator type for the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::const_iterator rw_hashset< T, Hash, EQ, A >::const_iterator

A type that provides a const forward iterator over the elements in the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::const_pointer rw_hashset< T, Hash, EQ, A >::const_pointer

A type that provides a const pointer to an element in the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::const_reference rw_hashset< T, Hash, EQ, A >::const_reference

A type that provides a const reference to an element in the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::difference_type rw_hashset< T, Hash, EQ, A >::difference_type

A signed integral type used to indicate the distance between two valid iterators on the same container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef Hash rw_hashset< T, Hash, EQ, A >::hasher

A type representing the hash function.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::const_iterator rw_hashset< T, Hash, EQ, A >::iterator

A type that provides a forward iterator over the elements in the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef EQ rw_hashset< T, Hash, EQ, A >::key_equal_type

A type representing the equality function.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef Hash rw_hashset< T, Hash, EQ, A >::key_hash_type

Deprecated:

As of SourcePro 12.5, use hasher instead.

A type representing the hash function.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef T rw_hashset< T, Hash, EQ, A >::key_type

A type representing the key of the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::pointer rw_hashset< T, Hash, EQ, A >::pointer

A type that provides a pointer to an element in the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::const_reference rw_hashset< T, Hash, EQ, A >::reference

A type that provides a reference to an element in the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef impl_type::size_type rw_hashset< T, Hash, EQ, A >::size_type

An unsigned integral type used for counting the number of elements in the container.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef T rw_hashset< T, Hash, EQ, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

template<typename InputIterator >

rw_hashset< T, Hash, EQ, A >::rw_hashset	(	InputIterator	first,
		InputIterator	last,
		size_type	sz = 64,
		const hasher &	h = hasher(),
		const key_equal_type &	eq = key_equal_type()
	)

Constructs an rw_hashset<T,Hash,EQ,A> containing a copy of the elements in the range [first, last). The rw_hashset instance has sz slots, uses h as its hash object, and eq as its equality comparator.

InputIterator is an input iterator type where the iterator points to elements that are convertible to value_type objects.

Note

If the value specified for sz is zero, the default number of slots is used.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

rw_hashset< T, Hash, EQ, A >::rw_hashset ( size_type  sz = 64, const hasher &  h = hasher(), const key_equal_type &  eq = key_equal_type()  )

inline

Constructs an empty rw_hashset<T,Hash,EQ,A> with sz slots, using h as the hash object, and eq as the equality comparator.

Note

If the value specified for sz is zero, the default number of slots is used.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

rw_hashset< T, Hash, EQ, A >::rw_hashset ( const rw_hashset< T, Hash, EQ, A > &  set )

inline

Constructs an rw_hashset<T,Hash,EQ,A> that is a copy of set. Each element from set is copied into self.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

rw_hashset< T, Hash, EQ, A >::rw_hashset ( rw_hashset< T, Hash, EQ, A > &&  set )

inline

Move constructor. The constructed list takes ownership of the data owned by set.

Condition:

This method is only available on platforms with rvalue reference support.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

rw_hashset< T, Hash, EQ, A >::~rw_hashset ( )

inline

The destructor releases the memory used by the container's implementation.

Member Function Documentation

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

iterator rw_hashset< T, Hash, EQ, A >::begin ( )

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

const_iterator rw_hashset< T, Hash, EQ, A >::begin ( ) const

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

size_type rw_hashset< T, Hash, EQ, A >::capacity ( ) const

inline

Returns the number of slots in the hash table that self uses.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

const_iterator rw_hashset< T, Hash, EQ, A >::cbegin ( ) const

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

const_iterator rw_hashset< T, Hash, EQ, A >::cend ( ) const

inline

Returns an iterator referring to the element after the last element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

void rw_hashset< T, Hash, EQ, A >::clear ( )

inline

A synonym for erase(begin(),end()) .

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

size_type rw_hashset< T, Hash, EQ, A >::count ( const_reference  key ) const

inline

Returns 1 if self contains key, else 0.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

bool rw_hashset< T, Hash, EQ, A >::empty ( ) const

inline

Returns true if self is empty.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

iterator rw_hashset< T, Hash, EQ, A >::end ( )

inline

Returns an iterator referring to the element after the last element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

const_iterator rw_hashset< T, Hash, EQ, A >::end ( ) const

inline

Returns an iterator referring to the element after the last element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

std::pair<iterator, iterator> rw_hashset< T, Hash, EQ, A >::equal_range ( const_reference  key ) const

inline

Returns std::pair<iterator,iterator>(lower_bound(key), upper_bound(key)). Upper and lower bound have special meaning for hash-based collections. See discussion elsewhere.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

size_type rw_hashset< T, Hash, EQ, A >::erase ( const_reference  key )

inline

If there is an item EQ to key, it is removed, and 1 is returned. Otherwise, 0 is returned.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

iterator rw_hashset< T, Hash, EQ, A >::erase ( iterator  iter )

inline

Removes the element referenced by iter and returns an iterator referencing the next element. If iter does not reference an item in self, the result is undefined.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

iterator rw_hashset< T, Hash, EQ, A >::erase ( iterator  first, iterator  bound  )

inline

Removes each element in the range which begins with first and is bounded by bound. Returns an iterator referencing bound. If first does not reference an item in self (and if first and bound are not equal), the effect is undefined.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

float rw_hashset< T, Hash, EQ, A >::fill_ratio ( ) const

inline

Returns the result of calculating size() / capacity().

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

iterator rw_hashset< T, Hash, EQ, A >::find ( const_reference  key ) const

inline

Returns an iterator referencing key if it is contained in self, else returns end().

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

std::pair<iterator, bool> rw_hashset< T, Hash, EQ, A >::insert ( const_reference  val )

inline

If there is no item in self EQ to val, inserts val, returning a pair with an iterator referencing the new element and true. Otherwise, returns a pair with an iterator referencing the matching value_type and false.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

std::pair<iterator, bool> rw_hashset< T, Hash, EQ, A >::insert ( value_type &&  val )

inline

If there is no item in self EQ to val, inserts val, returning a pair with an iterator referencing the new element and true. Otherwise, returns a pair with an iterator referencing the matching value_type and false.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

size_type rw_hashset< T, Hash, EQ, A >::insert ( const value_type *  first, const value_type *  bound  )

inline

For each element in the range beginning with first and bounded by bound, if there is no item in self EQ to that element, the element is copied into self; or if there is such an element, it is skipped. Returns the number of elements inserted.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

template<typename InputIterator >

size_type rw_hashset< T, Hash, EQ, A >::insert ( InputIterator  first, InputIterator  last  )

inline

For each element in the range [first, last), inserts a copy of the element into self. If an equivalent element (according to EQ) already exists in self, the insertion is skipped. Returns the number of elements inserted.

InputIterator is an input iterator type where the iterator points to elements that are convertible to value_type objects.

Note

first and last must not be iterators into self.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

iterator rw_hashset< T, Hash, EQ, A >::lower_bound ( const_reference  key ) const

inline

Returns the lower bound of key in self. This has a special meaning for hash-based collections. See discussion elsewhere.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

rw_hashset<T, Hash, EQ, A>& rw_hashset< T, Hash, EQ, A >::operator= ( const rw_hashset< T, Hash, EQ, A > &  rhs )

inline

Sets self to have the same capacity, Hash and EQ as rhs removes all self's current contents, and replaces them with copies of the elements in rhs.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

rw_hashset<T, Hash, EQ, A>& rw_hashset< T, Hash, EQ, A >::operator= ( rw_hashset< T, Hash, EQ, A > &&  rhs )

inline

Move assignment. Self takes ownership of the data owned by rhs.

Condition:

This method is only available on platforms with rvalue reference support.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

void rw_hashset< T, Hash, EQ, A >::resize ( size_type  sz )

inline

Resizes self's hash table to have sz slots; and re-hashes all self's elements into the new table. Can be very expensive if self holds many elements.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

size_type rw_hashset< T, Hash, EQ, A >::size ( ) const

inline

Returns the number of items currently held in self.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

void rw_hashset< T, Hash, EQ, A >::swap ( rw_hashset< T, Hash, EQ, A > &  other )

inline

Exchanges the contents of self with other, including the Hash and EQ objects. This method does not copy or destroy any of the items exchanged but exchanges the underlying hash tables.

template<class T, class Hash = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

iterator rw_hashset< T, Hash, EQ, A >::upper_bound ( const_reference  key ) const

inline

Returns the upper bound of key in self. This has a special meaning for hash-based collections. See discussion elsewhere.

Friends And Related Function Documentation

template<class T , class Hash , class EQ , class A >

bool operator!= ( const rw_hashset< T, Hash, EQ, A > &  lhs, const rw_hashset< T, Hash, EQ, A > &  rhs  )

related

Equivalent to !(lhs == rhs).

template<class T , class Hash , class EQ , class A >

bool operator== ( const rw_hashset< T, Hash, EQ, A > &  lhs, const rw_hashset< T, Hash, EQ, A > &  rhs  )

related

Returns true if lhs and rhs have the same number of elements, and for each item in lhs there is an item in rhs which tests EQ.