SourcePro® API Reference Guide

 
List of all members | Public Types | Public Member Functions
RWTValSortedVector< bool, C, A > Class Template Reference

Maintains a sorted collection of boolean values implemented as a vector. More...

#include <rw/tvsrtvec.h>

Public Types

typedef container_type::allocator_type allocator_type
 
typedef container_type::const_iterator const_iterator
 
typedef container_type::const_pointer const_pointer
 
typedef container_type::const_reference const_reference
 
typedef container_type::const_reverse_iterator const_reverse_iterator
 
typedef std::vector< bool, A > container_type
 
typedef container_type::difference_type difference_type
 
typedef container_type::iterator iterator
 
typedef C 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 C value_compare
 
typedef container_type::value_type value_type
 

Public Member Functions

 RWTValSortedVector ()
 
 RWTValSortedVector (const RWTValSortedVector< bool, C, A > &t)
 
 RWTValSortedVector (const container_type &vec)
 
 RWTValSortedVector (size_type n, const bool &val)
 
 RWTValSortedVector (const bool *first, const bool *last)
 
template<typename InputIterator >
 RWTValSortedVector (InputIterator first, InputIterator last)
 
 RWTValSortedVector (size_type n)
 
 RWTValSortedVector (RWTValSortedVector &&rhs)
 
 RWTValSortedVector (container_type &&rhs)
 
void apply (void(*fn)(const_reference, void *), void *d) const
 
reference at (size_type i)
 
const_reference at (size_type i) const
 
iterator begin ()
 
const_iterator begin () const
 
size_type capacity () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
void clear ()
 
bool contains (bool(*fn)(const_reference, void *), void *d) const
 
bool contains (const_reference a) const
 
const_reverse_iterator crbegin () const
 
const_reverse_iterator crend () const
 
iterator end ()
 
const_iterator end () const
 
size_type entries () const
 
iterator erase (iterator pos)
 
iterator erase (iterator first, iterator last)
 
bool find (bool(*fn)(const_reference, void *), void *d, value_type &k) const
 
bool find (const_reference a, value_type &k) const
 
reference first ()
 
const_reference first () const
 
size_type index (bool(*fn)(const_reference, void *), void *d) const
 
size_type index (const_reference a) const
 
bool insert (const_reference a)
 
iterator insert (iterator hint, const_reference val)
 
template<typename InputIterator >
void insert (InputIterator first, InputIterator last)
 
size_type insert (const container_type &a)
 
bool isEmpty () const
 
bool isSorted () const
 
reference last ()
 
const_reference last () const
 
size_type length () const
 
size_type merge (const RWTValSortedVector< bool, C, A > &coll)
 
size_type occurrencesOf (bool(*fn)(const_reference, void *), void *d) const
 
size_type occurrencesOf (const_reference a) const
 
reference operator() (size_type i)
 
const_reference operator() (size_type i) const
 
RWTValSortedVectoroperator= (const RWTValSortedVector &rhs)
 
RWTValSortedVectoroperator= (const container_type &x)
 
RWTValSortedVectoroperator= (RWTValSortedVector &&rhs)
 
RWTValSortedVectoroperator= (container_type &&rhs)
 
reference operator[] (size_type i)
 
const_reference operator[] (size_type i) const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
bool remove (bool(*fn)(const_reference, void *), void *d)
 
bool remove (const_reference a)
 
size_type removeAll (bool(*fn)(const_reference, void *), void *d)
 
size_type removeAll (const_reference a)
 
value_type removeAt (size_type i)
 
value_type removeFirst ()
 
value_type removeLast ()
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
void resize (size_t n)
 
container_typestd ()
 
const container_typestd () const
 
void swap (RWTValSortedVector< bool, C, A > &rhs)
 

Detailed Description

template<class C, class A>
class RWTValSortedVector< bool, C, A >

This class maintains an always-sorted collection of boolean values, implemented as a vector.

Class A is an allocator of objects of type bool. For more information about using custom allocators, please see the Essential Tools Module User's Guide.

The specialization of RWTValSortedVector<bool,C,A> differs from the primary template in that it provides a more efficient memory representation of the boolean array and it does not provide a data() member function.

Synopsis
#include <rw/tvsrtvec.h>
See also

RWTValSortedDlist is an alternative always-sorted collection. RWTValOrderedVector<bool,A> is an unsorted vector of boolean values.

Class RWTValSortedVector provides a generic always-sorted vector for non-boolean types.

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

Persistence
Isomorphic
Example
#include <iostream>
#include <rw/tvsrtvec.h>
int main ()
{
vec.insert(true);
vec.insert(false);
vec.insert(true); // add a duplicate
for (size_t i = 0; i < vec.entries (); ++i)
std::cout << vec[i] << "\n";
return 0;
}

Program Output:

false
true
true

Member Typedef Documentation

template<class C , class A >
typedef container_type::allocator_type RWTValSortedVector< bool, C, A >::allocator_type

A type representing the allocator type for the container.

template<class C , class A >
typedef container_type::const_iterator RWTValSortedVector< bool, C, A >::const_iterator

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

template<class C , class A >
typedef container_type::const_pointer RWTValSortedVector< bool, C, A >::const_pointer

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

template<class C , class A >
typedef container_type::const_reference RWTValSortedVector< bool, C, A >::const_reference

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

template<class C , class A >
typedef container_type::const_reverse_iterator RWTValSortedVector< bool, C, A >::const_reverse_iterator

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

template<class C , class A >
typedef std::vector<bool, A> RWTValSortedVector< bool, C, A >::container_type

A type representing the underlying implementation container.

template<class C , class A >
typedef container_type::difference_type RWTValSortedVector< bool, C, A >::difference_type

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

template<class C , class A >
typedef container_type::iterator RWTValSortedVector< bool, C, A >::iterator

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

template<class C , class A >
typedef C RWTValSortedVector< bool, C, A >::key_compare

A type representing the comparison function.

template<class C , class A >
typedef container_type::pointer RWTValSortedVector< bool, C, A >::pointer

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

template<class C , class A >
typedef container_type::reference RWTValSortedVector< bool, C, A >::reference

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

template<class C , class A >
typedef container_type::reverse_iterator RWTValSortedVector< bool, C, A >::reverse_iterator

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

template<class C , class A >
typedef container_type::size_type RWTValSortedVector< bool, C, A >::size_type

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

template<class C , class A >
typedef C RWTValSortedVector< bool, C, A >::value_compare

A type representing the comparison function.

template<class C , class A >
typedef container_type::value_type RWTValSortedVector< bool, C, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( )
inline

Constructs an empty vector.

template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( const RWTValSortedVector< bool, C, A > &  t)
inline

Copy constructor.

template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( const container_type vec)
inline

Constructs a vector by copying and sorting all elements of vec.

template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( size_type  n,
const bool &  val 
)
inline

Constructs a vector with n elements, each initialized to val.

template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( const bool *  first,
const bool *  last 
)
inline

Constructs a vector by copying and sorting elements from the array of Ts pointed to by first, up to, but not including, the element pointed to by last.

