concept::tr1::unordered_associative_container Struct Reference

TR1 Unordered Associative Container concept. More...

#include <dox/tag/concept/tr1/unordered_assoc_container.hpp>

Inheritance diagram for concept::tr1::unordered_associative_container:

List of all members.

Public Types
typedef stl::hash_function	hasher
	The functor type used to hash keys.
typedef stl::binary_predicate	key_equal
	The functor used to compare keys for equality.
typedef stl::forward_iterator	local_iterator
	The type used to iterate through a set of elements that share a hash code.
typedef stl::forward_iterator	const_local_iterator
	The const type used to iterate through a set of elements that share a hash code.
typedef allocator	allocator_type
	The allocator used for memory management.
typedef arbitrary	key_type
	The type used to identify elements.
Basic Types
typedef assignable	value_type
	The type of the object the container holds.
typedef value_type *	pointer
	The type that serves as a pointer to value_type.
typedef value_type &	reference
	The type that serves as a reference to value_type.
typedef value_type const *	const_pointer
	The type that serves as a const pointer to value_type.
typedef value_type const &	const_reference
	The type that serves as a pointer to value_type.
typedef size_t	size_type
	The unsigned type used to represent the size of the container.
typedef ptrdiff_t	difference_type
	The signed integral type used to represent the distance between iterators.
Iterator Types
typedef input_iterator	iterator
	The type used to iterate through the contents of the container.
typedef input_iterator	const_iterator
	The const type used to iterate through the contents of the container.
Iterator Types
typedef forward_iterator	iterator
	The type used to iterate through the contents of the container.
typedef forward_iterator	const_iterator
	The const type used to iterate through the contents of the container.
Public Member Functions
hasher	hash_function () const
	Get the hash functor used by the container.
key_equal	key_eq () const
	Get the key comparison functor used by the container.
iterator	insert (iterator hint, const_reference obj)
	Insert semantics for std::insert_iterator.
const_iterator	insert (const_iterator hint, const_reference obj)
	Insert semantics for std::insert_iterator.
iterator	insert (iterator f, iterator l)
const_iterator	insert (const_iterator f, const_iterator l)
size_type	erase (key_type const &key)
	Erase all elements associated with key.
iterator	erase (iterator itr)
	Erase the element pointed to by @ itr.
const_iterator	erase (const_iterator itr)
	Erase the element pointed to by @ itr.
iterator	erase (iterator f, iterator l)
	Erase a range of elements.
const_iterator	erase (const_iterator f, const_iterator l)
	Erase a range of elements.
void	clear ()
	Erase all elements.
iterator	find (key_type const &key)
	Find an element.
const_iterator	find (key_type const &key) const
	Find an element.
std::pair< iterator, iterator >	equal_range (key_type const &key)
	Find all elements matching a given key.
std::pair< const_iterator, const_iterator >	equal_range (key_type const &key) const
	Find all elements matching a given key.
size_type	bucket_count () const
size_type	max_bucket_count () const
size_type	bucket (key_type const &key) const
size_type	bucket_size (size_type i) const
local_iterator	begin (size_type i)
const_local_iterator	begin (size_type i) const
local_iterator	end (size_type i)
const_local_iterator	end (size_type i)
float	load_factor () const
float	max_load_factor () const
void	max_load_factor (float new_grow)
size_type	count (key_type const &key) const
	Count the number of elements with a given key.
Constructors/Destructors
void	swap (container &c)
	Swap method.
Iterator Methods
iterator	begin ()
	Get an iterator to the beginning.
const_iterator	begin () const
	Get an iterator to the beginning.
iterator	end ()
	Get an iterator to the end.
const_iterator	end () const
	Get an iterator to the end.
Size Methods
size_type	size () const
	Get the size of the container.
size_type	max_size () const
	Get the maximum size of the container.
bool	empty () const
	Check if the container is empty.
Comparison Methods
bool	operator== (equality_comparable const &e)
	Equality operator.
Comparison Methods
bool	operator< (less_than_comparable const &l)
	Less-than operator.
Related Functions
(Note that these are not member functions.)
void	swap (assignable &a1, assignable &a2)
	Global swap.

---

Detailed Description

TR1 Unordered Associative Container concept.

Comparison operators are not required to be valid. "Keys with the same hash code are in the same bucket."

