A sorted relation is an ordered collection of zero or more elements that have a key. The lements are sorted by the value of their key. Element equality is supported, and the values of the elements are relevant.
The keys of the elements are not unique. You can add an element whether or not there is already an element in the collection with the same key.
You can construct and destruct objects of this class.
![]() |
public:
~IASortedRelation()
Removes all elements from the collection. Destructors are called for all elements contained in the collection and for elements that have been constructed in advance.
Side Effects
All cursors of the collection become undefined.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
You can construct and destruct objects of this class.
public:
IASortedRelation(INotifier&)
Use this constructor to create a collection with support for notification.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
protected:
IASortedRelation(IASortedRelation < Element, Key > const&)
Constructs a collection.
The collection is unbounded and is initially empty.
Exception
IOutOfMemory
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
protected:
IASortedRelation()
The default constructor.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to compare two collections.
![]() |
public:
long compare( IASortedRelation < Element, Key > const&, long ( * comparisonFunction ) ( Element const & , Element const & ) ) const
Compares the collection with the given collection.
Comparison yields
<0 if the collection is less than the given collection,
0 if the collection is equal to the given collection, and
>0 if the collection is greater than the given collection.
Comparison is defined by the first pair of
corresponding elements, in both collections, that are not equal.
If such a pair exists, the collection with the greater element
is the greater one.
Otherwise, the collection with more elements
is the greater one.
Return Value
Returns the result of the collection comparison.
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to perform miscellaneous functions.
![]() |
public:
virtual void addDifference( IASortedRelation < Element, Key > const&, IASortedRelation < Element, Key > const& )
Creates the difference between the two given collections, and adds this difference to the collection. The contents of the added elements, not the pointers to those elements, are copied.
For a definition of the difference between two collections, see IACollection::differenceWith
Preconditions
Because the elements are added one by one, the following preconditions are tested for each individual addition.
Side Effects
If any elements were added, all cursors of this collection become undefined.
Exceptions
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual void addIntersection( IASortedRelation < Element, Key > const&, IASortedRelation < Element, Key > const& )
Creates the intersection of the two given collections, and adds this intersection to the collection. The contents of the added elements, not the pointers to those elements, are copied.
For a definition of the intersection of two collections, see IACollection::intersectionWith
Preconditions
Because the elements are added one by one, the following preconditions are tested for each individual addition.
Side Effects
If any elements were added, all cursors of this collection become undefined.
Exceptions
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual void addUnion( IASortedRelation < Element, Key > const&, IASortedRelation < Element, Key > const& )
Creates the union of the two given collections, and adds this union to the collection. The contents of the added elements, not the pointers to those elements, are copied.
For a definition of the union of two collections, see IACollection::unionWith
Preconditions
Because the elements are added one by one, the following preconditions are tested for each individual addition.
Side Effects
If any elements were added, all cursors of this collection become undefined.
Exceptions
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual void differenceWith( IASortedRelation < Element, Key > const& )
Makes the collection the difference between the collection and the given collection. The difference of A and B (A minus B) is the set of elements that are contained in A but not in B.
The following rule applies for bags with duplicate elements: If bag P contains the element X m times and bag Q contains the element X n times, the difference of P and Q contains the element X m-n times if m > n, and zero times if m<=n.
Side Effects
If any elements were removed, all cursors of this collection become undefined.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual void intersectionWith( IASortedRelation < Element, Key > const& )
Makes the collection the intersection of the collection and the given collection. The intersection of A and B is the set of elements that is contained in both A and B.
The following rule applies for bags with duplicate elements: If bag P contains the element X m times and bag Q contains the element X n times, the intersection of P and Q contains the element X MIN(m,n): times.
Side Effects
If any elements were removed, all cursors of this collection become undefined.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IBoolean operator !=( IASortedRelation < Element, Key > const& ) const
Returns true if the given collection is not equal to the collection. For a definition of equality for collections, see IACollection::operator==.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IBoolean operator ==( IASortedRelation < Element, Key > const& ) const
Returns true if the given collection is equal to the collection. Two collections are equal if the number of elements in each collection is the same, and if the condition for the collection is described in the following list:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual void unionWith( IASortedRelation < Element, Key > const& )
Makes the collection the union of the collection and the given collection. The union of A and B is the set of elements that are members of A or B or both.
The following rule applies for bags with duplicate elements: If bag P contains the element X m times and bag Q contains the element X n times, the union of P and Q contains the element X m+n times.
Preconditions
Because the elements from the given collection are added to the collection one by one, the following preconditions are tested for each individual add operation :
Side Effects
If any elements were added to the collection, all cursors of this collection become undefined.
Exceptions
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
protected:
INumber numberOfOccurrences(Element const&) const
Returns the number of occurrences of the given element in the collection.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
protected:
INumber removeAllOccurrences(Element const&)
Removes all elements from the collection that are equal to the given element, and returns the number of elements removed. Element destructors are called as described in IACollection::removeAt
Side Effects
If any elements were removed, all cursors of this collection become undefined.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~IACollection()
virtual bool add(Element const&)
virtual bool add(Element const&, ICursor&)
virtual void addAllFrom(IACollection < Element > const&)
void adoptStreamer(IACollectionStreamer*)
bool allElementsDo( bool ( * applicatorFunction ) ( Element const&, void * ) , void* additionalArgument = 0 ) const
bool allElementsDo(IApplicator < Element >&)
bool allElementsDo(IConstantApplicator < Element >&) const
bool allElementsDo( bool ( * applicatorFunction ) ( Element&, void * ) , void* additionalArgument = 0 )
Element const& any() const
Element const& anyElement() const
virtual void copy(IACollection < Element > const&)
INotifier& disableNotification()
Element& elementAt(ICursor const&)
Element const& elementAt(ICursor const&) const
INotifier& enableNotification(bool = true)
IACollection(INotifier&)
bool isBounded() const
bool isConsistent() const
bool isEmpty() const
bool isEnabledForNotification() const
bool isFull() const
INumber maxNumberOfElements() const
virtual ICursor* newCursor() const
ICursor* newMngCursor() const
INotifier& notifier()
INotifier const& notifier() const
INotifier& notifyObservers(INotificationEvent const&)
INumber numberOfElements() const
virtual void operator <<=(IDataStream&)
virtual void operator >>=(IDataStream&)
operator INotifier &() const
virtual INumber removeAll( bool ( * predicateFunction ) ( Element const&, void * ) , void* additionalArgument = 0 )
virtual INumber removeAll()
virtual void removeAt(ICursor&)
virtual void replaceAt(ICursor const&, Element const&)
bool setToFirst(ICursor&) const
bool setToNext(ICursor&) const
~IAEqualityKeySortedCollection()
IAEqualityKeySortedCollection(INotifier&)
~IAOrderedCollection()
Element const& elementAtPosition(IPosition) const
Element const& first() const
Element const& firstElement() const
IAOrderedCollection(INotifier&)
bool isFirst(ICursor const&) const
bool isFirstAt(ICursor const&) const
bool isLast(ICursor const&) const
bool isLastAt(ICursor const&) const
Element const& last() const
Element const& lastElement() const
IPosition position(ICursor const&) const
IPosition positionAt(ICursor const&) const
virtual void removeAtPosition(IPosition)
virtual void removeFirst()
virtual void removeLast()
bool setToLast(ICursor&) const
void setToPosition(IPosition, ICursor&) const
bool setToPrevious(ICursor&) const
~IASortedCollection()
IASortedCollection(INotifier&)
IACollection()
IACollection(IACollection < Element > const&)
static Implementation& ImplOf( IACollection < Element > const& )
IAEqualityKeySortedCollection( IAEqualityKeySortedCollection < Element, Key > const& )
IAEqualityKeySortedCollection()
IAOrderedCollection(IAOrderedCollection < Element > const&)
IAOrderedCollection()
IASortedCollection()
IASortedCollection(IASortedCollection < Element > const&)