template<class C , class A >
template<typename InputIterator >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( 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.

template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( size_type  n)
inline

Constructs an empty vector with a capacity of n elements.

template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( RWTValSortedVector< bool, C, A > &&  rhs)
inline

Move constructor. The constructed instance takes ownership of the data owned by rhs.

Condition:
This method is available only on platforms with rvalue reference support.
template<class C , class A >
RWTValSortedVector< bool, C, A >::RWTValSortedVector ( container_type &&  rhs)
inline

Move constructor. The constructed instance sorts and takes ownership of the data owned by rhs.

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

Member Function Documentation

template<class C , class A >
void RWTValSortedVector< bool, C, A >::apply ( void(*)(const_reference, void *)  fn,
void *  d 
) const
inline

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

template<class C , class A >
reference RWTValSortedVector< bool, 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 C , class A >
const_reference RWTValSortedVector< bool, 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 C , class A >
iterator RWTValSortedVector< bool, C, A >::begin ( )
inline

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

If the container is empty, returns end().

template<class C , class A >
const_iterator RWTValSortedVector< bool, 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 C , class A >
size_type RWTValSortedVector< bool, C, A >::capacity ( ) const
inline

Returns the maximum number of elements that can be stored in self without first resizing.

template<class C , class A >
const_iterator RWTValSortedVector< bool, 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 C , class A >
const_iterator RWTValSortedVector< bool, 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 C , class A >
void RWTValSortedVector< bool, C, A >::clear ( void  )
inline

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

template<class C , class A >
bool RWTValSortedVector< bool, C, A >::contains ( bool(*)(const_reference, void *)  fn,
void *  d 
) const
inline

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

template<class C , class A >
bool RWTValSortedVector< bool, C, A >::contains ( const_reference  a) const
inline

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

template<class C , class A >
const_reverse_iterator RWTValSortedVector< bool, 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 C , class A >
const_reverse_iterator RWTValSortedVector< bool, 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 C , class A >
iterator RWTValSortedVector< bool, 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 C , class A >
const_iterator RWTValSortedVector< bool, 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 C , class A >
size_type RWTValSortedVector< bool, C, A >::entries ( void  ) const
inline

Returns the number of elements in self.

template<class C , class A >
iterator RWTValSortedVector< bool, 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 C , class A >
iterator RWTValSortedVector< bool, 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 C , class A >
bool RWTValSortedVector< bool, C, A >::find ( bool(*)(const_reference, void *)  fn,
void *  d,
value_type k 
) const
inline

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

template<class C , class A >
bool RWTValSortedVector< bool, C, A >::find ( const_reference  a,
value_type k 
) const
inline

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

template<class C , class A >
reference RWTValSortedVector< bool, 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 C , class A >
const_reference RWTValSortedVector< bool, 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 C , class A >
size_type RWTValSortedVector< bool, C, A >::index ( bool(*)(const_reference, void *)  fn,
void *  d 
) const
inline

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

template<class C , class A >
size_type RWTValSortedVector< bool, C, A >::index ( const_reference  a) const
inline

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

template<class C , class A >
bool RWTValSortedVector< bool, C, A >::insert ( const_reference  a)
inline

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

template<class C , class A >
iterator RWTValSortedVector< bool, C, A >::insert ( iterator  hint,
const_reference  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 containers comparison object.

template<class C , class A >
template<typename InputIterator >
void RWTValSortedVector< bool, 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 C , class A >
size_type RWTValSortedVector< bool, C, A >::insert ( const container_type a)

Inserts all elements of a into self. The collection remains sorted. Returns the number of items inserted.

template<class C , class A >
bool RWTValSortedVector< bool, C, A >::isEmpty ( ) const
inline

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

template<class C , class A >
bool RWTValSortedVector< bool, C, A >::isSorted ( ) const
inline

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

template<class C , class A >
reference RWTValSortedVector< bool, 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 C , class A >
const_reference RWTValSortedVector< bool, 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 C , class A >
size_type RWTValSortedVector< bool, C, A >::length ( ) const
inline

Returns the number of elements in self.

Deprecated:
As of SourcePro 13, use entries() instead.
template<class C , class A >
size_type RWTValSortedVector< bool, C, A >::merge ( const RWTValSortedVector< bool, C, A > &  coll)

Inserts all elements of coll into self, preserving sorted order.

template<class C , class A >
size_type RWTValSortedVector< bool, C, A >::occurrencesOf ( bool(*)(const_reference, void *)  fn,
void *  d 
) const
inline

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

template<class C , class A >
size_type RWTValSortedVector< bool, C, A >::occurrencesOf ( const_reference  a) const
inline

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

template<class C , class A >
reference RWTValSortedVector< bool, 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 C , class A >
const_reference RWTValSortedVector< bool, 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 C , class A >
RWTValSortedVector& RWTValSortedVector< bool, C, A >::operator= ( const RWTValSortedVector< bool, C, A > &  rhs)
inline

Assignment operator.

template<class C , class A >
RWTValSortedVector& RWTValSortedVector< bool, C, A >::operator= ( const container_type x)
inline

Assignment operator. Copies and sorts elements from the data in x.

template<class C , class A >
RWTValSortedVector& RWTValSortedVector< bool, C, A >::operator= ( RWTValSortedVector< bool, 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 C , class A >
RWTValSortedVector& RWTValSortedVector< bool, 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 C , class A >
reference RWTValSortedVector< bool, 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 C , class A >
const_reference RWTValSortedVector< bool, 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 C , class A >
reverse_iterator RWTValSortedVector< bool, C, A >::rbegin ( )
inline

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

If the container is empty, returns rend().

template<class C , class A >
const_reverse_iterator RWTValSortedVector< bool, 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 C , class A >
bool RWTValSortedVector< bool, C, A >::remove ( bool(*)(const_reference, void *)  fn,
void *  d 
)
inline

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

template<class C , class A >
bool RWTValSortedVector< bool, C, A >::remove ( const_reference  a)
inline

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

template<class C , class A >
size_type RWTValSortedVector< bool, C, A >::removeAll ( bool(*)(const_reference, void *)  fn,
void *  d 
)
inline

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

template<class C , class A >
size_type RWTValSortedVector< bool, C, A >::removeAll ( const_reference  a)

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

template<class C , class A >
value_type RWTValSortedVector< bool, C, A >::removeAt ( size_type  i)

Removes and returns the item at position i in self.

Exceptions
RWBoundsErrThrown if this position is not between 0 and one less than the number of entries in the collection.
template<class C , class A >
value_type RWTValSortedVector< bool, 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 C , class A >
value_type RWTValSortedVector< bool, 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 C , class A >
reverse_iterator RWTValSortedVector< bool, 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 C , class A >
const_reverse_iterator RWTValSortedVector< bool, 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 C , class A >
void RWTValSortedVector< bool, C, A >::resize ( size_t  n)
inline

Modifies, if necessary, the capacity of the vector to be at least as large as n.

template<class C , class A >
container_type& RWTValSortedVector< bool, C, A >::std ( )
inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. It is the application's responsibility to not violate the ordering of the elements within the collection.

template<class C , class A >
const container_type& RWTValSortedVector< bool, C, A >::std ( ) const
inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. It is the application's responsibility to not violate the ordering of the elements within the collection.

template<class C , class A >
void RWTValSortedVector< bool, C, A >::swap ( RWTValSortedVector< bool, C, A > &  rhs)
inline

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

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