Maintains a hash-based collection of class T elements, in which there cannot be more than one occurrence of equivalent element instances and the key insertion order is preserved. More...

#include <rw/tools/tvordhset.h>

Public Types
typedef container_type::allocator_type	allocator_type

typedef container_type::const_iterator	const_iterator

typedef container_type::const_pointer	const_pointer

typedef container_type::const_reference	const_reference

typedef rw_orderedhashset< T, H, EQ, A >	container_type

typedef container_type::difference_type	difference_type

typedef container_type::hasher	hasher

typedef container_type::iterator	iterator

typedef container_type::key_equal_type	key_equal

typedef container_type::key_type	key_type

typedef container_type::pointer	pointer

typedef container_type::reference	reference

typedef container_type::size_type	size_type

typedef container_type::value_type	value_type

Public Member Functions
	RWTValOrderedHashSet (size_type sz=64, const hasher &h=hasher(), const key_equal &eq=key_equal())

	RWTValOrderedHashSet (const container_type &s)

	RWTValOrderedHashSet (const RWTValOrderedHashSet< T, H, EQ, A > &rws)

	RWTValOrderedHashSet (RWTValOrderedHashSet< T, H, EQ, A > &&rws)

	RWTValOrderedHashSet (container_type &&rws)

template<typename InputIterator >
	RWTValOrderedHashSet (InputIterator first, InputIterator last, size_type sz=64, const hasher &h=hasher(), const key_equal &eq=key_equal())

	RWTValOrderedHashSet (const hasher &h, size_type sz=64)

void	apply (void(fn)(const_reference, void ), void *d) const

iterator	begin ()

const_iterator	begin () const

size_type	capacity () const

const_iterator	cbegin () const

const_iterator	cend () const

void	clear ()

bool	contains (bool(fn)(const_reference, void ), void *d) const

bool	contains (const_reference a) const

RWTValOrderedHashSet< T, H, EQ, A > &	difference (const RWTValOrderedHashSet< T, H, EQ, A > &s)

RWTValOrderedHashSet< T, H, EQ, A > &	difference (const rw_orderedhashset< T, H, EQ, A > &s)

iterator	end ()

const_iterator	end () const

size_type	entries () const

iterator	erase (iterator pos)

iterator	erase (iterator first, iterator last)

float	fillRatio () const

bool	find (bool(fn)(const_reference, void ), void *d, value_type &k) const

bool	find (const_reference a, value_type &k) const

bool	insert (const_reference datum)

iterator	insert (iterator hint, const_reference val)

template<typename InputIterator >
void	insert (InputIterator first, InputIterator last)

bool	insert (value_type &&datum)

iterator	insert (iterator hint, value_type &&val)

RWTValOrderedHashSet< T, H, EQ, A > &	intersection (const RWTValOrderedHashSet< T, H, EQ, A > &rhs)

RWTValOrderedHashSet< T, H, EQ, A > &	intersection (const rw_orderedhashset< T, H, EQ, A > &rhs)

bool	isEmpty () const

bool	isEquivalent (const RWTValOrderedHashSet< T, H, EQ, A > &s) const

bool	isProperSubsetOf (const RWTValOrderedHashSet< T, H, EQ, A > &s) const

bool	isSubsetOf (const RWTValOrderedHashSet< T, H, EQ, A > &s) const

size_type	occurrencesOf (bool(fn)(const_reference, void ), void *d) const

size_type	occurrencesOf (const_reference a) const

RWTValOrderedHashSet< T, H, EQ, A > &	operator= (const RWTValOrderedHashSet< T, H, EQ, A > &rhs)

RWTValOrderedHashSet< T, H, EQ, A > &	operator= (const container_type &rhs)

RWTValOrderedHashSet< T, H, EQ, A > &	operator= (RWTValOrderedHashSet< T, H, EQ, A > &&rhs)

RWTValOrderedHashSet< T, H, EQ, A > &	operator= (container_type &&rhs)

bool	remove (bool(fn)(const_reference, void ), void *d)

bool	remove (const_reference a)

size_type	removeAll (bool(fn)(const_reference, void ), void *d)

size_type	removeAll (const_reference a)

void	resize (size_type sz)

container_type &	std ()

const container_type &	std () const

void	swap (RWTValOrderedHashSet< T, H, EQ, A > &other)

