Collection of values implemented as a double-ended queue, or deque. More...

#include <rw/tvdeque.h>

Public Types
typedef container_type::allocator_type	allocator_type

typedef container_type::const_iterator	const_iterator

typedef container_type::const_pointer	const_pointer

typedef container_type::const_reference	const_reference

typedef container_type::const_reverse_iterator	const_reverse_iterator

typedef std::deque< T, A >	container_type

typedef container_type::difference_type	difference_type

typedef container_type::iterator	iterator

typedef container_type::pointer	pointer

typedef container_type::reference	reference

typedef container_type::reverse_iterator	reverse_iterator

typedef container_type::size_type	size_type

typedef container_type::value_type	value_type

Public Member Functions
	RWTValDeque ()

	RWTValDeque (const container_type &deq)

	RWTValDeque (const RWTValDeque< T, A > &rwdeq)

	RWTValDeque (RWTValDeque< T, A > &&deq)

	RWTValDeque (container_type &&deq)

	RWTValDeque (size_type n, const_reference val=value_type())

template<typename InputIterator >
	RWTValDeque (InputIterator first, InputIterator last)

void	append (const_reference a)

void	append (value_type &&a)

void	apply (void(fn)(reference, void ), void *d)

void	apply (void(fn)(const_reference, void ), void *d) const

template<typename InputIterator >
void	assign (InputIterator first, InputIterator last)

reference	at (size_type i)

const_reference	at (size_type i) const

iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

const_iterator	cend () const

void	clear ()

bool	contains (bool(fn)(const_reference, void ), void *d) const

bool	contains (const_reference a) const

const_reverse_iterator	crbegin () const

const_reverse_iterator	crend () const

iterator	end ()

const_iterator	end () const

size_type	entries () const

iterator	erase (iterator pos)

iterator	erase (iterator first, iterator last)

bool	find (bool(fn)(const_reference, void ), void *d, value_type &k) const

bool	find (const_reference a, value_type &k) const

reference	first ()

const_reference	first () const

size_type	index (const_reference a) const

size_type	index (bool(fn)(const_reference, void ), void *d) const

bool	insert (const_reference a)

iterator	insert (iterator pos, const_reference val)

void	insert (iterator pos, size_type n, const_reference val)

template<typename InputIterator >
void	insert (iterator pos, InputIterator first, InputIterator last)

bool	insert (value_type &&a)

iterator	insert (iterator pos, value_type &&val)

void	insertAt (size_type i, const_reference a)

void	insertAt (size_type i, value_type &&a)

bool	isEmpty () const

reference	last ()

const_reference	last () const

reference	maxElement ()

const_reference	maxElement () const

reference	minElement ()

const_reference	minElement () const

size_type	occurrencesOf (bool(fn)(const_reference, void ), void *d) const

size_type	occurrencesOf (const_reference a) const

reference	operator() (size_type i)

const_reference	operator() (size_type i) const

RWTValDeque< T, A > &	operator= (const RWTValDeque< T, A > &rhs)

RWTValDeque< T, A > &	operator= (const container_type &rhs)

RWTValDeque< T, A > &	operator= (RWTValDeque< T, A > &&rhs)

RWTValDeque< T, A > &	operator= (container_type &&rhs)

reference	operator[] (size_type i)

const_reference	operator[] (size_type i) const

value_type	popBack ()

value_type	popFront ()

void	prepend (const_reference a)

void	prepend (value_type &&a)

void	pushBack (const_reference a)

void	pushBack (value_type &&a)

void	pushFront (const_reference a)

void	pushFront (value_type &&a)

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

bool	remove (const_reference a)

bool	remove (bool(fn)(const_reference, void ), void *d)

size_type	removeAll (bool(fn)(const_reference, void ), void *d)

size_type	removeAll (const_reference a)

value_type	removeAt (size_type index)

value_type	removeFirst ()

value_type	removeLast ()

reverse_iterator	rend ()

