concept::stl::random_access_container Struct Reference

Random Access Container concept. More...

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

Inheritance diagram for concept::stl::random_access_container:

List of all members.

Public Types
Iterator Types
typedef bidirectional_iterator	iterator
	The type used to iterate through the contents of the container.
typedef bidirectional_iterator	const_iterator
	The const type used to iterate through the contents of the container.
typedef std::reverse_iterator < iterator >	reverse_iterator
	A reverse_iterator adaptor for an iterator.
typedef std::reverse_iterator < const_iterator >	const_reverse_iterator
	A reverse_iterator adaptor for a const_iterator.
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.
Public Member Functions
Lookup Methods
reference	operator[] (size_type i)
	Element access.
Iterator Methods
reverse_iterator	rbegin ()
	Get an iterator to the reverse beginning.
const_reverse_iterator	rbegin () const
	Get an iterator to the reverse beginning.
reverse_iterator	rend ()
	Get an iterator to the reverse end.
const_reverse_iterator	rend () const
	Get an iterator to the reverse beginning.
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

Random Access Container concept.

---

Member Typedef Documentation

typedef bidirectional_iterator concept::stl::reversible_container::const_iterator [inherited]

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

Reimplemented from concept::stl::forward_container.

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

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 std::reverse_iterator<const_iterator> concept::stl::reversible_container::const_reverse_iterator [inherited]

A reverse_iterator adaptor for a const_iterator.

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

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

typedef bidirectional_iterator concept::stl::reversible_container::iterator [inherited]

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

Reimplemented from concept::stl::forward_container.

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

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 std::reverse_iterator<iterator> concept::stl::reversible_container::reverse_iterator [inherited]

A reverse_iterator adaptor for an iterator.

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.

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.

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.

reference concept::stl::random_access_container::operator[]

(

size_type

i

)

Element access.

reverse_iterator concept::stl::reversible_container::rbegin

(

)

[inherited]

Get an iterator to the reverse beginning.

Returns:

A reverse_iterator pointing to the beginning of the reversed container.

const_reverse_iterator concept::stl::reversible_container::rbegin

(

)

const [inherited]

Get an iterator to the reverse beginning.

Returns:

A const_reverse_iterator pointing to the beginning of the reversed container.

reverse_iterator concept::stl::reversible_container::rend

(

)

[inherited]

Get an iterator to the reverse end.

Returns:

A reverse_iterator pointing to the end of the reversed container.

const_reverse_iterator concept::stl::reversible_container::rend

(

)

const [inherited]

Get an iterator to the reverse beginning.

Returns:

A const_reverse_iterator pointing to the beginning of the reversed container.

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/stl/container.hpp