RWTValOrderedHashSet< T, H, EQ, A > &	symmetricDifference (const RWTValOrderedHashSet< T, H, EQ, A > &rhs)

RWTValOrderedHashSet< T, H, EQ, A > &	symmetricDifference (const rw_orderedhashset< T, H, EQ, A > &rhs)

RWTValOrderedHashSet< T, H, EQ, A > &	Union (const RWTValOrderedHashSet< T, H, EQ, A > &rhs)

RWTValOrderedHashSet< T, H, EQ, A > &	Union (const rw_orderedhashset< T, H, EQ, A > &rhs)

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

template<class T , class H , class EQ , class A >
bool	operator!= (const RWTValOrderedHashSet< T, H, EQ, A > &lhs, const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &rhs)

template<class T , class H , class EQ , class A >
bool	operator!= (const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashSet< T, H, EQ, A > &rhs)

template<class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTValOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &file, const RWTValOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
bool	operator== (const RWTValOrderedHashSet< T, H, EQ, A > &lhs, const RWTValOrderedHashSet< T, H, EQ, A > &rhs)

template<class T , class H , class EQ , class A >
bool	operator== (const RWTValOrderedHashSet< T, H, EQ, A > &lhs, const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &rhs)

template<class T , class H , class EQ , class A >
bool	operator== (const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashSet< T, H, EQ, A > &rhs)

template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTValOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValOrderedHashSet< T, H, EQ, A > *&p)

template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTValOrderedHashSet< T, H, EQ, A > *&p)

Detailed Description

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

RWTValOrderedHashSet maintains a collection of class T elements, which are stored according to a hash object of type H. RWTValOrderedHashSet preserves the key insertion order.

Class A is an allocator of objects of class T. For more information about using custom allocators, please see the Essential Tools Module User's Guide.

H 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.

The value type must have operator==() defined. This requirement is imposed by the C++ Standard Library.

Synopsis: #include <rw/tools/tvordhset.h>

RWTValOrderedHashSet<T,H,EQ,A> s;

See also

Class RWTValHashMultiSet offers the same interface to a collection that does accept multiple items that compare equal to each other.

Class rw_orderedhashset<T,H,EQ,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.

Persistence: Isomorphic

Member Typedef Documentation

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

typedef container_type::allocator_type RWTValOrderedHashSet< T, H, EQ, A >::allocator_type

A type representing the allocator type for the container.

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

typedef container_type::const_iterator RWTValOrderedHashSet< T, H, EQ, A >::const_iterator

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

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

typedef container_type::const_pointer RWTValOrderedHashSet< T, H, EQ, A >::const_pointer

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

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

typedef container_type::const_reference RWTValOrderedHashSet< T, H, EQ, A >::const_reference

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

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

typedef rw_orderedhashset<T, H, EQ, A> RWTValOrderedHashSet< T, H, EQ, A >::container_type

A type representing the underlying implementation container.

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

typedef container_type::difference_type RWTValOrderedHashSet< T, H, 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 H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

typedef container_type::hasher RWTValOrderedHashSet< T, H, EQ, A >::hasher

A type representing the hash function.

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

typedef container_type::iterator RWTValOrderedHashSet< T, H, EQ, A >::iterator

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

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

typedef container_type::key_equal_type RWTValOrderedHashSet< T, H, EQ, A >::key_equal

A type representing the equality function.

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

typedef container_type::key_type RWTValOrderedHashSet< T, H, EQ, A >::key_type

A type representing the key of the container.

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

typedef container_type::pointer RWTValOrderedHashSet< T, H, EQ, A >::pointer

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

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

typedef container_type::reference RWTValOrderedHashSet< T, H, EQ, A >::reference

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

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

typedef container_type::size_type RWTValOrderedHashSet< T, H, EQ, A >::size_type

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

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

typedef container_type::value_type RWTValOrderedHashSet< T, H, EQ, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

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

RWTValOrderedHashSet< T, H, EQ, A >::RWTValOrderedHashSet	(	size_type	sz = `64`,
		const hasher &	h = `hasher()`,
		const key_equal &	eq = `key_equal()`
	)

inline

Constructs an empty set. The underlying hash table representation has sz buckets, uses h for its hashing function, and uses eq to determine equality between elements.

Note: If the value specified for sz is zero, the default bucket count is used.

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

