SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND


Platform::Containers
Template Class SortedSet

GeneralContainerType
   |
   +-GeneralCollectionType
        |
        +-GeneralSetType
             |
             +-SortedSet

Implemented in:
Platform.Containers.SortedSet.h

template <typename Element, typename Comparator = Lang::TypeActors::Comparator<Element>>
class SortedSet:
public GeneralSetType

A dynamically sized, ordered set container.

See Also:
Containers

Inner Compounds, Typedefs, and Enumscollapse
struct Position
          DOCTODO.
typedef ComparatorType
          DOCTODO.
typedef ElementType
          DOCTODO.
typedef EntryType
          DOCTODO.

Inner Compounds, Typedefs, and Enums inherited from class GeneralSetTypecollapse
ConstEnumerator, ConstIterator, Enumerator, Iterator

Fields inherited from class GeneralContainerTypecollapse
base

Constructor Summarycollapse
SortedSet()
          DOCTODO.
SortedSet(const SortedSet& container)
          DOCTODO.
template <typename ContainerX>
SortedSet(const ContainerX& container)

          DOCTODO.
~SortedSet()
          Destructor.

Method Summarycollapse
template <typename Collection,
typename Predicate>
Collection&
collectEntries(Collection& collection, Predicate function) const
          DOCTODO.
template <typename Collection>
Collection&
collectEntriesRange(Collection& collection, const Position& fromPos, const Position& toPos) const
          DOCTODO.
Position equal(const ElementType& key) const
          DOCTODO.
ElementType extractFirst()
          Removes and returns the least key in this map.
ElementType extractLast()
          Removes and returns the greatest key in this map.
const ElementType& first() const
          DOCTODO.
Position highest() const
          DOCTODO.
Position highestLessThan(const ElementType& key, Bool predecessor = False) const
          DOCTODO.
const ElementType& last() const
          DOCTODO.
Position lowest() const
          DOCTODO.
Position lowestGreaterThan(const ElementType& key, Bool successor = False) const
          DOCTODO.
SortedSet& operator=(const SortedSet& container)
          DOCTODO.
Position predecessor(const Position& position) const
          DOCTODO.
Void removeFirst()
          DOCTODO.
Void removeLast()
          DOCTODO.
Int removeRange(const Position& fromPos, const Position& toPos)
          DOCTODO.
Position successor(const Position& position) const
          DOCTODO.

Methods inherited from class GeneralContainerTypecollapse
compareTo, deepSize, empty, equals, exchangeWith, hashCode, isEmpty, size, toString, toXml

Methods inherited from class GeneralCollectionTypecollapse
contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll

Methods inherited from class GeneralSetTypecollapse
add, addAll, addAll

Friend Summarycollapse
friend Io::ISerializer& operator<<(Io::ISerializer& serializer, const SortedSet& container)
          Serializes the state of an SortedSet object.
friend Io::IDeserializer& operator>>(Io::IDeserializer& deserializer, SortedSet& container)
          Deserializes the state of an SortedSet object.

 

Constructor Detail

SortedSet[inline]

SortedSet()

DOCTODO.


SortedSet[inline]

SortedSet(const SortedSet& container)

DOCTODO.

Parameters:
container - DOCTODO

SortedSet[explicit, inline]

template <typename ContainerX>
SortedSet(const ContainerX& container)

DOCTODO.

Parameters:
container - DOCTODO

~SortedSet[inline]

~SortedSet()

Destructor.

 

Method Detail

collectEntries[inline]

template <typename Collection, typename Predicate>
Collection& collectEntries(Collection& collection, Predicate function) const

DOCTODO.

Parameters:
collection - DOCTODO
function - DOCTODO
Returns:
DOCTODO

collectEntriesRange[inline]

template <typename Collection>
Collection& collectEntriesRange(Collection& collection, const Position& fromPos, const Position& toPos) const

DOCTODO.

Parameters:
collection - DOCTODO
fromPos - DOCTODO
toPos - DOCTODO
Returns:
DOCTODO

equal[inline]

Position equal(const ElementType& key) const

DOCTODO.

Parameters:
key - DOCTODO
Returns:
DOCTODO

extractFirst[inline]

ElementType extractFirst()

Removes and returns the least key in this map.

Returns:
the removed first key of this map
Preconditions:
the map must not be empty

extractLast[inline]

ElementType extractLast()

Removes and returns the greatest key in this map.

Returns:
the removed last key of this map
Preconditions:
the map must not be empty

first[inline]

const ElementType& first() const

DOCTODO.

Returns:
DOCTODO

highest[inline]

Position highest() const

DOCTODO.

Returns:
DOCTODO

highestLessThan[inline]

Position highestLessThan(const ElementType& key, Bool predecessor = False) const

DOCTODO.

Parameters:
key - DOCTODO
predecessor - DOCTODO
Returns:
DOCTODO

last[inline]

const ElementType& last() const

DOCTODO.

Returns:
DOCTODO

lowest[inline]

Position lowest() const

DOCTODO.

Returns:
DOCTODO

lowestGreaterThan[inline]

Position lowestGreaterThan(const ElementType& key, Bool successor = False) const

DOCTODO.

Parameters:
key - DOCTODO
successor - DOCTODO
Returns:
DOCTODO

operator=[inline]

SortedSet& operator=(const SortedSet& container)

DOCTODO.

Parameters:
container - DOCTODO
Returns:
DOCTODO

predecessor[inline]

Position predecessor(const Position& position) const

DOCTODO.

Parameters:
position - DOCTODO
Returns:
DOCTODO

removeFirst[inline]

Void removeFirst()

DOCTODO.


removeLast[inline]

Void removeLast()

DOCTODO.


removeRange[inline]

Int removeRange(const Position& fromPos, const Position& toPos)

DOCTODO.

Parameters:
fromPos - DOCTODO
toPos - DOCTODO
Returns:
DOCTODO

successor[inline]

Position successor(const Position& position) const

DOCTODO.

Parameters:
position - DOCTODO
Returns:
DOCTODO

 

Friend Detail

operator<<[inline]

friend Io::ISerializer& operator<<(Io::ISerializer& serializer, const SortedSet& container)

Serializes the state of an SortedSet object.

Parameters:
container - an ordered set object to serialize
serializer - a serializer to receive state data
Returns:
the reference to the serializer

operator>>[inline]

friend Io::IDeserializer& operator>>(Io::IDeserializer& deserializer, SortedSet& container)

Deserializes the state of an SortedSet object.

Parameters:
container - an ordered set object to deserialize
deserializer - a deserializer to retrieve state data from
Returns:
the reference to the deserializer


SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND