RWTPtrDeque< T, A > Class Template Reference

A pointer-based collection of values, implemented as a double-ended queue, or deque. More...

#include <rw/tpdeque.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
	RWTPtrDeque ()
	RWTPtrDeque (const container_type &deq)
	RWTPtrDeque (const RWTPtrDeque< T, A > &rwdeq)
	RWTPtrDeque (container_type &&deq)
template<typename InputIterator >
	RWTPtrDeque (InputIterator first, InputIterator last)
	RWTPtrDeque (RWTPtrDeque< T, A > &&deq)
	RWTPtrDeque (size_type n, value_type a)
void	append (value_type item)
void	apply (void(*fn)(const T *, void *), void *d) const
void	apply (void(*fn)(reference, void *), void *d)
void	apply (void(*fn)(value_type, void *), void *d)
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 ()
void	clearAndDestroy ()
bool	contains (bool(*fn)(const T *, void *), void *d) const
bool	contains (const T *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 first, iterator last)
iterator	erase (iterator pos)
value_type	find (bool(*fn)(const T *, void *), void *d) const
value_type	find (const T *a) const
reference	first ()
const_reference	first () const
size_type	index (bool(*fn)(const T *, void *), void *d) const
size_type	index (const T *a) const
template<typename InputIterator >
void	insert (iterator pos, InputIterator first, InputIterator last)
void	insert (iterator pos, size_type n, value_type val)
iterator	insert (iterator pos, value_type val)
bool	insert (value_type 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 T *, void *), void *d) const
size_type	occurrencesOf (const T *a) const
reference	operator() (size_type i)
const_reference	operator() (size_type i) const
RWTPtrDeque< T, A > &	operator= (const container_type &rhs)
RWTPtrDeque< T, A > &	operator= (const RWTPtrDeque< T, A > &rhs)
RWTPtrDeque< T, A > &	operator= (container_type &&rhs)
RWTPtrDeque< T, A > &	operator= (RWTPtrDeque< T, A > &&rhs)
reference	operator[] (size_type i)
const_reference	operator[] (size_type i) const
value_type	popBack ()
value_type	popFront ()
void	prepend (value_type a)
void	pushBack (value_type t)
void	pushFront (value_type t)
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
value_type	remove (bool(*fn)(const T *, void *), void *d)
value_type	remove (const T *a)
size_type	removeAll (bool(*fn)(const T *, void *), void *d)
size_type	removeAll (const T *a)
value_type	removeAt (size_type i)
value_type	removeFirst ()
value_type	removeLast ()
reverse_iterator	rend ()
const_reverse_iterator	rend () const
size_type	replaceAll (bool(*fn)(const T *, void *), void *d, value_type newVal)
size_type	replaceAll (const T *oldVal, value_type newVal)
void	sort ()
container_type &	std ()
const container_type &	std () const
void	swap (RWTPtrDeque< T, A > &rhs)

