IASortedRelation

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.


IASortedRelation - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


[view class]
~IASortedRelation
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.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IASortedRelation

You can construct and destruct objects of this class.


Overload 1
public:
IASortedRelation(INotifier&)

Use this constructor to create a collection with support for notification.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
protected:
IASortedRelation(IASortedRelation < Element, Key > const&)

Constructs a collection. The collection is unbounded and is initially empty.
Note: The collection constructor does not define whether any elements are constructed when the collection is constructed. For some classes, the element's default constructor may be invoked when the collection's constructor is invoked. This happens if a tabular or a diluted sequence implementation variant is used for a collection. The element's default constructor is used to allocate the required storage and initialize the elements. Therefore, a default constructor must be available for elements in such cases.

Exception

IOutOfMemory

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 3
protected:
IASortedRelation()

The default constructor.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Comparison

Use these members to compare two collections.


[view class]
compare
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.
Note:

  1. The given comparison function must return a result according to the following rules:
    >0
    if (element1 > element2)
    0
    if (element1 == element2)
    <0
    if (element1 < element2)
  2. For elements of type char*, IACollection::compare is not locale-sensitive by default. Because it uses strcmp() and not strcoll(), it compares the binary values representing the characters, and is not based on the LC_COLLATE category of the current locale. Its results are reliable only for code pages and character sets in which the collating sequence matches the sequence of binary representations. If you need a comparison based on the LC_COLLATE cateogory, then you must implement your own compare() function as described in Using Separate Functions:elink. in the Class Library User's Guide.

Return Value

Returns the result of the collection comparison.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Miscellaneous

Use these members to perform miscellaneous functions.


[view class]
addDifference
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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
addIntersection
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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
addUnion
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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
differenceWith
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.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
intersectionWith
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.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator !=
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==.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator ==
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:

Type of Collection :ddhd.Condition
Unique Elements
If the collections have unique elements, any element that occurs in one collection must occur in the other collection.
Non-Unique Elements
If an element has n occurrences in one collection, it must have exactly n occurrences in the other collection.
Sequential
The ordering of the elements is the same for both collections.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
unionWith
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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
numberOfOccurrences
protected:
INumber numberOfOccurrences(Element const&) const

Returns the number of occurrences of the given element in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
removeAllOccurrences
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.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IASortedRelation - Inherited Member Functions and Data

Inherited Public Functions

IACollection
IAEqualityKeySortedCollection
IAOrderedCollection
IASortedCollection

Inherited Public Data

Inherited Protected Functions

IACollectionBase
IACollection
IAEqualityKeySortedCollection
IAOrderedCollection
IASortedCollection

Inherited Protected Data