Public Types | Public Member Functions | Related Functions
concept::stl::simple_associative_container Struct Reference

Simple Associative Container concept. More...

#include <dox/tag/concept/stl/assoc_container.hpp>

Inheritance diagram for concept::stl::simple_associative_container:
Inheritance graph
[legend]

List of all members.

Public Types

typedef value_type key_type
 The type used to identify elements.
typedef const_iterator iterator
 The type used to iterate through the contents of the container.
Iterator Types
typedef forward_iterator const_iterator
 The const type used to iterate through the contents of the container.
Basic Types
typedef assignable value_type
 The type of the object the container holds.
typedef value_typepointer
 The type that serves as a pointer to value_type.
typedef value_typereference
 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.

Public Member Functions

size_type erase (key_type const &key)
 Erase an element.
void erase (iterator itr)
 Erase an element.
void erase (iterator f, 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.
size_type count (key_type const &key) const
 Count the number of elements with a given key.
std::pair< iterator, iteratorequal_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.
Comparison Methods
bool operator== (equality_comparable const &e)
 Equality operator.
Comparison Methods
bool operator< (less_than_comparable const &l)
 Less-than operator.
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.

Related Functions

(Note that these are not member functions.)

void swap (assignable &a1, assignable &a2)
 Global swap.

Detailed Description

Simple Associative Container concept.


Member Typedef Documentation

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.

The type that serves as a const pointer to value_type.

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

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.

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

Reimplemented from concept::stl::forward_container.

The type used to identify elements.

Reimplemented from concept::stl::associative_container.

The type that serves as a pointer to value_type.

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

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.

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

Get an iterator to the beginning.

Returns:
An iterator to the beginning of the container.

Get an iterator to the beginning.

Returns:
A const_iterator to the beginning of the container.

Erase all elements.

Reimplemented in concept::tr1::unordered_associative_container.

Count the number of elements with a given key.

Parameters:
keyThe 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.

Get an iterator to the end.

Returns:
An iterator to the end of the container.

Get an iterator to the end.

Returns:
A const_iterator to the end of the container.

Find all elements matching a given key.

Parameters:
keyThe key to search for.
Returns:
A pair of iterators for the range of elements [first,second).

Reimplemented in concept::stl::unique_associative_container, and concept::tr1::unordered_associative_container.

Find all elements matching a given key.

Parameters:
keyThe key to search for.
Returns:
A pair of const_iterators for the range of elements [first,second).

Reimplemented in concept::stl::unique_associative_container, and concept::tr1::unordered_associative_container.

Erase an element.

Parameters:
keyThe key of the element to erase.
Returns:
The number of erased elements.

Reimplemented in concept::tr1::unordered_associative_container.

Erase an element.

Parameters:
itrAn iterator pointing to the element to erase.

Reimplemented in concept::tr1::unordered_associative_container, and concept::tr1::unordered_associative_container.

Erase a range of elements.

Parameters:
fThe beginning of the range to erase.
lThe end of the range to erase.

Reimplemented in concept::tr1::unordered_associative_container, and concept::tr1::unordered_associative_container.

Find an element.

Parameters:
keyThe key of the element to search for.
Returns:
An iterator to the element, or to the end() if not found.

Reimplemented in concept::tr1::unordered_associative_container.

Find an element.

Parameters:
keyThe key of the element to search for.
Returns:
A const_iterator to the element, or to the end() if not found.

Reimplemented in concept::tr1::unordered_associative_container.

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.

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:


© 2012   AshTL
Licensed under  AGPLv3
Hosted by  Get AshTL at SourceForge.net. Fast, secure and Free Open Source software downloads
Generated by  doxygen 1.7.4