RWTPtrDlist< T, A > Class Template Reference

A pointer-based collection of values, implemented as a doubly-linked list. More...

#include <rw/tpdlist.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 const T *	const_value
typedef std::list< 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
	RWTPtrDlist ()
	RWTPtrDlist (const container_type &lst)
	RWTPtrDlist (const RWTPtrDlist< T, A > &lst)
	RWTPtrDlist (container_type &&lst)
template<typename InputIterator >
	RWTPtrDlist (InputIterator first, InputIterator last)
	RWTPtrDlist (RWTPtrDlist< T, A > &&lst)
	RWTPtrDlist (size_type n, value_type a=0)
void	append (value_type a)
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
value_type	get ()
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
RWTPtrDlist< T, A > &	operator= (const container_type &rhs)
RWTPtrDlist< T, A > &	operator= (const RWTPtrDlist< T, A > &rhs)
RWTPtrDlist< T, A > &	operator= (container_type &&rhs)
RWTPtrDlist< T, A > &	operator= (RWTPtrDlist< T, A > &&rhs)
reference	operator[] (size_type i)
const_reference	operator[] (size_type i) const
void	prepend (value_type a)
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 (RWTPtrDlist< T, A > &rhs)

Friends
auto	operator<=> (const RWTPtrDlist &lhs, const container_type &rhs)
auto	operator<=> (const RWTPtrDlist &lhs, const RWTPtrDlist &rhs)
bool	operator== (const RWTPtrDlist &lhs, const container_type &rhs)
bool	operator== (const RWTPtrDlist &lhs, const RWTPtrDlist &rhs)
class	RWTPtrDlistConstIterator< T, A >
class	RWTPtrDlistIterator< T, A >

Related Symbols
(Note that these are not member symbols.)
template<class T , class A >
RWFile &	operator<< (RWFile &strm, const RWTPtrDlist< T, A > &coll)
template<class T , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrDlist< T, A > &coll)
template<class T , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrDlist< T, A > &coll)
template<class T , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrDlist< T, A > *&p)
template<class T , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrDlist< T, A > &coll)
template<class T , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrDlist< T, A > *&p)

Detailed Description

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

This class maintains a pointer-based collection of values, implemented as a doubly-linked list. 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/tpdlist.h>
RWTPtrDlist<T, A> dlist;

See also

Classes RWTPtrDeque, RWTPtrSlist, and RWTPtrOrderedVector also provide a Rogue Wave pointer-based interface to C++ Standard Library sequence collections.

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

Persistence

Isomorphic

Example

In this example, a pointer-based doubly-linked list of user type Dog is exercised.

//
// tpdlist.cpp
//
#include <rw/tpdlist.h>
#include <iostream>
#include <string.h>
 
class Dog {
  RWCString name_;
 
 public:
  Dog(const char* s) : name_(s) {}
 
  // Define a copy constructor:
  Dog(const Dog& ref) : name_(ref.name_) {}
 
  // Define an assignment operator:
  Dog& operator=(const Dog& ref) {
    if (this == &ref) {
      return *this;
    }
 
    name_ = ref.name_;
    return *this;
  }
 
  // Define an equality test operator:
  bool operator==(const Dog& ref) const { return name_ == ref.name_; }
 
  // Order alphabetically by name:
  bool operator<(const Dog& ref) const { return name_ < ref.name_; }
 
  friend std::ostream& operator<<(std::ostream& s, const Dog& ref) {
    s << ref.name_;
    return s;
  }
};
 
int main() {
  RWTPtrDlist<Dog> terriers;
 
  terriers.insert(new Dog("Cairn Terrier"));
  terriers.insert(new Dog("Irish Terrier"));
  terriers.insert(new Dog("Schnauzer"));
 
  Dog key1("Schnauzer");
  std::cout << "The list "
            << (terriers.contains(&key1) ? "does " : "does not ")
            << "contain a Schnauzer\n";
 
  Dog key2("Irish Terrier");
  terriers.insertAt(terriers.index(&key2), new Dog("Fox Terrier"));
 
  Dog* d;
  while (!terriers.isEmpty()) {
    d = terriers.get();
    std::cout << *d << std::endl;
    delete d;
  }
 
  return 0;
}

Program Output:

The list does contain a Schnauzer
Cairn Terrier
Fox Terrier
Irish Terrier
Schnauzer

Member Typedef Documentation

allocator_type

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

typedef container_type::allocator_type RWTPtrDlist< 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 RWTPtrDlist< T, A >::const_iterator

A type that provides a const bidirectional iterator over the elements in the container.

const_pointer

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

typedef container_type::const_pointer RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::const_reverse_iterator

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

const_value

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

typedef const T* RWTPtrDlist< T, A >::const_value

Deprecated

As of SourcePro 12.5, use const T* instead. A type representing the container's const data type.

container_type

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

typedef std::list<T*, A> RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::iterator

A type that provides a bidirectional iterator over the elements in the container.

pointer

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

typedef container_type::pointer RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::reverse_iterator

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

size_type

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

typedef container_type::size_type RWTPtrDlist< 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 RWTPtrDlist< T, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

RWTPtrDlist() [1/7]

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