const_reverse_iterator	rend () const

size_type	replaceAll (bool(fn)(const value_type &, void ), void *d, const value_type &newVal)

size_type	replaceAll (const value_type &oldVal, const value_type &newVal)

void	sort ()

container_type &	std ()

const container_type &	std () const

void	swap (RWTValDeque< T, A > &rhs)

Related Functions
(Note that these are not member functions.)
template<class T , class A >
bool	operator!= (const RWTValDeque< T, A > &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator!= (const RWTValDeque< T, A > &lhs, const typename RWTValDeque< T, A >::container_type &rhs)

template<class T , class A >
bool	operator!= (const typename RWTValDeque< T, A >::container_type &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator< (const RWTValDeque< T, A > &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator< (const RWTValDeque< T, A > &lhs, const typename RWTValDeque< T, A >::container_type &rhs)

template<class T , class A >
bool	operator< (const typename RWTValDeque< T, A >::container_type &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTValDeque< T, A > &coll)

template<class T , class A >
RWFile &	operator<< (RWFile &strm, const RWTValDeque< T, A > &coll)

template<class T , class A >
bool	operator<= (const RWTValDeque< T, A > &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator<= (const RWTValDeque< T, A > &lhs, const typename RWTValDeque< T, A >::container_type &rhs)

template<class T , class A >
bool	operator<= (const typename RWTValDeque< T, A >::container_type &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator== (const RWTValDeque< T, A > &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator== (const RWTValDeque< T, A > &lhs, const typename RWTValDeque< T, A >::container_type &rhs)

template<class T , class A >
bool	operator== (const typename RWTValDeque< T, A >::container_type &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator> (const RWTValDeque< T, A > &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator> (const RWTValDeque< T, A > &lhs, const typename RWTValDeque< T, A >::container_type &rhs)

template<class T , class A >
bool	operator> (const typename RWTValDeque< T, A >::container_type &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator>= (const RWTValDeque< T, A > &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
bool	operator>= (const RWTValDeque< T, A > &lhs, const typename RWTValDeque< T, A >::container_type &rhs)

template<class T , class A >
bool	operator>= (const typename RWTValDeque< T, A >::container_type &lhs, const RWTValDeque< T, A > &rhs)

template<class T , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValDeque< T, A > &coll)

template<class T , class A >
RWFile &	operator>> (RWFile &strm, RWTValDeque< T, A > &coll)

template<class T , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValDeque< T, A > *&p)

template<class T , class A >
RWFile &	operator>> (RWFile &strm, RWTValDeque< T, A > *&p)

Detailed Description

template<class T, class A = std::allocator<T>>
class RWTValDeque< T, A >

This class maintains a collection of values implemented as a double-ended queue, or deque. Order is determined externally and elements are accessible by index. Use this class when insertions and deletions usually occur at either the beginning or the end of the collection. Class T is the type of items in the collection. Class A is an allocator of objects of class T. For more information about using custom allocators, please see the Essential Tools Module User's Guide.

Synopsis: #include <rw/tvdeque.h>

RWTValDeque<T,A> deq;

See also

Classes RWTValSlist, RWTValDlist, RWTValSortedDlist, and RWTValOrderedVector also provide a Rogue Wave interface to C++ Standard Library sequence collections. The list classes should be considered for frequent insertions (or removals) in the interior of the collection. Vectors may be more efficient if most insertions and removals occur at the end of the collection.

Class std::deque<T, A<T*> > is the C++ Standard Library collection that serves as the underlying implementation for this class.

Persistence: Isomorphic

Example

//
// tvdqint.cpp
//
#include <rw/tvdeque.h>
#include <iostream>
int main ()
{
    RWTValDeque<int> numbers;
    int n;
    std::cout << "Input an assortment of integers (EOF to end):" << std::endl;
    while (std::cin >> n) {
        if (n % 2 == 0)
            numbers.pushFront(n);
        else
            numbers.pushBack(n);
    }
    std::cout << "Partitioned numbers are: ";
    for (int i = 0; numbers.entries(); ++i) {
        if (i)
            std::cout << ", ";
        std::cout << numbers.popFront();
    }
    std::cout << "\n";
    return 0;
}

Program Input:

1 2 3 4 5

<eof>

Program Output:

Input an assortment of integers (EOF to end):

Partitioned numbers are: 4, 2, 1, 3, 5

Member Typedef Documentation

template<class T, class A = std::allocator<T>>

typedef container_type::allocator_type RWTValDeque< T, A >::allocator_type

A type representing the allocator type for the container.

template<class T, class A = std::allocator<T>>

typedef container_type::const_iterator RWTValDeque< T, A >::const_iterator

A type that provides a const random-access iterator over the elements in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::const_pointer RWTValDeque< T, A >::const_pointer

A type that provides a const pointer to an element in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::const_reference RWTValDeque< T, A >::const_reference

A type that provides a const reference to an element in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::const_reverse_iterator RWTValDeque< T, A >::const_reverse_iterator

A type that provides a const random-access, reverse-order iterator over the elements in the container.

template<class T, class A = std::allocator<T>>

typedef std::deque<T, A> RWTValDeque< T, A >::container_type

A type representing the underlying implementation container.

template<class T, class A = std::allocator<T>>

typedef container_type::difference_type RWTValDeque< T, A >::difference_type

A signed integral type used to indicate the distance between two valid iterators on the same container.

template<class T, class A = std::allocator<T>>

typedef container_type::iterator RWTValDeque< T, A >::iterator

A type that provides a random-access iterator over the elements in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::pointer RWTValDeque< T, A >::pointer

A type that provides a pointer to an element in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::reference RWTValDeque< T, A >::reference

A type that provides a reference to an element in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::reverse_iterator RWTValDeque< T, A >::reverse_iterator

A type that provides a random-access, reverse-order iterator over the elements in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::size_type RWTValDeque< T, A >::size_type

An unsigned integral type used for counting the number of elements in the container.

template<class T, class A = std::allocator<T>>

typedef container_type::value_type RWTValDeque< T, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

template<class T, class A = std::allocator<T>>

RWTValDeque< T, A >::RWTValDeque ( )

inline

Constructs an empty, double-ended queue.

template<class T, class A = std::allocator<T>>

RWTValDeque< T, A >::RWTValDeque ( const container_type & deq )

inline

Constructs a double-ended queue by copying all elements of deq.

template<class T, class A = std::allocator<T>>

RWTValDeque< T, A >::RWTValDeque ( const RWTValDeque< T, A > & rwdeq )

inline

Copy constructor.

template<class T, class A = std::allocator<T>>

RWTValDeque< T, A >::RWTValDeque ( RWTValDeque< T, A > && deq )

inline

Move constructor. The constructed deque takes ownership of the data owned by deq.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

RWTValDeque< T, A >::RWTValDeque ( container_type && deq )

inline

Move constructor. The constructed deque takes ownership of the data owned by deq.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

RWTValDeque< T, A >::RWTValDeque	(	size_type	n,
		const_reference	val = `value_type()`
	)

inline

Constructs a double-ended queue with n elements, each initialized to val.

template<class T, class A = std::allocator<T>>

template<typename InputIterator >

RWTValDeque< T, A >::RWTValDeque	(	InputIterator	first,
		InputIterator	last
	)

inline

Constructs a double-ended queue by copying elements from the range [first, last).

InputIterator is an input iterator type that points to elements that are convertible to value_type objects.

Member Function Documentation

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::append ( const_reference a )

inline

Adds the item a to the end of the collection.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::append ( value_type && a )

inline

Adds the item a to the end of the collection.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::apply	(	void()(reference, void )	fn,
		void *	d
	)

inline

Invokes the function pointer fn on each item in the collection. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::apply	(	void()(const_reference, void )	fn,
		void *	d
	)		const

inline

Invokes the function pointer fn on each item in the collection. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

template<typename InputIterator >

void RWTValDeque< T, A >::assign	(	InputIterator	first,
		InputIterator	last
	)

inline

Copies each element in the range [first, last) into self, replacing any existing items.

InputIterator is an input iterator type that points to elements that are convertible to value_type objects.

Note: first and last must not be iterators into self.

template<class T, class A = std::allocator<T>>

reference RWTValDeque< T, A >::at ( size_type i )

inline

Returns a reference to the i ^th element of self.

Exceptions

RWBoundsErr Thrown if index i is not between 0 and one less than the number of entries in self.

template<class T, class A = std::allocator<T>>

const_reference RWTValDeque< T, A >::at ( size_type i ) const

inline

Returns a reference to the i ^th element of self.

Exceptions

RWBoundsErr Thrown if index i is not between 0 and one less than the number of entries in self.

template<class T, class A = std::allocator<T>>

iterator RWTValDeque< T, A >::begin ( )

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class A = std::allocator<T>>

const_iterator RWTValDeque< T, A >::begin ( ) const

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class A = std::allocator<T>>

const_iterator RWTValDeque< T, A >::cbegin ( ) const

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class A = std::allocator<T>>

const_iterator RWTValDeque< T, A >::cend ( ) const

inline

Returns an iterator referring to the element after the last element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::clear ( void )

inline

Clears the collection by removing all items from self. Each item will have its destructor called.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::contains	(	bool()(const_reference, void )	fn,
		void *	d
	)		const

inline

Returns true if there exists an element t in self such that the expression ((*fn)(t,d)) is true, otherwise returns false. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::contains ( const_reference a ) const

inline

Returns true if there exists an element t in self such that the expression (t == a) is true, otherwise returns false.

template<class T, class A = std::allocator<T>>

const_reverse_iterator RWTValDeque< T, A >::crbegin ( ) const

inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

template<class T, class A = std::allocator<T>>

const_reverse_iterator RWTValDeque< T, A >::crend ( ) const

inline

Returns an iterator referring to the element before the first element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class A = std::allocator<T>>

iterator RWTValDeque< T, A >::end ( )

inline

Returns an iterator referring to the element after the last element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class A = std::allocator<T>>

const_iterator RWTValDeque< T, A >::end ( ) const

inline

Returns an iterator referring to the element after the last element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::entries ( void ) const

inline

Returns the number of elements in self.

template<class T, class A = std::allocator<T>>

iterator RWTValDeque< T, A >::erase ( iterator pos )

inline

Removes the item pointed to by pos from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.

template<class T, class A = std::allocator<T>>

iterator RWTValDeque< T, A >::erase	(	iterator	first,
		iterator	last
	)

inline

Removes the items in the range [first, last) from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::find	(	bool()(const_reference, void )	fn,
		void *	d,
		value_type &	k
	)		const

inline

If there exists an element t in self such that the expression ((*fn)(t,d)) is true, assigns t to k and returns true. Otherwise, returns false and leaves the value of k unchanged. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::find	(	const_reference	a,
		value_type &	k
	)		const

inline

If there exists an element t in self such that the expression (t == a) is true, assigns t to k and returns true. Otherwise, returns false and leaves the value of k unchanged.

template<class T, class A = std::allocator<T>>

reference RWTValDeque< T, A >::first ( void )

inline

Returns a reference to the first item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

const_reference RWTValDeque< T, A >::first ( void ) const

inline

Returns a reference to the first item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::index ( const_reference a ) const

inline

Returns the position of the first item t in self such that (t == a), or returns RW_NPOS if no such item exists.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::index	(	bool()(const_reference, void )	fn,
		void *	d
	)		const

inline

Returns the position of the first item t in self such that ((*fn)(t,d)) is true, or returns RW_NPOS if no such item exists. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::insert ( const_reference a )

inline

Adds the item a to the end of the collection. Returns true.

template<class T, class A = std::allocator<T>>

iterator RWTValDeque< T, A >::insert	(	iterator	pos,
		const_reference	val
	)

inline

Inserts val into self before the element at position pos. Returns an iterator for the newly inserted element.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::insert	(	iterator	pos,
		size_type	n,
		const_reference	val
	)

inline

Inserts n instances of val into self before the element at position pos.

template<class T, class A = std::allocator<T>>

template<typename InputIterator >

void RWTValDeque< T, A >::insert	(	iterator	pos,
		InputIterator	first,
		InputIterator	last
	)

inline

Inserts the elements in the range [first, last) into self before the element at position pos.

InputIterator is an input iterator type that points to elements that are convertible to value_type objects.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::insert ( value_type && a )

inline

Adds the item a to the end of the collection. Returns true.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

iterator RWTValDeque< T, A >::insert	(	iterator	pos,
		value_type &&	val
	)

inline

Inserts val into self before the element at position pos. Returns an iterator for the newly inserted element.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::insertAt	(	size_type	i,
		const_reference	a
	)

inline

Inserts the item a in front of the item at position i in self.

Exceptions

RWBoundsErr Thrown if this position is not between 0 and the number of entries in the collection.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::insertAt	(	size_type	i,
		value_type &&	a
	)

inline

Inserts the item a in front of the item at position i in self.

Exceptions

RWBoundsErr Thrown if this position is not between 0 and the number of entries in the collection.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::isEmpty ( ) const

inline

Returns true if there are no items in the collection, otherwise false.

template<class T, class A = std::allocator<T>>

reference RWTValDeque< T, A >::last ( void )

inline

Returns a reference to the last item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

const_reference RWTValDeque< T, A >::last ( void ) const

inline

Returns a reference to the last item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

reference RWTValDeque< T, A >::maxElement ( )

inline

Returns a reference to the maximum element in the collection. Type T must have well-defined less-than semantics (T::operator<(const T&) or equivalent).

template<class T, class A = std::allocator<T>>

const_reference RWTValDeque< T, A >::maxElement ( ) const

inline

Returns a reference to the maximum element in the collection. Type T must have well-defined less-than semantics (T::operator<(const T&) or equivalent).

template<class T, class A = std::allocator<T>>

reference RWTValDeque< T, A >::minElement ( )

inline

Returns a reference to the minimum element in the collection. Type T must have well-defined less-than semantics (T::operator<(const T&) or equivalent).

template<class T, class A = std::allocator<T>>

const_reference RWTValDeque< T, A >::minElement ( ) const

inline

Returns a reference to the minimum element in the collection. Type T must have well-defined less-than semantics (T::operator<(const T&) or equivalent).

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::occurrencesOf	(	bool()(const_reference, void )	fn,
		void *	d
	)		const

inline

Returns the number of elements t in self such that the expression ((*fn)(t,d)) is true. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::occurrencesOf ( const_reference a ) const

inline

Returns the number of elements t in self such that the expression (t == a) is true.

template<class T, class A = std::allocator<T>>

reference RWTValDeque< T, A >::operator() ( size_type i )

inline

Returns a reference to the i ^th element of self.

Exceptions

RWBoundsErr Thrown if index i is not between 0 and one less than the number of entries in self.

template<class T, class A = std::allocator<T>>

const_reference RWTValDeque< T, A >::operator() ( size_type i ) const

inline

Returns a reference to the i ^th element of self. Index i should be between 0 and one less than the number of entries, otherwise the results are undefined.

Note: No bounds checking is performed.

template<class T, class A = std::allocator<T>>

RWTValDeque<T, A>& RWTValDeque< T, A >::operator= ( const RWTValDeque< T, A > & rhs )

inline

Calls the destructor on all elements of self and replaces them by copying all elements of rhs.

template<class T, class A = std::allocator<T>>

RWTValDeque<T, A>& RWTValDeque< T, A >::operator= ( const container_type & rhs )

inline

Calls the destructor on all elements of self and replaces them by copying all elements of rhs.

template<class T, class A = std::allocator<T>>

RWTValDeque<T, A>& RWTValDeque< T, A >::operator= ( RWTValDeque< T, A > && rhs )

inline

Move assignment. Self takes ownership of the data owned by rhs.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

RWTValDeque<T, A>& RWTValDeque< T, A >::operator= ( container_type && rhs )

inline

Move assignment. Self takes ownership of the data owned by rhs.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

reference RWTValDeque< T, A >::operator[] ( size_type i )

inline

Returns a reference to the i ^th element of self.

Exceptions

RWBoundsErr Thrown if index i is not between 0 and one less than the number of entries in self.

template<class T, class A = std::allocator<T>>

const_reference RWTValDeque< T, A >::operator[] ( size_type i ) const

inline

Returns a reference to the i ^th element of self.

Exceptions

RWBoundsErr Thrown if index i is not between 0 and one less than the number of entries in self.

template<class T, class A = std::allocator<T>>

value_type RWTValDeque< T, A >::popBack ( )

inline

Removes and returns the last item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

value_type RWTValDeque< T, A >::popFront ( )

inline

Removes and returns the first item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::prepend ( const_reference a )

inline

Adds the item a to the beginning of the collection.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::prepend ( value_type && a )

inline

Adds the item a to the beginning of the collection.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::pushBack ( const_reference a )

inline

Adds the item a to the end of the collection.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::pushBack ( value_type && a )

inline

Adds the item a to the end of the collection.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::pushFront ( const_reference a )

inline

Adds the item a to the beginning of the collection.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::pushFront ( value_type && a )

inline

Adds the item a to the beginning of the collection.

Condition:: This method is available only on platforms with rvalue reference support.

template<class T, class A = std::allocator<T>>

reverse_iterator RWTValDeque< T, A >::rbegin ( )

inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

template<class T, class A = std::allocator<T>>

const_reverse_iterator RWTValDeque< T, A >::rbegin ( ) const

inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::remove ( const_reference a )

inline

Removes the first element t in self such that the expression (t == a) is true and returns true. Returns false if there is no such element.

template<class T, class A = std::allocator<T>>

bool RWTValDeque< T, A >::remove	(	bool()(const_reference, void )	fn,
		void *	d
	)

inline

Removes the first element t in self such that the expression ((*fn)(t,d)) is true, and returns true. Returns false if there is no such element. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::removeAll	(	bool()(const_reference, void )	fn,
		void *	d
	)

inline

Removes all elements t in self such that the expression ((*fn)(t,d)) is true. Returns the number of items removed. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::removeAll ( const_reference a )

inline

Removes all elements t in self such that the expression (t == a) is true. Returns the number of items removed.

template<class T, class A = std::allocator<T>>

value_type RWTValDeque< T, A >::removeAt ( size_type index )

Removes and returns the item at position i in self.

Exceptions

RWBoundsErr Thrown if index i is not between 0 and one less than the number of entries in self.

template<class T, class A = std::allocator<T>>

value_type RWTValDeque< T, A >::removeFirst ( )

inline

Removes and returns the first item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

value_type RWTValDeque< T, A >::removeLast ( )

inline

Removes and returns the last item in the collection.

Calling this function on an empty collection results in undefined behavior.

template<class T, class A = std::allocator<T>>

reverse_iterator RWTValDeque< T, A >::rend ( )

inline

Returns an iterator referring to the element before the first element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class A = std::allocator<T>>

const_reverse_iterator RWTValDeque< T, A >::rend ( ) const

inline

Returns an iterator referring to the element before the first element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::replaceAll	(	bool()(const value_type &, void )	fn,
		void *	d,
		const value_type &	newVal
	)

inline

Replaces all elements t in self such that the expression ((*fn)(t,d)) is true with newVal. Returns the number of items replaced. Client data may be passed through parameter d.

template<class T, class A = std::allocator<T>>

size_type RWTValDeque< T, A >::replaceAll	(	const value_type &	oldVal,
		const value_type &	newVal
	)

inline

Replaces all elements t in self such that the expression (t == oldVal) is true with newVal. Returns the number of items replaced.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::sort ( )

inline

Sorts the collection using the less-than operator to compare elements.

template<class T, class A = std::allocator<T>>

container_type& RWTValDeque< T, A >::std ( )

inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library collections.

template<class T, class A = std::allocator<T>>

const container_type& RWTValDeque< T, A >::std ( ) const

inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library collections.

template<class T, class A = std::allocator<T>>

void RWTValDeque< T, A >::swap ( RWTValDeque< T, A > & rhs )

inline

Swaps the data owned by self with the data owned by rhs.

Friends And Related Function Documentation

template<class T , class A >

bool operator!=	(	const RWTValDeque< T, A > &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator!=	(	const RWTValDeque< T, A > &	lhs,
		const typename RWTValDeque< T, A >::container_type &	rhs
	)

template<class T , class A >

bool operator!=	(	const typename RWTValDeque< T, A >::container_type &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator<	(	const RWTValDeque< T, A > &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator<	(	const RWTValDeque< T, A > &	lhs,
		const typename RWTValDeque< T, A >::container_type &	rhs
	)

template<class T , class A >

bool operator<	(	const typename RWTValDeque< T, A >::container_type &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

RWvostream & operator<<	(	RWvostream &	strm,
		const RWTValDeque< T, A > &	coll
	)

template<class T , class A >

RWFile & operator<<	(	RWFile &	strm,
		const RWTValDeque< T, A > &	coll
	)

template<class T , class A >

bool operator<=	(	const RWTValDeque< T, A > &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator<=	(	const RWTValDeque< T, A > &	lhs,
		const typename RWTValDeque< T, A >::container_type &	rhs
	)

template<class T , class A >

bool operator<=	(	const typename RWTValDeque< T, A >::container_type &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator==	(	const RWTValDeque< T, A > &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and iterating through both collections produces individual elements that, in turn, compare equal to each other.

template<class T , class A >

bool operator==	(	const RWTValDeque< T, A > &	lhs,
		const typename RWTValDeque< T, A >::container_type &	rhs
	)

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and iterating through both collections produces individual elements that, in turn, compare equal to each other.

template<class T , class A >

bool operator==	(	const typename RWTValDeque< T, A >::container_type &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and iterating through both collections produces individual elements that, in turn, compare equal to each other.

template<class T , class A >

bool operator>	(	const RWTValDeque< T, A > &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator>	(	const RWTValDeque< T, A > &	lhs,
		const typename RWTValDeque< T, A >::container_type &	rhs
	)

template<class T , class A >

bool operator>	(	const typename RWTValDeque< T, A >::container_type &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator>=	(	const RWTValDeque< T, A > &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

bool operator>=	(	const RWTValDeque< T, A > &	lhs,
		const typename RWTValDeque< T, A >::container_type &	rhs
	)

template<class T , class A >

bool operator>=	(	const typename RWTValDeque< T, A >::container_type &	lhs,
		const RWTValDeque< T, A > &	rhs
	)

template<class T , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValDeque< T, A > &	coll
	)

template<class T , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTValDeque< T, A > &	coll
	)

template<class T , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValDeque< T, A > *&	p
	)

Looks at the next object on the input stream strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.

template<class T , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTValDeque< T, A > *&	p
	)

Looks at the next object on the RWFile strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.

SourcePro® API Reference Guide

Public Types

Public Member Functions

Related Functions

Detailed Description

template<class T, class A = std::allocator<T>> class RWTValDeque< T, A >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class T, class A = std::allocator<T>>
class RWTValDeque< T, A >