• Seems to imply chaining for collisions.
• Alternatively, could be done by having the iterator follow the probing scheme, skipping buckets with different hash codes, and ending at the first empty bucket.

"Rehashing invalidates iterators, changes ordering between elements, and changes which buckets elements appear in, but does not invalidate pointers or references to elements."

• Seems to imply elements stored on the heap, and pointers stored in the table.
• Alternatively, could be done with element adaptors for pointers and references.

---

Member Typedef Documentation

typedef allocator concept::tr1::container::allocator_type [inherited]

The allocator used for memory management.

typedef input_iterator concept::stl::container::const_iterator [inherited]

The const type used to iterate through the contents of the container.

Reimplemented in concept::stl::list, concept::stl::reversible_container, concept::stl::forward_container, concept::stl::sorted_associative_container, and concept::ash::hash_list.

typedef forward_iterator concept::stl::forward_container::const_iterator [inherited]

The const type used to iterate through the contents of the container.

Reimplemented from concept::stl::container.

Reimplemented in concept::stl::list, concept::stl::reversible_container, concept::stl::sorted_associative_container, and concept::ash::hash_list.

typedef stl::forward_iterator concept::tr1::unordered_associative_container::const_local_iterator

The const type used to iterate through a set of elements that share a hash code.

typedef value_type const* concept::stl::container::const_pointer [inherited]

The type that serves as a const pointer to value_type.

Reimplemented in concept::stl::pair_associative_container, and concept::ash::hash_matrix.

typedef value_type const& concept::stl::container::const_reference [inherited]

The type that serves as a pointer to value_type.

Reimplemented in concept::stl::pair_associative_container, and concept::ash::hash_matrix.

typedef ptrdiff_t concept::stl::container::difference_type [inherited]

The signed integral type used to represent the distance between iterators.

typedef stl::hash_function concept::tr1::unordered_associative_container::hasher

The functor type used to hash keys.

typedef input_iterator concept::stl::container::iterator [inherited]

The type used to iterate through the contents of the container.

Reimplemented in concept::stl::list, concept::stl::reversible_container, concept::stl::forward_container, concept::stl::sorted_associative_container, concept::stl::simple_associative_container, and concept::ash::hash_list.

typedef forward_iterator concept::stl::forward_container::iterator [inherited]

The type used to iterate through the contents of the container.

Reimplemented from concept::stl::container.

Reimplemented in concept::stl::list, concept::stl::reversible_container, concept::stl::sorted_associative_container, concept::stl::simple_associative_container, and concept::ash::hash_list.

typedef stl::binary_predicate concept::tr1::unordered_associative_container::key_equal

The functor used to compare keys for equality.

typedef arbitrary concept::stl::associative_container::key_type [inherited]

The type used to identify elements.

Reimplemented in concept::stl::simple_associative_container, and concept::ash::hash_matrix.

typedef stl::forward_iterator concept::tr1::unordered_associative_container::local_iterator

The type used to iterate through a set of elements that share a hash code.

typedef value_type* concept::stl::container::pointer [inherited]

The type that serves as a pointer to value_type.

Reimplemented in concept::stl::pair_associative_container, and concept::ash::hash_matrix.

typedef value_type& concept::stl::container::reference [inherited]

The type that serves as a reference to value_type.

Reimplemented in concept::stl::pair_associative_container, and concept::ash::hash_matrix.

typedef size_t concept::stl::container::size_type [inherited]

The unsigned type used to represent the size of the container.

Reimplemented in concept::ash::hash_matrix.

typedef assignable concept::stl::container::value_type [inherited]

The type of the object the container holds.

Must be Assignable .

Reimplemented in concept::stl::pair_associative_container, and concept::ash::hash_matrix.

---

Member Function Documentation

iterator concept::stl::container::begin

(

)

[inherited]

Get an iterator to the beginning.

Returns:

An iterator to the beginning of the container.

const_iterator concept::stl::container::begin

(

)

const [inherited]

Get an iterator to the beginning.

Returns:

A const_iterator to the beginning of the container.

void concept::tr1::unordered_associative_container::clear

(

)

Erase all elements.

Reimplemented from concept::stl::associative_container.

size_type concept::stl::associative_container::count

(

key_type const &

key

)

const [inherited]

Count the number of elements with a given key.

Parameters:

key	The key to search for.

Returns:

The number of elements matching key.

Reimplemented in concept::stl::unique_associative_container.