Related Symbols
(Note that these are not member symbols.)
template<class T , class A >
bool	operator!= (const RWTPtrDeque< T, A > &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator!= (const RWTPtrDeque< T, A > &lhs, const typename RWTPtrDeque< T, A >::container_type &rhs)
template<class T , class A >
bool	operator!= (const typename RWTPtrDeque< T, A >::container_type &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator< (const RWTPtrDeque< T, A > &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator< (const RWTPtrDeque< T, A > &lhs, const typename RWTPtrDeque< T, A >::container_type &rhs)
template<class T , class A >
bool	operator< (const typename RWTPtrDeque< T, A >::container_type &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
RWFile &	operator<< (RWFile &strm, const RWTPtrDeque< T, A > &coll)
template<class T , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrDeque< T, A > &coll)
template<class T , class A >
bool	operator<= (const RWTPtrDeque< T, A > &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator<= (const RWTPtrDeque< T, A > &lhs, const typename RWTPtrDeque< T, A >::container_type &rhs)
template<class T , class A >
bool	operator<= (const typename RWTPtrDeque< T, A >::container_type &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator== (const RWTPtrDeque< T, A > &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator== (const RWTPtrDeque< T, A > &lhs, const typename RWTPtrDeque< T, A >::container_type &rhs)
template<class T , class A >
bool	operator== (const typename RWTPtrDeque< T, A >::container_type &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator> (const RWTPtrDeque< T, A > &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator> (const RWTPtrDeque< T, A > &lhs, const typename RWTPtrDeque< T, A >::container_type &rhs)
template<class T , class A >
bool	operator> (const typename RWTPtrDeque< T, A >::container_type &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator>= (const RWTPtrDeque< T, A > &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
bool	operator>= (const RWTPtrDeque< T, A > &lhs, const typename RWTPtrDeque< T, A >::container_type &rhs)
template<class T , class A >
bool	operator>= (const typename RWTPtrDeque< T, A >::container_type &lhs, const RWTPtrDeque< T, A > &rhs)
template<class T , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrDeque< T, A > &coll)
template<class T , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrDeque< T, A > *&p)
template<class T , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrDeque< T, A > &coll)
template<class T , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrDeque< T, A > *&p)

Detailed Description

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

This class maintains a pointer-based collection of values, implemented as a double-ended queue, or deque. Class T is the type pointed to by the 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/tpdeque.h>
RWTPtrDeque<T, A> deq;

See also

Classes RWTPtrDlist, RWTPtrSlist, and RWTPtrOrderedVector also provide a Rogue Wave pointer-based interface to standard sequence collections.

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

Persistence

Isomorphic

Example

In this example, a double-ended queue of ints is exercised.

// tpdeque.cpp
#include <rw/tpdeque.h>
#include <iostream>
 
int main() {
  RWTPtrDeque<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(new int(n));
    } else {
      numbers.pushBack(new int(n));
    }
  }
 
  std::cout << "Numbers partitioned in even and odds: ";
  for (int i = 0; numbers.entries(); ++i) {
    if (i) {
      std::cout << ", ";
    }
    std::cout << *numbers.first();
    delete numbers.popFront();
  }
 
  std::cout << "\n\n";
 
  return 0;
}

Program Output (numbers in output depend on numbers entered):

Input an assortment of integers (EOF to end):
Numbers partitioned in even and odds: 4, 2, 1, 5, 3, 7, 9, 1

Member Typedef Documentation

allocator_type

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

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

A type representing the allocator type for the container.

const_iterator

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

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

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

const_pointer

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

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

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

const_reference

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

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

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

const_reverse_iterator

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

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

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

container_type

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

typedef std::deque<T*, A> RWTPtrDeque< T, A >::container_type

A type representing the underlying implementation container.

difference_type

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

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

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

iterator

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

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

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

pointer

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

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

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

reference

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

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

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

reverse_iterator

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

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

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

size_type

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

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

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

value_type

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

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

A type representing the container's data type.

Constructor & Destructor Documentation

RWTPtrDeque() [1/7]

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

RWTPtrDeque< T, A >::RWTPtrDeque ( )

inline

Constructs an empty, double-ended queue.

RWTPtrDeque() [2/7]

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

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

inline

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

RWTPtrDeque() [3/7]

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

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

inline

Copy constructor.

RWTPtrDeque() [4/7]

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

RWTPtrDeque< T, A >::RWTPtrDeque ( RWTPtrDeque< 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.

RWTPtrDeque() [5/7]

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

RWTPtrDeque< T, A >::RWTPtrDeque ( 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.

RWTPtrDeque() [6/7]

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

RWTPtrDeque< T, A >::RWTPtrDeque ( size_type n, value_type a )

inline

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

RWTPtrDeque() [7/7]

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

template<typename InputIterator >

RWTPtrDeque< T, A >::RWTPtrDeque ( 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

append()

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

void RWTPtrDeque< T, A >::append ( value_type item )

inline

Adds the item a to the end of the collection.

apply() [1/3]

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

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

inline

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

apply() [2/3]

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

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

inline

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

apply() [3/3]

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

void RWTPtrDeque< T, A >::apply ( void(* fn )(value_type, void *), void * d )

inline

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

assign()

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

template<typename InputIterator >

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

at() [1/2]

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

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

at() [2/2]

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

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

begin() [1/2]

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

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

inline

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

If the container is empty, returns end().

begin() [2/2]

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

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

inline

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

If the container is empty, returns end().

cbegin()

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

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

inline

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

If the container is empty, returns end().

cend()

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

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

clear()

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

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

inline

Clears the collection by removing all items from self.

clearAndDestroy()

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

void RWTPtrDeque< T, A >::clearAndDestroy ( )

inline

Removes all items from the collection and uses operator delete to destroy the objects pointed to by those items. Do not use this method if multiple pointers to the same object are stored.

contains() [1/2]

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

bool RWTPtrDeque< T, A >::contains ( bool(* fn )(const T *, void *), 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.

contains() [2/2]

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

bool RWTPtrDeque< T, A >::contains ( const T * a ) const

inline

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

crbegin()

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

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

inline

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

If the container is empty, returns rend().

crend()

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

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

end() [1/2]

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

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

end() [2/2]

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

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

entries()

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

size_type RWTPtrDeque< T, A >::entries ( ) const

inline

Returns the number of elements in self.

erase() [1/2]

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

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

erase() [2/2]

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

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

find() [1/2]

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

value_type RWTPtrDeque< T, A >::find ( bool(* fn )(const T *, void *), void * d ) const

inline

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

find() [2/2]

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

value_type RWTPtrDeque< T, A >::find ( const T * a ) const

inline

If there exists an element t in self such that the expression (*t == *a) is true, returns t, otherwise returns rwnil.

first() [1/2]

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

reference RWTPtrDeque< T, A >::first ( )

inline

Returns a reference to the first item in the collection.

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

first() [2/2]

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

const_reference RWTPtrDeque< T, A >::first ( ) const

inline

Returns a reference to the first item in the collection.

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

index() [1/2]

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

size_type RWTPtrDeque< T, A >::index ( bool(* fn )(const T *, void *), 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.

index() [2/2]

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

size_type RWTPtrDeque< T, A >::index ( const T * 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.

insert() [1/4]

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

template<typename InputIterator >

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

insert() [2/4]

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

void RWTPtrDeque< T, A >::insert ( iterator pos, size_type n, value_type val )

inline

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

insert() [3/4]

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

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

insert() [4/4]

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

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

inline

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

insertAt()

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

void RWTPtrDeque< 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 zero and the number of entries in the collection.

isEmpty()

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

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

inline

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

last() [1/2]

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

reference RWTPtrDeque< T, A >::last ( )

inline

Returns a reference to the last item in the collection.

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

last() [2/2]

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

const_reference RWTPtrDeque< T, A >::last ( ) const

inline

Returns a reference to the last item in the collection.

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

maxElement() [1/2]

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

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

inline

Returns a reference to the maximum element in self.

maxElement() [2/2]

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

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

inline

Returns a reference to the maximum element in self.

minElement() [1/2]

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

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

inline

Returns a reference to the minimum element in self.

minElement() [2/2]

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

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

inline

Returns a reference to the minimum element in self.

occurrencesOf() [1/2]

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

size_type RWTPtrDeque< T, A >::occurrencesOf ( bool(* fn )(const T *, void *), 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.

occurrencesOf() [2/2]

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

size_type RWTPtrDeque< T, A >::occurrencesOf ( const T * a ) const

inline

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

operator()() [1/2]

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

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

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 that no bounds checking is performed.

operator()() [2/2]

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

const_reference RWTPtrDeque< 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 that no bounds checking is performed.

operator=() [1/4]

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

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

inline

Clears all elements of self and replaces them by copying all elements of rhs.

operator=() [2/4]

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

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

inline

Clears all elements of self and replaces them by copying all elements of rhs.

operator=() [3/4]

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

RWTPtrDeque< T, A > & RWTPtrDeque< 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.

operator=() [4/4]

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

RWTPtrDeque< T, A > & RWTPtrDeque< T, A >::operator= ( RWTPtrDeque< 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.

operator[]() [1/2]

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

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

operator[]() [2/2]

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

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

popBack()

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

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

inline

Removes and returns the last item in the collection.

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

popFront()

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

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

inline

Removes and returns the first item in the collection.

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

prepend()

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

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

inline

Adds the item a to the beginning of the collection.

pushBack()

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

void RWTPtrDeque< T, A >::pushBack ( value_type t )

inline

Adds the item t to the end of the collection.

pushFront()

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

void RWTPtrDeque< T, A >::pushFront ( value_type t )

inline

Adds the item t to the front of the collection.

rbegin() [1/2]

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

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

inline

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

If the container is empty, returns rend().

rbegin() [2/2]

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

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

inline

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

If the container is empty, returns rend().

remove() [1/2]

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

value_type RWTPtrDeque< T, A >::remove ( bool(* fn )(const T *, void *), void * d )

inline

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

remove() [2/2]

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

value_type RWTPtrDeque< T, A >::remove ( const T * a )

inline

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

removeAll() [1/2]

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

size_type RWTPtrDeque< T, A >::removeAll ( bool(* fn )(const T *, void *), 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.

removeAll() [2/2]

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

size_type RWTPtrDeque< T, A >::removeAll ( const T * a )

inline

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

removeAt()

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

value_type RWTPtrDeque< T, A >::removeAt ( size_type i )

inline

Removes and returns the item at position i in self.

Exceptions

RWBoundsErr

Thrown if this position is not between zero and one less than the number of entries in the collection.

removeFirst()

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

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

inline

Removes and returns the first item in the collection.

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

removeLast()

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

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

inline

Removes and returns the last item in the collection.

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

rend() [1/2]

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

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

rend() [2/2]

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

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

replaceAll() [1/2]

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

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

inline

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

replaceAll() [2/2]

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

size_type RWTPtrDeque< T, A >::replaceAll ( const T * oldVal, value_type newVal )

inline

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

sort()

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

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

inline

Sorts the collection using the less-than operator to compare elements. Elements are dereferenced before being compared.

std() [1/2]

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

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

inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.

std() [2/2]

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

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

inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.

swap()

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

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

inline

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

Friends And Related Symbol Documentation

operator!=() [1/3]

template<class T , class A >

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

related

Equivalent to !(lhs == rhs).

operator!=() [2/3]

template<class T , class A >

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

related

Equivalent to !(lhs == rhs).

operator!=() [3/3]

template<class T , class A >

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

related

Equivalent to !(lhs == rhs).

operator<() [1/3]

template<class T , class A >

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

operator<() [2/3]

template<class T , class A >

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

operator<() [3/3]

template<class T , class A >

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

operator<<() [1/2]

template<class T , class A >

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

related

Saves the collection coll onto the RWFile strm.

operator<<() [2/2]

template<class T , class A >

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

related

Saves the collection coll onto the output stream strm.

operator<=() [1/3]

template<class T , class A >

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

related

Equivalent to !(rhs < lhs).

operator<=() [2/3]

template<class T , class A >

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

related

Equivalent to !(rhs < lhs).

operator<=() [3/3]

template<class T , class A >

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

related

Equivalent to !(rhs < lhs).

operator==() [1/3]

template<class T , class A >

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

related

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. Elements are dereferenced before being compared.

operator==() [2/3]

template<class T , class A >

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

related

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. Elements are dereferenced before being compared.

operator==() [3/3]

template<class T , class A >

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

related

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. Elements are dereferenced before being compared.

operator>() [1/3]

template<class T , class A >

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

related

Equivalent to (rhs < lhs).

operator>() [2/3]

template<class T , class A >

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

related

Equivalent to (rhs < lhs).

operator>() [3/3]

template<class T , class A >

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

related

Equivalent to (rhs < lhs).

operator>=() [1/3]

template<class T , class A >

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

related

Equivalent to !(lhs < rhs).

operator>=() [2/3]

template<class T , class A >

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

related

Equivalent to !(lhs < rhs).

operator>=() [3/3]

template<class T , class A >

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

related

Equivalent to !(lhs < rhs).

operator>>() [1/4]

template<class T , class A >

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

related

Restores the contents of the collection coll from the RWFile strm.

operator>>() [2/4]

template<class T , class A >

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

related

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.

operator>>() [3/4]

template<class T , class A >

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

related

Restores the contents of the collection coll from the input stream strm.

operator>>() [4/4]

template<class T , class A >

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

related

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.