RWTValOrderedHashMultiSet< T, H, EQ, A > Class Template Reference

Maintains a hash-based collection of class T elements, in which there may be many equivalent instances of an element and the key insertion order is preserved. More...

#include <rw/tools/tvordhmset.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_orderedhashmultiset< 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
	RWTValOrderedHashMultiSet (const hasher &h, size_type sz=64)
	RWTValOrderedHashMultiSet (const rw_orderedhashmultiset< T, H, EQ, A > &s)
	RWTValOrderedHashMultiSet (const RWTValOrderedHashMultiSet< T, H, EQ, A > &rws)
	RWTValOrderedHashMultiSet (container_type &&rws)
template<typename InputIterator >
	RWTValOrderedHashMultiSet (InputIterator first, InputIterator last, size_type sz=64, const hasher &h=hasher(), const key_equal &eq=key_equal())
	RWTValOrderedHashMultiSet (RWTValOrderedHashMultiSet< T, H, EQ, A > &&rws)
	RWTValOrderedHashMultiSet (size_type sz=64, const hasher &h=hasher(), const key_equal &eq=key_equal())
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 value_type &a) const
void	difference (const RWTValOrderedHashMultiSet< T, H, EQ, A > &s)
iterator	end ()
const_iterator	end () const
size_type	entries () const
iterator	erase (iterator first, iterator last)
iterator	erase (iterator pos)
float	fillRatio () const
bool	find (bool(*fn)(const_reference, void *), void *d, value_type &k) const
bool	find (const value_type &a, value_type &k) const
bool	insert (const value_type &datum)
template<typename InputIterator >
void	insert (InputIterator first, InputIterator last)
iterator	insert (iterator hint, const value_type &val)
iterator	insert (iterator hint, value_type &&val)
bool	insert (value_type &&datum)
void	intersection (const RWTValOrderedHashMultiSet< T, H, EQ, A > &s)
bool	isEmpty () const
bool	isEquivalent (const RWTValOrderedHashMultiSet< T, H, EQ, A > &s) const
bool	isProperSubsetOf (const RWTValOrderedHashMultiSet< T, H, EQ, A > &s) const
bool	isSubsetOf (const RWTValOrderedHashMultiSet< T, H, EQ, A > &s) const
size_type	occurrencesOf (bool(*fn)(const_reference, void *), void *d) const
size_type	occurrencesOf (const value_type &a) const
RWTValOrderedHashMultiSet< T, H, EQ, A > &	operator= (const rw_orderedhashmultiset< T, H, EQ, A > &rhs)
RWTValOrderedHashMultiSet< T, H, EQ, A > &	operator= (const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs)
RWTValOrderedHashMultiSet< T, H, EQ, A > &	operator= (container_type &&rhs)
RWTValOrderedHashMultiSet< T, H, EQ, A > &	operator= (RWTValOrderedHashMultiSet< T, H, EQ, A > &&rhs)
bool	remove (bool(*fn)(const_reference, void *), void *d)
bool	remove (const value_type &a)
size_type	removeAll (bool(*fn)(const_reference, void *), void *d)
size_type	removeAll (const value_type &a)
void	resize (size_type sz)
container_type &	std ()
const container_type &	std () const
void	swap (RWTValOrderedHashMultiSet< T, H, EQ, A > &other)
void	symmetricDifference (const RWTValOrderedHashMultiSet< T, H, EQ, A > &s)
void	Union (const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs)