bool concept::stl::container::empty

(

)

const [inherited]

Check if the container is empty.

Returns:

True if the container is empty.

iterator concept::stl::container::end

(

)

[inherited]

Get an iterator to the end.

Returns:

An iterator to the end of the container.

const_iterator concept::stl::container::end

(

)

const [inherited]

Get an iterator to the end.

Returns:

A const_iterator to the end of the container.

std::pair<iterator, iterator> concept::tr1::unordered_associative_container::equal_range

(

key_type const &

key

)

Find all elements matching a given key.

Parameters:

key	The key to search for.

Returns:

A pair of iterators for the range of elements [first,second).

Reimplemented from concept::stl::associative_container.

std::pair<const_iterator, const_iterator> concept::tr1::unordered_associative_container::equal_range

(

key_type const &

key

)

const

Find all elements matching a given key.

Parameters:

key	The key to search for.

Returns:

A pair of const_iterators for the range of elements [first,second).

Reimplemented from concept::stl::associative_container.

size_type concept::tr1::unordered_associative_container::erase

(

key_type const &

key

)

Erase all elements associated with key.

Parameters:

key	The key to match.

Returns:

The number of elements erased.

Reimplemented from concept::stl::associative_container.

iterator concept::tr1::unordered_associative_container::erase

(

iterator

itr

)

Erase the element pointed to by @ itr.

Parameters:

itr	An iterator to the element to erase.

Returns:

An iterator to the element after the erased element.

Reimplemented from concept::stl::associative_container.

const_iterator concept::tr1::unordered_associative_container::erase

(

const_iterator

itr

)

Erase the element pointed to by @ itr.

Parameters:

itr	A const_iterator to the element to erase.

Returns:

A const_iterator to the element after the erased element.

Reimplemented from concept::stl::associative_container.

iterator concept::tr1::unordered_associative_container::erase	(	iterator	f,
		iterator	l
	)

Erase a range of elements.

Parameters:

f	The beginning of the range.
l	The end of the range.

Returns:

An iterator to the element after the erased range.

Reimplemented from concept::stl::associative_container.

const_iterator concept::tr1::unordered_associative_container::erase	(	const_iterator	f,
		const_iterator	l
	)

Erase a range of elements.

Parameters:

f	The beginning of the range.
l	The end of the range.

Returns:

A const_iterator to the element after the erased range.

Reimplemented from concept::stl::associative_container.

iterator concept::tr1::unordered_associative_container::find

(

key_type const &

key

)

Find an element.

Parameters:

key	The key of the element to search for.

Returns:

An iterator to the element, or to the end() if not found.

Reimplemented from concept::stl::associative_container.

const_iterator concept::tr1::unordered_associative_container::find

(

key_type const &

key

)

const

Find an element.

Parameters:

key	The key of the element to search for.

Returns:

A const_iterator to the element, or to the end() if not found.

Reimplemented from concept::stl::associative_container.

hasher concept::tr1::unordered_associative_container::hash_function

(

)

const

Get the hash functor used by the container.

Returns:

A copy of the container's hasher object.

iterator concept::tr1::unordered_associative_container::insert	(	iterator	hint,
		const_reference	obj
	)

Insert semantics for std::insert_iterator.

Parameters:

hint	A hint for the location to insert obj.
obj	The object to insert.

const_iterator concept::tr1::unordered_associative_container::insert	(	const_iterator	hint,
		const_reference	obj
	)

Insert semantics for std::insert_iterator.

Parameters:

hint	A hint for the location to insert obj.
obj	The object to insert.

key_equal concept::tr1::unordered_associative_container::key_eq

(

)

const

Get the key comparison functor used by the container.

Returns:

A copy of the container's key_equal object.

size_type concept::stl::container::max_size

(

)

const [inherited]

Get the maximum size of the container.

Returns:

The maximum number of elements the container can hold.

bool concept::stl::less_than_comparable::operator<

(

less_than_comparable const &

l

)

[inherited]

Less-than operator.

bool concept::stl::equality_comparable::operator==

(

equality_comparable const &

e

)

[inherited]

Equality operator.

size_type concept::stl::container::size

(

)

const [inherited]

Get the size of the container.

Returns:

The number of elements in the container.

void concept::stl::container::swap

(

container &

c

)

[inherited]

Swap method.

---

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

• dox/tag/concept/tr1/unordered_assoc_container.hpp