concept::stl::list Struct Reference

List concept. More...

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

Inheritance diagram for concept::stl::list:

List of all members.

Public 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.
Iterator Types
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
void	splice (iterator p, list &x)
	Insert all elements from another container.
void	splice (iterator p, list &x, iterator i)
	Insert a single element from another container.
void	splice (iterator p, list &x, iterator f, iterator l)
	Insert a range of elements from another container.
void	remove (const_reference v)
	Remove all elements matching v.
void	remove_if (predicate test)
	Remove all elements according to test.
void	unique ()
	Remove all duplicate elements (other than the 1st).
void	unique (binary_predicate comp)
	Remove all duplicate elements (other than the 1st).
void	merge (list &x)
	Merge with another container.
void	merge (list &x, binary_predicate comp)
	Merge with another container.
void	reverse ()
	Reverse the order of elements.
void	sort ()
	Sort elements according to operator<.
void	sort (binary_predicate comp)
	Sort elements according to comp.
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.
Insert/Erase Methods
void	push_front (const_reference v)
	Insert an object at the front of the container.
void	pop_front ()
	Erase the element at the front of the container.
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.
Insert/Erase Methods
void	push_back (const_reference v)
	Insert an object at the back of the container.
void	pop_back ()
	Erase the element at the back of the container.
Related Functions
(Note that these are not member functions.)
void	swap (assignable &a1, assignable &a2)
	Global swap.

---

Detailed Description

List concept.

---

Member Typedef Documentation

typedef bidirectional_iterator concept::stl::list::const_iterator

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

Reimplemented from concept::stl::reversible_container.

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::list::iterator

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

Reimplemented from concept::stl::reversible_container.

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.

void concept::stl::sequence::clear

(

)

[inherited]

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

)

[inherited]

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
	)		[inherited]

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

(

)

[inherited]

Get the first element.

Returns:

A reference to the first element in the container.

const_reference concept::stl::sequence::front

(

)

const [inherited]

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
	)		[inherited]

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
	)		[inherited]

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
	)		[inherited]

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.

void concept::stl::list::merge

(

list &

x

)

Merge with another container.

Parameters:

x	The other container.

Note:

Both containers must be sorted according to operator<, and must not be identical.

void concept::stl::list::merge	(	list &	x,
		binary_predicate	comp
	)

Merge with another container.

Parameters:

x	The other container.
comp	The comparison functor.

Note:

Both containers must be sorted according to comp, and must not be identical.

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::back_insertion_sequence::pop_back

(

)

[inherited]

Erase the element at the back of the container.

void concept::stl::front_insertion_sequence::pop_front

(

)

[inherited]

Erase the element at the front of the container.

void concept::stl::back_insertion_sequence::push_back

(

const_reference

v

)

[inherited]

Insert an object at the back of the container.

Parameters:

v	The object to insert.

Reimplemented in concept::ash::hash_list.

void concept::stl::front_insertion_sequence::push_front

(

const_reference

v

)

[inherited]

Insert an object at the front of the container.

Parameters:

v	The object to insert.

Reimplemented in concept::ash::hash_list.

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.

void concept::stl::list::remove

(

const_reference

v

)

Remove all elements matching v.

Parameters:

v	The element to match.

void concept::stl::list::remove_if

(

predicate

test

)

Remove all elements according to test.

Parameters:

test	The test functor.

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.

void concept::stl::sequence::resize

(

size_type

n

)

[inherited]

Resize the container.

Equivalent to resize(n, value_type()).

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

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.

void concept::stl::list::reverse

(

)

Reverse the order of elements.

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::list::sort

(

)

Sort elements according to operator<.

void concept::stl::list::sort

(

binary_predicate

comp

)

Sort elements according to comp.

Parameters:

comp	The comparison functor.

void concept::stl::list::splice	(	iterator	p,
		list &	x
	)

Insert all elements from another container.

Parameters:

p	An iterator to the element after the location to insert.
x	The container to insert.

void concept::stl::list::splice	(	iterator	p,
		list &	x,
		iterator	i
	)

Insert a single element from another container.

Parameters:

p	An iterator to the element after the location to insert.
x	The container from which to insert.
i	An iterator to the element to insert.

void concept::stl::list::splice	(	iterator	p,
		list &	x,
		iterator	f,
		iterator	l
	)

Insert a range of elements from another container.

Parameters:

p	An iterator to the element after the location to insert.
x	The container from which to insert.
f	An iterator to the first element to insert.
l	An iterator to the element after the last element to insert.

void concept::stl::container::swap

(

container &

c

)

[inherited]

Swap method.

void concept::stl::list::unique

(

)

Remove all duplicate elements (other than the 1st).

void concept::stl::list::unique

(

binary_predicate

comp

)

Remove all duplicate elements (other than the 1st).

Parameters:

comp	The comparison functor.

---

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

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