concept::stl::container Struct Reference

Container concept. More...

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

Inheritance diagram for concept::stl::container:

List of all members.

Public Types
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.
Public Member Functions
Constructors/Destructors
	~container ()
	Default destructor.
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

Container concept.

---

Member Typedef Documentation

typedef input_iterator concept::stl::container::const_iterator

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 value_type const* concept::stl::container::const_pointer

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

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

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

typedef input_iterator concept::stl::container::iterator

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 value_type* concept::stl::container::pointer

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

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

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

Reimplemented in concept::ash::hash_matrix.

typedef assignable concept::stl::container::value_type

The type of the object the container holds.

Must be Assignable .

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

---

Constructor & Destructor Documentation

concept::stl::container::~container

(

)

Default destructor.

---

Member Function Documentation

iterator concept::stl::container::begin

(

)

Get an iterator to the beginning.

Returns:

An iterator to the beginning of the container.

const_iterator concept::stl::container::begin

(

)

const

Get an iterator to the beginning.

Returns:

A const_iterator to the beginning of the container.

bool concept::stl::container::empty

(

)

const

Check if the container is empty.

Returns:

True if the container is empty.

iterator concept::stl::container::end

(

)

Get an iterator to the end.

Returns:

An iterator to the end of the container.

const_iterator concept::stl::container::end

(

)

const

Get an iterator to the end.

Returns:

A const_iterator to the end of the container.

size_type concept::stl::container::max_size

(

)

const

Get the maximum size of the container.

Returns:

The maximum number of elements the container can hold.

size_type concept::stl::container::size

(

)

const

Get the size of the container.

Returns:

The number of elements in the container.

void concept::stl::container::swap

(

container &

c

)

Swap method.

---

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

• dox/tag/concept/stl/container.hpp