SourcePro® API Reference Guide

  
List of all members | Public Types | Public Member Functions | Related Functions
RWTPtrSortedDlist< T, C, A > Class Template Reference
SourcePro Core » Essential Tools Module » STL-based Collections

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

#include <rw/tpsrtdli.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 rw_deref_compare< C, T > container_comp
 
typedef std::list< T *, A > container_type
 
typedef container_type::difference_type difference_type
 
typedef container_type::iterator iterator
 
typedef rw_deref_compare< C, T > key_compare
 
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 key_compare value_compare
 
typedef container_type::value_type value_type
 

Public Member Functions

 RWTPtrSortedDlist ()
 
 RWTPtrSortedDlist (const RWTPtrSortedDlist< T, C, A > &t)
 
 RWTPtrSortedDlist (const container_type &lst)
 
 RWTPtrSortedDlist (size_type n, value_type p)
 
 RWTPtrSortedDlist (RWTPtrSortedDlist< T, C, A > &&lst)
 
 RWTPtrSortedDlist (container_type &&lst)
 
template<typename InputIterator >
 RWTPtrSortedDlist (InputIterator first, InputIterator last)
 
void apply (void(*fn)(reference, void *), void *d)
 
void apply (void(*fn)(value_type, void *), void *d)
 
void apply (void(*fn)(const T *, void *), void *d) const
 
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 pos)
 
iterator erase (iterator first, iterator last)
 
const T * find (bool(*fn)(const T *, void *), void *d) const
 
value_type find (const T *a)
 
const T * find (const T *a) const
 
reference first ()
 
const_reference first () const
 
size_type index (const T *a) const
 
size_type index (bool(*fn)(const T *, void *), void *d) const
 
bool insert (value_type a)
 
iterator insert (iterator hint, value_type val)
 
template<typename InputIterator >
void insert (InputIterator first, InputIterator last)
 
size_type insert (const container_type &a)
 
bool isEmpty () const
 
bool isSorted () const
 
value_type & last ()
 
const value_type & last () const
 
size_type merge (const RWTPtrSortedDlist< T, C, A > &coll)
 
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
 
RWTPtrSortedDlist< T, C, A > & operator= (const RWTPtrSortedDlist< T, C, A > &rhs)
 
RWTPtrSortedDlist< T, C, A > & operator= (const container_type &rhs)
 
RWTPtrSortedDlist< T, C, A > & operator= (RWTPtrSortedDlist< T, C, A > &&rhs)
 
RWTPtrSortedDlist< T, C, A > & operator= (container_type &&rhs)
 
reference operator[] (size_type i)
 
const_reference operator[] (size_type i) const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
value_type remove (bool(*fn)(const T *, void *), void *d)
 
value_type remove (const T *key)
 
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
 
container_type & std ()
 
const container_type & std () const
 
void swap (RWTPtrSortedDlist< T, C, A > &lst)
 

Related Functions

(Note that these are not member functions.)

