concept::stl::sequence Struct Reference

Sequence concept. More...

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

Inheritance diagram for concept::stl::sequence:

List of all members.

Public Types
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.
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
Constructors/Destructors
	sequence (size_type n=0)
	Default constructor.
	sequence (value_type const &t, size_type n)
	Fill constructor.
template<class InputIterator >
	sequence (InputIterator f, InputIterator l)
	Range constructor.
Lookup Methods
reference	front ()
	Get the first element.
const_reference	front () const
	Get the first element.
Size Methods
void	resize (size_type n)
	Resize the container.
void	resize (size_type n, value_type const &t)
	Resize the container.
Insert/Erase Methods
iterator	insert (iterator p, const_reference v)
	Insert an object.
void	insert (iterator p, size_type n, const_reference v)
	Fill insert.
void	insert (iterator p, input_iterator f, input_iterator l)
	Range insert.
iterator	erase (iterator p)
	Erase an element.
iterator	erase (iterator f, iterator l)
	Erase a range of elements.
void	clear ()
	Erase all elements.
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

Sequence concept.

---

Member Typedef Documentation

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

---

Constructor & Destructor Documentation

concept::stl::sequence::sequence

(

size_type

n = 0

)

[explicit]

Default constructor.

Parameters:

n	The number of expected elements.

concept::stl::sequence::sequence	(	value_type const &	t,
		size_type	n
	)

Fill constructor.

Parameters:

t	The object to fill the container with (copies).
n	The number of expected elements.

template<class InputIterator >

concept::stl::sequence::sequence	(	InputIterator	f,
		InputIterator	l
	)

Range constructor.

Parameters:

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

---

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::stl::sequence::clear

(

)

Erase all elements.

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.

iterator concept::stl::sequence::erase

(

iterator

p

)

Erase an element.

Parameters:

p	An iterator pointing to the element.

Returns:

An iterator to the element after the one that was erased.

iterator concept::stl::sequence::erase	(	iterator	f,
		iterator	l
	)

Erase a range of elements.

Parameters:

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

Returns:

An iterator to the element after the last erased element.

reference concept::stl::sequence::front

(

)

Get the first element.

Returns:

A reference to the first element in the container.

const_reference concept::stl::sequence::front

(

)

const

Get the first element.

Returns:

A const_reference to the first element in the container.

iterator concept::stl::sequence::insert	(	iterator	p,
		const_reference	v
	)

Insert an object.

Parameters:

p	An iterator to the element after the location to insert.
v	The object to insert.

Returns:

An iterator to the inserted element.

void concept::stl::sequence::insert	(	iterator	p,
		size_type	n,
		const_reference	v
	)

Fill insert.

Parameters:

p	An iterator to the element after the location to insert.
n	The number of copies to insert.
v	The object to insert.

void concept::stl::sequence::insert	(	iterator	p,
		input_iterator	f,
		input_iterator	l
	)

Range insert.

Parameters:

p	An iterator to the element after the location to insert.
f	The beginning of the range to insert.
t	The end of the range to insert.

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.

void concept::stl::sequence::resize

(

size_type

n

)

Resize the container.

Equivalent to resize(n, value_type()).

void concept::stl::sequence::resize	(	size_type	n,
		value_type const &	t
	)

Resize the container.

Parameters:

n	The number of expected elements.
t	The object to fill extra space with.

Modifies the container so that it has exactly n elements, inserting elements at the end or erasing elements from the end if necessary. If any elements are inserted, they are copies of t.

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/sequence.hpp