RWTValOrderedHashSet< T, H, EQ, A >::RWTValOrderedHashSet ( const container_type & s )

inline

Constructs a set by copying all elements of s.

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

RWTValOrderedHashSet< T, H, EQ, A >::RWTValOrderedHashSet ( const RWTValOrderedHashSet< T, H, EQ, A > & rws )

inline

Copy constructor.

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

RWTValOrderedHashSet< T, H, EQ, A >::RWTValOrderedHashSet ( RWTValOrderedHashSet< T, H, EQ, A > && rws )

inline

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

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

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

RWTValOrderedHashSet< T, H, EQ, A >::RWTValOrderedHashSet ( container_type && rws )

inline

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

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

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

template<typename InputIterator >

RWTValOrderedHashSet< T, H, EQ, A >::RWTValOrderedHashSet	(	InputIterator	first,
		InputIterator	last,
		size_type	sz = `64`,
		const hasher &	h = `hasher()`,
		const key_equal &	eq = `key_equal()`
	)

inline

Constructs a set by copying elements from the range [first, last). The underlying hash table representation has sz buckets, uses h for its hashing function, and uses eq to determine equality between elements.

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

Note: If the value specified for sz is zero, the default bucket count is used.

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

RWTValOrderedHashSet< T, H, EQ, A >::RWTValOrderedHashSet	(	const hasher &	h,
		size_type	sz = `64`
	)

inline

Creates an empty set that uses the hash object h and has an initial hash table capacity of sz.

Note: If the value specified for sz is zero, the default capacity is used.

Member Function Documentation

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

void RWTValOrderedHashSet< T, H, EQ, A >::apply	(	void()(const_reference, void )	fn,
		void *	d
	)		const

inline

Invokes the function pointer fn on each item in the collection. Client data may be passed through parameter d.

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

iterator RWTValOrderedHashSet< T, H, 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 H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

const_iterator RWTValOrderedHashSet< T, H, 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 H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

size_type RWTValOrderedHashSet< T, H, EQ, A >::capacity ( ) const

inline

Returns the number of buckets (slots) available in the underlying hash representation. See resize().

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

const_iterator RWTValOrderedHashSet< T, H, 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 H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

const_iterator RWTValOrderedHashSet< T, H, 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 H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

void RWTValOrderedHashSet< T, H, EQ, A >::clear ( void )

inline

Clears the collection by removing all items from self. Each item has its destructor called.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::contains	(	bool()(const_reference, void )	fn,
		void *	d
	)		const

inline

Returns true if there exists an element t in self such that the expression ((*fn)(t,d)) is true, otherwise returns false. Client data may be passed through parameter d.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::contains ( const_reference a ) const

inline

Returns true if there exists an element t in self that compares equal to a, otherwise returns false.

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::difference ( const RWTValOrderedHashSet< T, H, EQ, A > & s )

inline

Sets self to the set-theoretic difference given by (self - s).

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

RWTValOrderedHashSet< T, H, EQ, A > & RWTValOrderedHashSet< T, H, EQ, A >::difference ( const rw_orderedhashset< T, H, EQ, A > & s )

Sets self to the set-theoretic difference given by (self - s).

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

iterator RWTValOrderedHashSet< T, H, 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 H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

const_iterator RWTValOrderedHashSet< T, H, 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 H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

size_type RWTValOrderedHashSet< T, H, EQ, A >::entries ( void ) const

inline

Returns the number of elements in self.

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

iterator RWTValOrderedHashSet< T, H, EQ, A >::erase ( iterator pos )

inline

Removes the item pointed to by pos from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.

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

iterator RWTValOrderedHashSet< T, H, EQ, A >::erase	(	iterator	first,
		iterator	last
	)

inline

Removes the items in the range [first, last) from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.

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

float RWTValOrderedHashSet< T, H, EQ, A >::fillRatio ( ) const

inline

Returns the ratio entries() / capacity().

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

bool RWTValOrderedHashSet< T, H, EQ, A >::find	(	bool()(const_reference, void )	fn,
		void *	d,
		value_type &	k
	)		const

inline

If there exists an element t in self such that the expression ((*fn)(t,d)) is true, assigns t to k and returns true. Otherwise, returns false and leaves the value of k unchanged. Client data may be passed through parameter d.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::find	(	const_reference	a,
		value_type &	k
	)		const

