Related Functions
concept::stl::container Struct Reference

Container concept. More...

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

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

List of all members.

Public Types

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

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.

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.

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

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.

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.


Constructor & Destructor Documentation

Default destructor.


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.

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.

Get the maximum size of the container.

Returns:
The maximum number of elements the container can hold.

Get the size of the container.

Returns:
The number of elements in the container.

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