RWTPtrDlist< T, A >::RWTPtrDlist ( )

inline

Constructs an empty, doubly-linked list.

RWTPtrDlist() [2/7]

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

RWTPtrDlist< T, A >::RWTPtrDlist ( const container_type & lst )

inline

Constructs a pointer-based doubly linked list by copying all elements of lst.

RWTPtrDlist() [3/7]

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

RWTPtrDlist< T, A >::RWTPtrDlist ( const RWTPtrDlist< T, A > & lst )

inline

Copy constructor.

RWTPtrDlist() [4/7]

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

RWTPtrDlist< T, A >::RWTPtrDlist ( RWTPtrDlist< T, A > && lst )

inline

Move constructor. The constructed list takes ownership of the data owned by lst.

Condition:

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

RWTPtrDlist() [5/7]

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

RWTPtrDlist< T, A >::RWTPtrDlist ( container_type && lst )

inline

Move constructor. The constructed list takes ownership of the data owned by lst.

Condition:

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

RWTPtrDlist() [6/7]

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

RWTPtrDlist< T, A >::RWTPtrDlist ( size_type n, value_type a = 0 )

inlineexplicit

Constructs a doubly-linked list with n elements, each initialized to a.

RWTPtrDlist() [7/7]

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

template<typename InputIterator >

RWTPtrDlist< T, A >::RWTPtrDlist ( 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 RWTPtrDlist< T, A >::append ( value_type a )

inline

Adds the item a to the end of the collection.

apply() [1/3]

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

void RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::clear ( )

inline

Clears the collection by removing all items from self.

clearAndDestroy()

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

void RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::contains ( const T * a ) const

inline

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

crbegin()

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

const_reverse_iterator RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::entries ( ) const

inline

Returns the number of elements in self.

erase() [1/2]

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

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

get()

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

value_type RWTPtrDlist< T, A >::get ( )

inline

Removes and returns 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 RWTPtrDlist< T, A >::index	(	bool(*	fn )(const T *, void *),
		void *	d ) const

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 RWTPtrDlist< T, A >::index

(

const T *

a

)

const

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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::isEmpty ( ) const

inline

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

last() [1/2]

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

reference RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< T, A >::operator() ( size_type i )

inline

Returns a reference to the i ^th element of self. Index i must 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 RWTPtrDlist< T, A >::operator() ( size_type i ) const

inline

Returns a reference to the i ^th element of self. Index i must 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*>>

RWTPtrDlist< T, A > & RWTPtrDlist< 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*>>

RWTPtrDlist< T, A > & RWTPtrDlist< T, A >::operator= ( const RWTPtrDlist< 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*>>

RWTPtrDlist< T, A > & RWTPtrDlist< 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*>>

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

prepend()

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

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

inline

Adds the item a to the beginning of the collection.

rbegin() [1/2]

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

reverse_iterator RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 RWTPtrDlist< 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 & RWTPtrDlist< 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 & RWTPtrDlist< 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 RWTPtrDlist< T, A >::swap ( RWTPtrDlist< T, A > & rhs )

inline

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

Friends And Related Symbol Documentation

operator<<() [1/2]

template<class T , class A >

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

related

Saves the collection coll onto the RWFile strm, or a reference to it if it has already been saved.

operator<<() [2/2]

template<class T , class A >

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

related

Saves the collection coll onto the output stream strm, or a reference to it if it has already been saved.

operator<=> [1/2]

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

auto operator<=> ( const RWTPtrDlist< T, A > & lhs, const container_type & rhs )

friend

Performs lexicographical comparison of lhs to rhs. Elements are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

The return type is derived from the type being compared. If T supports three-way comparison, the return type is decltype(t <=> t), where t is an instance of T. Otherwise, the return type is std::weak_ordering.

Note

If a compiler does not support rewritten expressions (i.e. before C++20), comparison operators are explicitly implemented to provide equivalent behavior.

operator<=> [2/2]

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

auto operator<=> ( const RWTPtrDlist< T, A > & lhs, const RWTPtrDlist< T, A > & rhs )

friend

Performs lexicographical comparison of lhs to rhs. Elements are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

The return type is derived from the type being compared. If T supports three-way comparison, the return type is decltype(t <=> t), where t is an instance of T. Otherwise, the return type is std::weak_ordering.

Note

If a compiler does not support rewritten expressions (i.e. before C++20), comparison operators are explicitly implemented to provide equivalent behavior.

operator== [1/2]

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

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

friend

Returns true if lhs and rhs are equal. Otherwise, returns false. Two collections are equal if they 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.

Note

If a compiler does not support rewritten expressions (i.e. before C++20), equality operators are explicitly implemented to provide equivalent behavior.

operator== [2/2]

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

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

friend

Returns true if lhs and rhs are equal. Otherwise, returns false. Two collections are equal if they 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.

Note

If a compiler does not support rewritten expressions (i.e. before C++20), equality operators are explicitly implemented to provide equivalent behavior.

operator>>() [1/4]

template<class T , class A >

RWFile & operator>> ( RWFile & strm, RWTPtrDlist< 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, RWTPtrDlist< 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, RWTPtrDlist< 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, RWTPtrDlist< 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.