inline

If there exists an element t in self that compares equal to a, assigns t to k and returns true. Otherwise, returns false and leaves the value of k unchanged.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::insert ( const_reference datum )

inline

Adds the item a to the collection. Returns true if the insertion is successful, otherwise returns false. The function returns true unless the collection already holds an element with the equivalent key.

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

iterator RWTValOrderedHashSet< T, H, EQ, A >::insert	(	iterator	hint,
		const_reference	val
	)

inline

Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and returns an iterator to the new item.

The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value is inserted at a different location according to the container's hash object.

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

template<typename InputIterator >

void RWTValOrderedHashSet< T, H, EQ, A >::insert	(	InputIterator	first,
		InputIterator	last
	)

inline

Inserts the elements in the range [first, last) into self. If the element is already present in the collection, it will be ignored.

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

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

bool RWTValOrderedHashSet< T, H, EQ, A >::insert ( value_type && datum )

inline

Adds the item a to the collection. Returns true if the insertion is successful, otherwise returns false. The function returns true unless the collection already holds an element with the equivalent key.

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

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

iterator RWTValOrderedHashSet< T, H, EQ, A >::insert	(	iterator	hint,
		value_type &&	val
	)

inline

Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and returns an iterator to the new item.

The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value is inserted at a different location according to the container's hash object.

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

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::intersection ( const RWTValOrderedHashSet< T, H, EQ, A > & rhs )

inline

Destructively performs a set-theoretic intersection of self and rhs, replacing the contents of self with the result.

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

RWTValOrderedHashSet< T, H, EQ, A > & RWTValOrderedHashSet< T, H, EQ, A >::intersection ( const rw_orderedhashset< T, H, EQ, A > & rhs )

Destructively performs a set-theoretic intersection of self and rhs, replacing the contents of self with the result.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::isEmpty ( ) const

inline

Returns true if there are no items in the collection, otherwise returns false.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::isEquivalent ( const RWTValOrderedHashSet< T, H, EQ, A > & s ) const

inline

Returns true if self and s are identical, otherwise returns false.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::isProperSubsetOf ( const RWTValOrderedHashSet< T, H, EQ, A > & s ) const

inline

Returns true if self is a proper subset of s, otherwise returns false.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::isSubsetOf ( const RWTValOrderedHashSet< T, H, EQ, A > & s ) const

inline

Returns true if self is a subset of s or if self is set equivalent to s, otherwise returns false.

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

size_type RWTValOrderedHashSet< T, H, EQ, A >::occurrencesOf	(	bool()(const_reference, void )	fn,
		void *	d
	)		const

inline

Returns the number of elements t in self such that the expression ((*fn)(t,d)) is true. Client data may be passed through parameter d.

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

size_type RWTValOrderedHashSet< T, H, EQ, A >::occurrencesOf ( const_reference a ) const

inline

Returns the number of elements t in self that compare equal to a.

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::operator= ( const RWTValOrderedHashSet< T, H, EQ, A > & rhs )

inline

Destroys all elements of self and replaces them by copying all elements of rhs.

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::operator= ( const container_type & rhs )

inline

Destroys all elements of self and replaces them by copying all elements of rhs.

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::operator= ( RWTValOrderedHashSet< T, H, EQ, A > && rhs )

inline

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

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

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::operator= ( container_type && rhs )

inline

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

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

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

bool RWTValOrderedHashSet< T, H, EQ, A >::remove	(	bool()(const_reference, void )	fn,
		void *	d
	)

inline

Removes the first element t in self such that the expression ((*fn)(t,d)) is true, and returns true. Returns false if there is no such element. Client data may be passed through parameter d.

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

bool RWTValOrderedHashSet< T, H, EQ, A >::remove ( const_reference a )

inline

Removes the first element t in self that compares equal to a and returns true. Returns false if there is no such element.

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

RWTValOrderedHashSet< T, H, EQ, A >::size_type RWTValOrderedHashSet< T, H, EQ, A >::removeAll	(	bool()(const_reference, void )	fn,
		void *	d
	)

Removes all elements t in self such that the expression ((*fn)(t,d)) is true. Returns the number of items removed. Client data may be passed through parameter d.

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

size_type RWTValOrderedHashSet< T, H, EQ, A >::removeAll ( const_reference a )