Related Symbols
(Note that these are not member symbols.)
template<class T , class H , class EQ , class A >
bool	operator!= (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
bool	operator!= (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &rhs)
template<class T , class H , class EQ , class A >
bool	operator!= (const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &file, const RWTValOrderedHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTValOrderedHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
bool	operator== (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
bool	operator== (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &rhs)
template<class T , class H , class EQ , class A >
bool	operator== (const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTValOrderedHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTValOrderedHashMultiSet< T, H, EQ, A > *&p)
template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValOrderedHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValOrderedHashMultiSet< 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 RWTValOrderedHashMultiSet< T, H, EQ, A >

RWTValOrderedHashMultiSet maintains a collection of class T elements, stored according to a hash object of type H. RWTValOrderedHashMultiSet preserves the key insertion order. If the collection already contains items with the same key, the item will be inserted immediately after those items.

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.

Equivalent elements within the collection are grouped together based on an equality object of type EQ. EQ must ensure this grouping via a function that takes two arguments convertible to type T and returns a value of type bool.

Note

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

RWTValOrderedHashMultiSet may contain multiple elements that are equivalent to each other.

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

Synopsis

#include <rw/tools/tvordhmset.h>
RWTValOrderedHashMultiSet<T, H, EQ, A> m;

See also

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

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

Persistence

Isomorphic

Member Typedef Documentation

allocator_type

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

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

A type representing the allocator type for the container.

const_iterator

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

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

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

const_pointer

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

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

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

const_reference

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

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

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

container_type

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

typedef rw_orderedhashmultiset<T, H, EQ, A> RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type

A type representing the underlying implementation container.

difference_type

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

typedef container_type::difference_type RWTValOrderedHashMultiSet< T, H, EQ, A >::difference_type

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

hasher

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

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

A type representing the hash function.

iterator

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

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

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

key_equal

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

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

A type representing the equality function.

key_type

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

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

A type representing the key of the container.

pointer

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

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

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

reference

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

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

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

size_type

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

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

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

value_type

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

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

A type representing the container's data type.

Constructor & Destructor Documentation

RWTValOrderedHashMultiSet() [1/7]

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

RWTValOrderedHashMultiSet< T, H, EQ, A >::RWTValOrderedHashMultiSet ( 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 as its hashing function, and uses eq to determine equivalence between elements.

Note

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

RWTValOrderedHashMultiSet() [2/7]

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

RWTValOrderedHashMultiSet< T, H, EQ, A >::RWTValOrderedHashMultiSet ( const rw_orderedhashmultiset< T, H, EQ, A > & s )

inline

Constructs a set by copying all elements of s.

RWTValOrderedHashMultiSet() [3/7]

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

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

inline

Copy constructor.

RWTValOrderedHashMultiSet() [4/7]

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

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

inline

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

Condition:

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

RWTValOrderedHashMultiSet() [5/7]

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

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

inline

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

Condition:

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

RWTValOrderedHashMultiSet() [6/7]

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

template<typename InputIterator >

RWTValOrderedHashMultiSet< T, H, EQ, A >::RWTValOrderedHashMultiSet ( 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 as its hashing function, and uses eq to determine equivalence 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.

RWTValOrderedHashMultiSet() [7/7]

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

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

inline

Creates an empty multi-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

apply()

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

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

inline

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

begin() [1/2]

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

iterator RWTValOrderedHashMultiSet< T, H, EQ, A >::begin ( )

inline

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

If the container is empty, returns end().

begin() [2/2]

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

const_iterator RWTValOrderedHashMultiSet< 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().

capacity()

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

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

inline

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

cbegin()

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

const_iterator RWTValOrderedHashMultiSet< 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().

cend()

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

const_iterator RWTValOrderedHashMultiSet< 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.

clear()

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

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

inline

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

contains() [1/2]

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

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

inline

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

contains() [2/2]

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

bool RWTValOrderedHashMultiSet< T, H, EQ, A >::contains ( const value_type & a ) const

inline

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

difference()

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

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

inline

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

end() [1/2]

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

iterator RWTValOrderedHashMultiSet< 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.

end() [2/2]

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

const_iterator RWTValOrderedHashMultiSet< 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.

entries()

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

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

inline

Returns the number of elements in self.

erase() [1/2]

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

iterator RWTValOrderedHashMultiSet< 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.

erase() [2/2]

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

iterator RWTValOrderedHashMultiSet< 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.

fillRatio()

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

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

inline

Returns the ratio entries() / capacity().

find() [1/2]

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

bool RWTValOrderedHashMultiSet< T, H, EQ, A >::find ( bool(* fn )(const_reference, void *), void * d, 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. Client data may be passed through parameter d.

find() [2/2]

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

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

inline

If there exists an element t in self such that the expression (t == a) is true, assigns t to k and returns true. Otherwise, returns false and leaves the value of k unchanged.

insert() [1/5]

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

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

inline

Adds the item a to the collection. Returns true.

Note

If the collection already contains items with the same key, datum will be inserted immediately after those items.

insert() [2/5]

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

template<typename InputIterator >

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

inline

Inserts the elements in the range [first, last) into self.

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

Note

If the collection already contains items with the same key, a copy of the item will be inserted immediately after those items.

insert() [3/5]

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

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

inline

Inserts val into self. 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.

Note

If the collection already contains items with the same key, val will be inserted immediately after those items.

insert() [4/5]

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

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

inline

Inserts val into self. 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.

Note

If the collection already contains items with the same key, val will be inserted immediately after those items.

Condition:

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

insert() [5/5]

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

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

inline

Adds the item a to the collection. Returns true.

Note

If the collection already contains items with the same key, datum will be inserted immediately after those items.

Condition:

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

intersection()

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

void RWTValOrderedHashMultiSet< T, H, EQ, A >::intersection ( const RWTValOrderedHashMultiSet< T, H, EQ, A > & s )

inline

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

isEmpty()

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

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

inline

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

isEquivalent()

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

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

inline

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

isProperSubsetOf()

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

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

inline

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

isSubsetOf()

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

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

inline

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

occurrencesOf() [1/2]

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

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

inline

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

occurrencesOf() [2/2]

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

size_type RWTValOrderedHashMultiSet< T, H, EQ, A >::occurrencesOf ( const value_type & a ) const

inline

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

operator=() [1/4]

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

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

inline

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

operator=() [2/4]

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

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

inline

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

operator=() [3/4]

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

RWTValOrderedHashMultiSet< T, H, EQ, A > & RWTValOrderedHashMultiSet< 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.

operator=() [4/4]

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

RWTValOrderedHashMultiSet< T, H, EQ, A > & RWTValOrderedHashMultiSet< T, H, EQ, A >::operator= ( RWTValOrderedHashMultiSet< 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.

remove() [1/2]

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

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

inline

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

remove() [2/2]

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

bool RWTValOrderedHashMultiSet< T, H, EQ, A >::remove ( const value_type & a )

inline

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

removeAll() [1/2]

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

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

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

removeAll() [2/2]

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

size_type RWTValOrderedHashMultiSet< T, H, EQ, A >::removeAll ( const value_type & a )

inline

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

resize()

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

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

inline

Changes the capacity of self by creating a new multi-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.

std() [1/2]

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

container_type & RWTValOrderedHashMultiSet< 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 the C++ Standard Library collections.

std() [2/2]

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

const container_type & RWTValOrderedHashMultiSet< 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 the C++ Standard Library collections.

swap()

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

void RWTValOrderedHashMultiSet< T, H, EQ, A >::swap ( RWTValOrderedHashMultiSet< 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.

symmetricDifference()

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

void RWTValOrderedHashMultiSet< T, H, EQ, A >::symmetricDifference ( const RWTValOrderedHashMultiSet< T, H, EQ, A > & s )

inline

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

Union()

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

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

inline

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

Friends And Related Symbol Documentation

operator!=() [1/3]

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

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

related

Equivalent to !(lhs == rhs).

operator!=() [2/3]

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

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

related

Equivalent to !(lhs == rhs).

operator!=() [3/3]

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

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

related

Equivalent to !(lhs == rhs).

operator<<() [1/2]

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

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

related

Saves the collection coll to the RWFile file, or a reference to the file if the collection has already been saved.

operator<<() [2/2]

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

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

related

Saves the collection coll to the output stream strm, or a reference to it if it has already been saved.

operator==() [1/3]

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

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

related

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.

operator==() [2/3]

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

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

related

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.

operator==() [3/3]

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

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

related

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.

operator>>() [1/4]

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

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

related

Restores the contents of the collection coll from the RWFile file.

operator>>() [2/4]

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

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

related

Looks at the next object on the stream represented by 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.

operator>>() [3/4]

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

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

related

Restores the contents of the collection coll from the input stream strm.

operator>>() [4/4]

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

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

related

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.