RWTPtrSlist< T, A > Class Template Reference

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

#include <rw/tpslist.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 rw_slist< 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::size_type	size_type
typedef container_type::value_type	value_type

Public Member Functions
	RWTPtrSlist ()
	RWTPtrSlist (const container_type &lst)
	RWTPtrSlist (const RWTPtrSlist< T, A > &lst)
	RWTPtrSlist (container_type &&lst)
template<typename InputIterator >
	RWTPtrSlist (InputIterator first, InputIterator last)
	RWTPtrSlist (RWTPtrSlist< T, A > &&lst)
	RWTPtrSlist (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)(value_type &, 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
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
value_type &	last ()
const value_type &	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
RWTPtrSlist< T, A > &	operator= (const rw_slist< T *, A > &rhs)
RWTPtrSlist< T, A > &	operator= (const RWTPtrSlist< T, A > &rhs)
RWTPtrSlist< T, A > &	operator= (rw_slist< T *, A > &&rhs)
RWTPtrSlist< T, A > &	operator= (RWTPtrSlist< T, A > &&rhs)
reference	operator[] (size_type i)
const_reference	operator[] (size_type i) const
void	prepend (value_type a)
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 ()
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 (RWTPtrSlist< T, A > &rhs)

Friends
class	RWTPtrSlistIterator< T, A >

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

Detailed Description

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

This class maintains a pointer-based collection of values, implemented as a singly-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/tpslist.h>
RWTPtrSlist<T, A> slist;

See also

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

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

Persistence

Isomorphic

Example

//
// tpslist.cpp
//
#include <rw/tools/datetime.h>
#include <rw/tpslist.h>
 
int main() {
  RWTPtrSlist<RWDateTime> dates;
 
  dates.insert(
      new RWDateTime("June 2, 52", RWDateTime::setDate));  // 6/2/52
  dates.insert(
      new RWDateTime("March 30, 46", RWDateTime::setDate));  // 3/30/46
  dates.insert(
      new RWDateTime("April 1, 90", RWDateTime::setDate));  // 4/1/90
 
  // Now look for one of the dates:
  RWDateTime key("June 2, 52", RWDateTime::setDate);
 
  RWDateTime* d = dates.find(&key);
 
  if (d) {
    std::cout << "Found date is: " << d->asString('x') << std::endl;
  }
 
  // Remove in reverse order:
  while (!dates.isEmpty()) {
    d = dates.removeLast();
    std::cout << d->asString('x') << "\n";
    delete d;
  }
  return 0;
}

Program Output:

Found date is: 6/02/52
4/01/90
3/30/46
6/02/52

Member Typedef Documentation

allocator_type

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

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

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

const_pointer

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

typedef container_type::const_pointer RWTPtrSlist< 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 RWTPtrSlist< T, A >::const_reference

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

container_type

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

typedef rw_slist<T*, A> RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::iterator

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

pointer

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

typedef container_type::pointer RWTPtrSlist< 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 RWTPtrSlist< T, A >::reference

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

size_type

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

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

A type representing the container's data type.

Constructor & Destructor Documentation

RWTPtrSlist() [1/7]

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

RWTPtrSlist< T, A >::RWTPtrSlist ( )

inline

Constructs an empty, singly-linked list.

RWTPtrSlist() [2/7]

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

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

inline

Constructs a singly-linked list by copying all elements of lst.

RWTPtrSlist() [3/7]

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

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

inline

Copy constructor.

RWTPtrSlist() [4/7]

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

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

RWTPtrSlist() [5/7]

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

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

RWTPtrSlist() [6/7]

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

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

inline

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

RWTPtrSlist() [7/7]

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

template<typename InputIterator >

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

apply() [3/3]

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

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

inline

Clears the collection by removing all items from self.

clearAndDestroy()

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

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

end() [1/2]

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

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

inline

Returns the number of elements in self.

erase() [1/2]

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

iterator RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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*>>

value_type & RWTPtrSlist< 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 value_type & RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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

No bounds checking is performed.

operator()() [2/2]

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

const_reference RWTPtrSlist< 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

No bounds checking is performed.

operator=() [1/4]

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

RWTPtrSlist< T, A > & RWTPtrSlist< T, A >::operator= ( const rw_slist< T *, A > & rhs )

inline

Empties self, then inserts all elements of rhs.

operator=() [2/4]

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

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

inline

Empties self, then inserts all elements of rhs.

operator=() [3/4]

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

RWTPtrSlist< T, A > & RWTPtrSlist< T, A >::operator= ( rw_slist< 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=() [4/4]

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

RWTPtrSlist< T, A > & RWTPtrSlist< T, A >::operator= ( RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::prepend ( value_type a )

inline

Adds the item a to the beginning of the collection.

remove() [1/2]

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

value_type RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::removeLast ( )

inline

Removes and returns the last item in the collection.

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

replaceAll() [1/2]

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

size_type RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::sort

(

)

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 & RWTPtrSlist< 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 & RWTPtrSlist< 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 RWTPtrSlist< T, A >::swap ( RWTPtrSlist< 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 RWTPtrSlist< T, A > & lhs, const RWTPtrSlist< T, A > & rhs )

related

Equivalent to !(lhs == rhs).

operator!=() [2/3]

template<class T , class A >

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

related

Equivalent to !(lhs == rhs).

operator!=() [3/3]

template<class T , class A >

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

related

Equivalent to !(lhs == rhs).

operator<() [1/3]

template<class T , class A >

bool operator< ( const RWTPtrSlist< T, A > & lhs, const RWTPtrSlist< 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. Elements are dereferenced before being compared.

operator<() [2/3]

template<class T , class A >

bool operator< ( const RWTPtrSlist< T, A > & lhs, const typename RWTPtrSlist< 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. Elements are dereferenced before being compared.

operator<() [3/3]

template<class T , class A >

bool operator< ( const typename RWTPtrSlist< T, A >::container_type & lhs, const RWTPtrSlist< 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. Elements are dereferenced before being compared.

operator<<() [1/2]

template<class T , class A >

RWFile & operator<< ( RWFile & strm, const RWTPtrSlist< 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 RWTPtrSlist< 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/3]

template<class T , class A >

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

related

Equivalent to !(rhs < lhs).

operator<=() [2/3]

template<class T , class A >

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

related

Equivalent to !(rhs < lhs).

operator<=() [3/3]

template<class T , class A >

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

related

Equivalent to !(rhs < lhs).

operator==() [1/3]

template<class T , class A >

bool operator== ( const RWTPtrSlist< T, A > & lhs, const RWTPtrSlist< 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 RWTPtrSlist< T, A > & lhs, const typename RWTPtrSlist< 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 RWTPtrSlist< T, A >::container_type & lhs, const RWTPtrSlist< 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 RWTPtrSlist< T, A > & lhs, const RWTPtrSlist< T, A > & rhs )

related

Equivalent to (rhs < lhs).

operator>() [2/3]

template<class T , class A >

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

related

Equivalent to (rhs < lhs).

operator>() [3/3]

template<class T , class A >

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

related

Equivalent to (rhs < lhs).

operator>=() [1/3]

template<class T , class A >

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

related

Equivalent to !(lhs < rhs).

operator>=() [2/3]

template<class T , class A >

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

related

Equivalent to !(lhs < rhs).

operator>=() [3/3]

template<class T , class A >

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

related

Equivalent to !(lhs < rhs).

operator>>() [1/4]

template<class T , class A >

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