inline

Removes all elements t in self that compare equal to a. Returns the number of items removed.

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

void RWTValOrderedHashSet< T, H, EQ, A >::resize ( size_type sz )

inline

Changes the capacity of self by creating a new set with a capacity of sz. resize() copies every element of self into the new container and finally swaps the internal representation of the new container with the internal representation of self.

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

container_type& RWTValOrderedHashSet< T, H, EQ, A >::std ( )

inline

Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of C++ Standard Library collections.

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

const container_type& RWTValOrderedHashSet< T, H, EQ, A >::std ( ) const

inline

Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of C++ Standard Library collections.

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

void RWTValOrderedHashSet< T, H, EQ, A >::swap ( RWTValOrderedHashSet< T, H, EQ, A > & other )

inline

Swaps the data held by self with the data held by other, including the H and EQ objects. This method does not copy or destroy any of the items swapped; rather, it swaps the underlying hash tables.

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::symmetricDifference ( const RWTValOrderedHashSet< T, H, EQ, A > & rhs )

inline

Destructively performs a set-theoretic symmetric difference operation on self and s. Self is replaced by the result. A symmetric difference can be defined as \( (A \cup B) \setminus (A \cap B) \).

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

RWTValOrderedHashSet< T, H, EQ, A > & RWTValOrderedHashSet< T, H, EQ, A >::symmetricDifference ( const rw_orderedhashset< T, H, EQ, A > & rhs )

Destructively performs a set-theoretic symmetric difference operation on self and s. Self is replaced by the result. A symmetric difference can be defined as \( (A \cup B) \setminus (A \cap B) \).

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

RWTValOrderedHashSet<T, H, EQ, A>& RWTValOrderedHashSet< T, H, EQ, A >::Union ( const RWTValOrderedHashSet< T, H, EQ, A > & rhs )

inline

Destructively performs a set-theoretic union operation on self and s. Self is replaced by the result. Note the use of the uppercase 'U' in Union to avoid conflict with the C++ reserved word.

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

RWTValOrderedHashSet< T, H, EQ, A > & RWTValOrderedHashSet< T, H, EQ, A >::Union ( const rw_orderedhashset< T, H, EQ, A > & rhs )

Destructively performs a set-theoretic union operation on self and s. Self is replaced by the result. Note the use of the uppercase 'U' in Union to avoid conflict with the C++ reserved word.

Friends And Related Function Documentation

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

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

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

bool operator!=	(	const RWTValOrderedHashSet< T, H, EQ, A > &	lhs,
		const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &	rhs
	)

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

bool operator!=	(	const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &	lhs,
		const RWTValOrderedHashSet< T, H, EQ, A > &	rhs
	)

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

RWvostream & operator<<	(	RWvostream &	strm,
		const RWTValOrderedHashSet< T, H, EQ, A > &	coll
	)

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

RWFile & operator<<	(	RWFile &	file,
		const RWTValOrderedHashSet< T, H, EQ, A > &	coll
	)

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

bool operator==	(	const RWTValOrderedHashSet< T, H, EQ, A > &	lhs,
		const RWTValOrderedHashSet< T, H, EQ, A > &	rhs
	)

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual elements that compare equal to each other.

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

bool operator==	(	const RWTValOrderedHashSet< T, H, EQ, A > &	lhs,
		const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &	rhs
	)

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual elements that compare equal to each other.

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

bool operator==	(	const typename RWTValOrderedHashSet< T, H, EQ, A >::container_type &	lhs,
		const RWTValOrderedHashSet< T, H, EQ, A > &	rhs
	)

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual elements that compare equal to each other.

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

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValOrderedHashSet< T, H, EQ, A > &	coll
	)

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

RWFile & operator>>	(	RWFile &	file,
		RWTValOrderedHashSet< T, H, EQ, A > &	coll
	)

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

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValOrderedHashSet< T, H, EQ, A > *&	p
	)

Looks at the next object on the input stream strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, the application is responsible for deleting it.

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

RWFile & operator>>	(	RWFile &	file,
		RWTValOrderedHashSet< T, H, EQ, A > *&	p
	)

Looks at the next object on the stream represented by the RWFile file and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, the application is responsible for deleting it.

SourcePro® API Reference Guide

Public Types

Public Member Functions

Related Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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