template<class T , class C , class A >
bool operator!= (const RWTPtrSortedDlist< T, C, A > &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator!= (const RWTPtrSortedDlist< T, C, A > &lhs, const typename RWTPtrSortedDlist< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator!= (const typename RWTPtrSortedDlist< T, C, A >::container_type &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator< (const RWTPtrSortedDlist< T, C, A > &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator< (const RWTPtrSortedDlist< T, C, A > &lhs, const typename RWTPtrSortedDlist< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator< (const typename RWTPtrSortedDlist< T, C, A >::container_type &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
RWvostream & operator<< (RWvostream &strm, const RWTPtrSortedDlist< T, C, A > &coll)
 
template<class T , class C , class A >
RWFile & operator<< (RWFile &strm, const RWTPtrSortedDlist< T, C, A > &coll)
 
template<class T , class C , class A >
bool operator<= (const RWTPtrSortedDlist< T, C, A > &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator<= (const RWTPtrSortedDlist< T, C, A > &lhs, const typename RWTPtrSortedDlist< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator<= (const typename RWTPtrSortedDlist< T, C, A >::container_type &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator== (const RWTPtrSortedDlist< T, C, A > &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator== (const RWTPtrSortedDlist< T, C, A > &lhs, const typename RWTPtrSortedDlist< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator== (const typename RWTPtrSortedDlist< T, C, A >::container_type &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator> (const RWTPtrSortedDlist< T, C, A > &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator> (const RWTPtrSortedDlist< T, C, A > &lhs, const typename RWTPtrSortedDlist< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator> (const typename RWTPtrSortedDlist< T, C, A >::container_type &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator>= (const RWTPtrSortedDlist< T, C, A > &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator>= (const RWTPtrSortedDlist< T, C, A > &lhs, const typename RWTPtrSortedDlist< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator>= (const typename RWTPtrSortedDlist< T, C, A >::container_type &lhs, const RWTPtrSortedDlist< T, C, A > &rhs)
 
template<class T , class C , class A >
RWvistream & operator>> (RWvistream &strm, RWTPtrSortedDlist< T, C, A > &coll)
 
template<class T , class C , class A >
RWFile & operator>> (RWFile &strm, RWTPtrSortedDlist< T, C, A > &coll)
 
template<class T , class C , class A >
RWvistream & operator>> (RWvistream &strm, RWTPtrSortedDlist< T, C, A > *&p)
 
template<class T , class C , class A >
RWFile & operator>> (RWFile &strm, RWTPtrSortedDlist< T, C, A > *&p)
 

Detailed Description

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

This class maintains an always-sorted pointer-based collection of values, implemented as a doubly-linked list. Items are ordered according to a comparison object of type C. Class T is the type pointed to by the items in the collection. Class A is an allocator of objects of type T. For more information about using custom allocators, please see the Essential Tools Module User's Guide.

C must induce a total ordering on elements of type T via a public member bool operator()(const T& x, const T& y) that returns true if x should precede y within the collection. The structure std::less<T> from the C++ Standard Library header file <functional> is an example. Note that items in the collection will be dereferenced before being compared.

The value type must have operator== and operator< defined. This requirement is imposed by the C++ Standard Library.

Synopsis
#include <rw/tpsrtdli.h>
RWTPtrSortedDlist<T,C,A> srtdlist;
See also

Class RWTPtrSortedVector is an alternative always-sorted pointer-based collection. RWTPtrDlist is an unsorted pointer-based doubly-linked list.

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

Persistence
Isomorphic
Example
//
// tpsrtdli.cpp
//
#include <iostream>
#include <functional>
#include <rw/tpsrtdli.h>
#include <rw/tools/datetime.h>
int main ()
{
RWTPtrSortedDlist<RWDateTime, std::greater<RWDateTime> > lst;
lst.insert(new RWDateTime("Aug 10, 1991", RWDateTime::setDate));
lst.insert(new RWDateTime("Aug 9, 1991", RWDateTime::setDate));
lst.insert(new RWDateTime("Sep 1, 1991", RWDateTime::setDate));
lst.insert(new RWDateTime("May 14, 1990", RWDateTime::setDate));
lst.insert(new RWDateTime("Sep 1, 1991", RWDateTime::setDate)); // Add a duplicate
lst.insert(new RWDateTime("June 2, 1991", RWDateTime::setDate));
for (size_t i = 0; i < lst.entries(); ++i)
std::cout << lst[i]->asString('x') << std::endl;
lst.clearAndDestroy();
return 0;
}

Program Output:

09/01/91
09/01/91
08/10/91
08/09/91
06/02/91
05/14/90

Member Typedef Documentation

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::allocator_type RWTPtrSortedDlist< T, C, A >::allocator_type

A type representing the allocator type for the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_iterator RWTPtrSortedDlist< T, C, A >::const_iterator

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_pointer RWTPtrSortedDlist< T, C, A >::const_pointer

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_reference RWTPtrSortedDlist< T, C, A >::const_reference

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_reverse_iterator RWTPtrSortedDlist< T, C, A >::const_reverse_iterator

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef rw_deref_compare<C, T> RWTPtrSortedDlist< T, C, A >::container_comp
Deprecated:
As of SourcePro 12.5, use key_compare instead.

A type representing a comparison function that dereferences the arguments before comparing.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef std::list<T*, A> RWTPtrSortedDlist< T, C, A >::container_type

A type representing the underlying implementation container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::difference_type RWTPtrSortedDlist< T, C, A >::difference_type

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::iterator RWTPtrSortedDlist< T, C, A >::iterator

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef rw_deref_compare<C, T> RWTPtrSortedDlist< T, C, A >::key_compare

A type representing a comparison function that dereferences the arguments before comparing.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::pointer RWTPtrSortedDlist< T, C, A >::pointer

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::reference RWTPtrSortedDlist< T, C, A >::reference

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::reverse_iterator RWTPtrSortedDlist< T, C, A >::reverse_iterator

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::size_type RWTPtrSortedDlist< T, C, A >::size_type

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef key_compare RWTPtrSortedDlist< T, C, A >::value_compare

A type representing a comparison function that dereferences the arguments before comparing.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::value_type RWTPtrSortedDlist< T, C, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist ( )
inline

Constructs an empty doubly-linked list.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist ( const RWTPtrSortedDlist< T, C, A > &  t)
inline

Copy constructor.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist ( const container_type &  lst)
inline

Constructs a doubly-linked list by iterating over all elements in lst and performing an order preserving insertion on self for each.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist ( size_type  n,
value_type  p 
)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist ( RWTPtrSortedDlist< T, C, 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.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist ( container_type &&  lst)
inline

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

Condition:
This method is available only on platforms with rvalue reference support.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
template<typename InputIterator >
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist ( InputIterator  first,
InputIterator  last 
)
inline

Constructs a vector by copying elements from the range [first, last).

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

Member Function Documentation

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrSortedDlist< T, C, A >::apply ( void(*)(reference, void *)  fn,
void *  d 
)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrSortedDlist< T, C, A >::apply ( void(*)(value_type, void *)  fn,
void *  d 
)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrSortedDlist< T, C, A >::apply ( void(*)(const T *, void *)  fn,
void *  d 
) const
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reference RWTPtrSortedDlist< T, C, A >::at ( size_type  i)
inline

Returns a reference to the i th element of self.

Exceptions
RWBoundsErrThrown if index i is not between 0 and one less than the number of entries in self.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reference RWTPtrSortedDlist< T, C, A >::at ( size_type  i) const
inline

Returns a reference to the i th element of self.

Exceptions
RWBoundsErrThrown if index i is not between 0 and one less than the number of entries in self.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrSortedDlist< T, C, A >::begin ( )
inline

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

If the container is empty, returns end().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrSortedDlist< T, C, A >::begin ( ) const
inline

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

If the container is empty, returns end().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrSortedDlist< T, C, A >::cbegin ( ) const
inline

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

If the container is empty, returns end().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrSortedDlist< T, C, A >::cend ( ) const
inline

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

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrSortedDlist< T, C, A >::clear ( void  )
inline

Clears the collection by removing all items from self.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrSortedDlist< T, C, A >::clearAndDestroy ( void  )
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrSortedDlist< T, C, A >::contains ( bool(*)(const T *, void *)  fn,
void *  d 
) const
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrSortedDlist< T, C, 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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrSortedDlist< T, C, A >::crbegin ( ) const
inline

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

If the container is empty, returns rend().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrSortedDlist< T, C, A >::crend ( ) const
inline

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

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrSortedDlist< T, C, A >::end ( )
inline

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

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrSortedDlist< T, C, A >::end ( ) const
inline

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

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::entries ( void  ) const
inline

Returns the number of elements in self.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrSortedDlist< T, C, A >::erase ( iterator  pos)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrSortedDlist< T, C, A >::erase ( iterator  first,
iterator  last 
)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const T* RWTPtrSortedDlist< T, C, A >::find ( bool(*)(const T *, void *)  fn,
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrSortedDlist< T, C, A >::find ( const T *  a)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const T* RWTPtrSortedDlist< T, C, 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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reference RWTPtrSortedDlist< T, C, A >::first ( void  )
inline

Returns a reference to the first item in the collection.

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reference RWTPtrSortedDlist< T, C, A >::first ( void  ) const
inline

Returns a reference to the first item in the collection.

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, 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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::index ( bool(*)(const T *, void *)  fn,
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrSortedDlist< T, C, A >::insert ( value_type  a)
inline

Adds the item a to self. The collection remains sorted. Returns true.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrSortedDlist< T, C, A >::insert ( iterator  hint,
value_type  val 
)
inline

Inserts val into self. Returns an iterator to the new item.

The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value should be inserted at a different location according to the container's comparison object.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
template<typename InputIterator >
void RWTPtrSortedDlist< T, C, A >::insert ( InputIterator  first,
InputIterator  last 
)
inline

Inserts the elements in the range [first, last) into self.

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::insert ( const container_type &  a)

Adds the items from a to self in an order preserving way. Returns the number of items inserted.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrSortedDlist< T, C, A >::isEmpty ( ) const
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrSortedDlist< T, C, A >::isSorted ( ) const
inline

Returns true if the collection is sorted relative to the supplied comparator object, otherwise false.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type& RWTPtrSortedDlist< T, C, A >::last ( void  )
inline

Returns a reference to the last item in the collection.

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const value_type& RWTPtrSortedDlist< T, C, A >::last ( void  ) const
inline

Returns a reference to the last item in the collection.

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::merge ( const RWTPtrSortedDlist< T, C, A > &  coll)

Inserts all elements of coll into self, preserving sorted order. Returns the number of items inserted.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::occurrencesOf ( bool(*)(const T *, void *)  fn,
void *  d 
) const
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::occurrencesOf ( const T *  a) const
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reference RWTPtrSortedDlist< T, C, 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
No bounds checking is performed.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reference RWTPtrSortedDlist< T, C, A >::operator() ( size_type  i) const
inline

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

Note
No bounds checking is performed.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist<T, C, A>& RWTPtrSortedDlist< T, C, A >::operator= ( const RWTPtrSortedDlist< T, C, A > &  rhs)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist<T, C, A>& RWTPtrSortedDlist< T, C, A >::operator= ( const container_type &  rhs)
inline

Destroys all elements of self and replaces them by copying (and sorting, if necessary) all elements of rhs.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist<T, C, A>& RWTPtrSortedDlist< T, C, A >::operator= ( RWTPtrSortedDlist< T, C, A > &&  rhs)
inline

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

Condition:
This method is available only on platforms with rvalue reference support.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrSortedDlist<T, C, A>& RWTPtrSortedDlist< T, C, A >::operator= ( container_type &&  rhs)
inline

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

Condition:
This method is available only on platforms with rvalue reference support.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reference RWTPtrSortedDlist< T, C, A >::operator[] ( size_type  i)
inline

Returns a reference to the i th element of self.

Exceptions
RWBoundsErrThrown if index i is not between 0 and one less than the number of entries in self.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reference RWTPtrSortedDlist< T, C, A >::operator[] ( size_type  i) const
inline

Returns a reference to the i th element of self.

Exceptions
RWBoundsErrThrown if index i is not between 0 and one less than the number of entries in self.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reverse_iterator RWTPtrSortedDlist< T, C, A >::rbegin ( )
inline

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

If the container is empty, returns rend().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrSortedDlist< T, C, A >::rbegin ( ) const
inline

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

If the container is empty, returns rend().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrSortedDlist< T, C, A >::remove ( bool(*)(const T *, void *)  fn,
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrSortedDlist< T, C, A >::remove ( const T *  key)
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::removeAll ( bool(*)(const T *, void *)  fn,
void *  d 
)
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrSortedDlist< T, C, A >::removeAll ( const T *  a)

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrSortedDlist< T, C, A >::removeAt ( size_type  i)
inline

Removes and returns the item at position i in self.

Exceptions
RWBoundsErrThrown if this position is not between zero and one less than the number of entries in the collection.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrSortedDlist< T, C, A >::removeFirst ( )
inline

Removes and returns the first item in the collection.

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrSortedDlist< T, C, A >::removeLast ( )
inline

Removes and returns the last item in the collection.

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reverse_iterator RWTPtrSortedDlist< T, C, A >::rend ( )
inline

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

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrSortedDlist< T, C, A >::rend ( ) const
inline

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

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
container_type& RWTPtrSortedDlist< T, C, A >::std ( )
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const container_type& RWTPtrSortedDlist< T, C, A >::std ( ) const
inline

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

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrSortedDlist< T, C, A >::swap ( RWTPtrSortedDlist< T, C, A > &  lst)
inline

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

Friends And Related Function Documentation

template<class T , class C , class A >
bool operator!= ( const RWTPtrSortedDlist< T, C, A > &  lhs,
const RWTPtrSortedDlist< T, C, A > &  rhs 
)
related

Equivalent to !(lhs == rhs).

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

Equivalent to !(lhs == rhs).

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

Equivalent to !(lhs == rhs).

template<class T , class C , class A >
bool operator< ( const RWTPtrSortedDlist< T, C, A > &  lhs,
const RWTPtrSortedDlist< T, C, 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.

template<class T , class C , class A >
bool operator< ( const RWTPtrSortedDlist< T, C, A > &  lhs,
const typename RWTPtrSortedDlist< T, C, 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.

template<class T , class C , class A >
bool operator< ( const typename RWTPtrSortedDlist< T, C, A >::container_type &  lhs,
const RWTPtrSortedDlist< T, C, 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.

template<class T , class C , class A >
RWvostream & operator<< ( RWvostream &  strm,
const RWTPtrSortedDlist< T, C, A > &  coll 
)
related

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

template<class T , class C , class A >
RWFile & operator<< ( RWFile &  strm,
const RWTPtrSortedDlist< T, C, A > &  coll 
)
related

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

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

Equivalent to !(rhs < lhs).

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

Equivalent to !(rhs < lhs).

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

Equivalent to !(rhs < lhs).

template<class T , class C , class A >
bool operator== ( const RWTPtrSortedDlist< T, C, A > &  lhs,
const RWTPtrSortedDlist< T, C, 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.

template<class T , class C , class A >
bool operator== ( const RWTPtrSortedDlist< T, C, A > &  lhs,
const typename RWTPtrSortedDlist< T, C, 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.

template<class T , class C , class A >
bool operator== ( const typename RWTPtrSortedDlist< T, C, A >::container_type &  lhs,
const RWTPtrSortedDlist< T, C, 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.

template<class T , class C , class A >
bool operator> ( const RWTPtrSortedDlist< T, C, A > &  lhs,
const RWTPtrSortedDlist< T, C, A > &  rhs 
)
related

Equivalent to (rhs < lhs).

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

Equivalent to (rhs < lhs).

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

Equivalent to (rhs < lhs).

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

Equivalent to !(lhs < rhs).

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

Equivalent to !(lhs < rhs).

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

Equivalent to !(lhs < rhs).

template<class T , class C , class A >
RWvistream & operator>> ( RWvistream &  strm,
RWTPtrSortedDlist< T, C, A > &  coll 
)
related

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

template<class T , class C , class A >
RWFile & operator>> ( RWFile &  strm,
RWTPtrSortedDlist< T, C, A > &  coll 
)
related

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

template<class T , class C , class A >
RWvistream & operator>> ( RWvistream &  strm,
RWTPtrSortedDlist< T, C, 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.

template<class T , class C , class A >
RWFile & operator>> ( RWFile &  strm,
RWTPtrSortedDlist< T, C, 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.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.