FSet64 (Parallel Template Library (PTL)™ 4.0)

java.lang.Object
- Progeneric.Ptl.Containers.FSet64<TKey>

All Implemented Interfaces:

IBidContainer64<TKey,FSet64.Iterator>, IContainer64<TKey>, IFwdContainer64<TKey,FSet64.Iterator>
```
public class FSet64<TKey>
extends java.lang.Object
implements IBidContainer64<TKey,FSet64.Iterator>
```
Defines a sorted, variable-sized container that stores pairs of keys and pointers (addresses) to a record in a different container. It supports efficient retrieval of elements, both forward and backward traversal and amortized time insertions and deletions of elements. The value of the key is used to order the elements automatically.
Remarks: The value of an element in a set may not be changed directly. Instead, you must delete old values and insert elements with new values. The container is allocated in memory and can contain at most 281,474,976,710,656 elements of type TKey.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`FSet64.Iterator` Defines a bidirectional iterator that can be both incremented and decremented.
`class`	`FSet64.ReverseIterator` Defines a reverse unchecked iterator that enables backward traversal of a range.
`class`	`FSet64.UIterator` Defines a bidirectional iterator that can be both incremented and decremented.
`class`	`FSet64.UReverseIterator` Defines a reverse unchecked iterator that enables backward traversal of a range.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`Add(TKey item)` Adds an object to the collection.
`<TInpIter extends IInpIter<TKey,TInpIter>> void`	`Assign(TInpIter first, TInpIter last)` Erases a set and copies the specified elements to the empty set.
`FSet64.Iterator`	`Begin()` Returns a bidirectional iterator to the first element in the container.
`void`	`Clear()` Erases all the elements of the set.
`boolean`	`Contains(TKey item)` Determines whether an element is in the container.
`void`	`CopyTo(TKey[] array, int arrayIndex)` Copies the container to a compatible one-dimensional array, starting at the specified index of the target array.
`long`	`Count(TKey key)` Returns the number of elements in the set whose keys match a specified key.
`boolean`	`Empty()` Tests if the set is empty (the size of the set is zero).
`FSet64.Iterator`	`End()` Returns a bidirectional iterator to the position that is one past the final element in the container.
`Pair<FSet64.Iterator,FSet64.Iterator>`	`EqualRange(TKey key)` Finds a pair of iterators respectively to the first element in a set that is greater than or equal to a specified key and to the first element in the set that is greater than the key.
`boolean`	`Equals(FSet64<TKey> other)` Tests whether this instance is equal to a specified set.
`boolean`	`equals(java.lang.Object obj)` Tests whether this instance is equal to a specified object.
`FSet64.Iterator`	`Erase(FSet64.Iterator pos)` Removes an element in a set from a specified position.
`void`	`Erase(FSet64.Iterator first, FSet64.Iterator last)` Removes a range of elements in a set from specified positions.
`long`	`Erase(TKey key)` Removes the elements in a set that match a specified key.
`long`	`Erase(TKey key1, TKey key2)` Removes the elements in a set from a specified range.
`FSet64.Iterator`	`Find(TKey key)` Locates the position of the first occurrence of an element that has a key equivalent to a specified key.
`int`	`hashCode()` Returns the hash code for this instance.
`<TInpIter extends IInpIter<TKey,TInpIter>> void`	`Insert(TInpIter first, TInpIter last)` Inserts a range of elements into the set at a specified position.
`Pair<FSet64.Iterator,java.lang.Boolean>`	`Insert(TKey key)` Inserts an element into a set.
`IFunc2Arg<TKey,TKey,java.lang.Boolean>`	`KeyCompare()` Returns the function that can compare two sort keys to determine the relative order of two elements in the set.
`FSet64.Iterator`	`LowerBound(TKey key)` Finds an iterator to the first element in a set that is equal to or greater than a specified element.
`long`	`MaxSize()` Returns the maximum possible length of the set.
`void`	`PCopyTo(TKey[] array, int arrayIndex)` Parallel CopyTo: Copies the sequence to a compatible one-dimensional array, starting at the specified index of the target array.
`boolean`	`Remove(TKey item)` Removes the first occurrence of a specific object from the container.
`FSet64.ReverseIterator`	`ReverseBegin()` Returns a random-access reverse iterator to the first element in the reversed container.
`FSet64.ReverseIterator`	`ReverseEnd()` Returns a random-access reverse iterator to the position that is one past the final element in the reversed container.
`long`	`Size()` Returns the number of elements in the set.
`void`	`Swap(FSet64<TKey> x)` Exchanges the elements of two sets.
`void`	`ToStream(FSet64.Iterator first, FSet64.Iterator last, java.io.PrintStream sw)` Writes the elements of the current container from the specified range to the specified stream.
`void`	`ToStream(java.io.PrintStream sw)` Writes the elements of the current container to the specified stream.
`java.lang.String`	`toString()` Returns a String that represents the content of the current container.
`java.lang.String`	`ToString(FSet64.Iterator first, FSet64.Iterator last)` Returns a String that represents the elements of the current container from the specified range.
`java.lang.Class<TKey>`	`Type()` Returns the type of the elements in the container.
`FSet64.UIterator`	`UBegin()` Returns a bidirectional iterator to the first element in the container.
`FSet64.UIterator`	`UEnd()` Returns a bidirectional iterator to the position that is one past the final element in the container.
`boolean`	`Unique()` Returns true if the container accepts only unique keys.
`FSet64.Iterator`	`UpperBound(TKey key)` Finds an iterator to the first element in a set that is greater than a specified element.
`FSet64.UReverseIterator`	`UReverseBegin()` Returns a random-access unchecked reverse iterator to the first element in the reversed container.
`FSet64.UReverseIterator`	`UReverseEnd()` Returns a random-access unchecked reverse iterator to the position that is one past the final element in the reversed container.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - Type
```
public java.lang.Class<TKey> Type()
```
    Returns the type of the elements in the container.
    
    Specified by:
    
    Type in interface IContainer64<TKey>
    
    Returns:
    The type of the elements in the container.
  - Assign
```
public <TInpIter extends IInpIter<TKey,TInpIter>> void Assign(TInpIter first,
                                                     TInpIter last)
```
    Erases a set and copies the specified elements to the empty set.
    
    Parameters:
    first - Position of the first element in the range of elements to be copied.
    last - Position that is one past the final element in the range of elements to be copied.
    Remarks: The input range must be sorted. Use the sort methods of the Algorithms.SortOper class to sort the input range if it is unsorted. Failure to satisfy this condition will corrupt the container.
    
    Throws:
    
    java.lang.RuntimeException - Thrown when the iterator range is invalid.
  - Unique
```
public boolean Unique()
```
    Returns true if the container accepts only unique keys.
  - KeyCompare
```
public IFunc2Arg<TKey,TKey,java.lang.Boolean> KeyCompare()
```
    Returns the function that can compare two sort keys to determine the relative order of two elements in the set.
  - Size
```
public long Size()
```
    Returns the number of elements in the set.
    
    Specified by:
    
    Size in interface IContainer64<TKey>
    
    Returns:
    The number of elements contained in the sequence.
  - MaxSize
```
public long MaxSize()
```
    Returns the maximum possible length of the set.
    
    Specified by:
    
    MaxSize in interface IContainer64<TKey>
    
    Returns:
    The sequence's maximum possible size.
  - Empty
```
public boolean Empty()
```
    Tests if the set is empty (the size of the set is zero).
  - Contains
```
public boolean Contains(TKey item)
```
    Determines whether an element is in the container.
    
    Parameters:
    item - The object to locate in the container.
    
    Returns:
    True if item is found in the container; otherwise, false.
  - Add
```
public void Add(TKey item)
```
    Adds an object to the collection.
    
    Parameters:
    item - The object to be added to the collection.
  - Remove
```
public boolean Remove(TKey item)
```
    Removes the first occurrence of a specific object from the container.
    
    Parameters:
    item - The object to remove from the container.
    
    Returns:
    True if item is successfully removed; otherwise, false. This method also returns false if item was not found in the container.
  - Clear
```
public void Clear()
```
    Erases all the elements of the set.
    
    Specified by:
    
    Clear in interface IContainer64<TKey>
  - CopyTo
```
public void CopyTo(TKey[] array,
          int arrayIndex)
```
    Copies the container to a compatible one-dimensional array, starting at the specified index of the target array.
    
    Parameters:
    array - The one-dimensional array that is the destination of the elements copied from container. The array must have zero-based indexing.
    arrayIndex - The zero-based index in array at which copying begins.
  - PCopyTo
```
public void PCopyTo(TKey[] array,
           int arrayIndex)
```
    Parallel CopyTo: Copies the sequence to a compatible one-dimensional array, starting at the specified index of the target array.
    
    Parameters:
    array - The one-dimensional array that is the destination of the elements copied from sequence. The array must have zero-based indexing.
    arrayIndex - The zero-based index in array at which copying begins.
  - UBegin
```
public FSet64.UIterator UBegin()
```
    Returns a bidirectional iterator to the first element in the container.
    
    Returns:
    An iterator at the beginning of the set object.
  - UEnd
```
public FSet64.UIterator UEnd()
```
    Returns a bidirectional iterator to the position that is one past the final element in the container.
    
    Returns:
    An iterator at the end of the set object.
  - Begin
```
public FSet64.Iterator Begin()
```
    Returns a bidirectional iterator to the first element in the container.
    
    Specified by:
    
    Begin in interface IFwdContainer64<TKey,FSet64.Iterator>
    
    Returns:
    An iterator at the beginning of the set object.
  - End
```
public FSet64.Iterator End()
```
    Returns a bidirectional iterator to the position that is one past the final element in the container.
    
    Specified by:
    
    End in interface IFwdContainer64<TKey,FSet64.Iterator>
    
    Returns:
    An iterator at the end of the set object.
  - UReverseBegin
```
public FSet64.UReverseIterator UReverseBegin()
```
    Returns a random-access unchecked reverse iterator to the first element in the reversed container.
    
    Returns:
    An iterator at the beginning of the reversed set object.
  - UReverseEnd
```
public FSet64.UReverseIterator UReverseEnd()
```
    Returns a random-access unchecked reverse iterator to the position that is one past the final element in the reversed container.
    
    Returns:
    An iterator at the end of the reversed set object.
  - ReverseBegin
```
public FSet64.ReverseIterator ReverseBegin()
```
    Returns a random-access reverse iterator to the first element in the reversed container.
    
    Returns:
    An iterator at the beginning of the reversed set object.
  - ReverseEnd
```
public FSet64.ReverseIterator ReverseEnd()
```
    Returns a random-access reverse iterator to the position that is one past the final element in the reversed container.
    
    Returns:
    An iterator at the end of the reversed set object.
  - Count
```
public long Count(TKey key)
```
    Returns the number of elements in the set whose keys match a specified key.
    
    Parameters:
    key - The key of the elements to be counted.
    
    Returns:
    The number of elements in the set whose values match a specified value.
  - Find
```
public FSet64.Iterator Find(TKey key)
```
    Locates the position of the first occurrence of an element that has a key equivalent to a specified key.
    
    Parameters:
    key - The key from the set being searched.
    
    Returns:
    An iterator addressing the location of an element in a set that has a key equivalent to a specified key. If no such iterator exists, the return value is last.
  - LowerBound
```
public FSet64.Iterator LowerBound(TKey key)
```
    Finds an iterator to the first element in a set that is equal to or greater than a specified element.
    
    Parameters:
    key - The key from the set being searched.
    
    Returns:
    An iterator that addresses the location of an element in a set that is equal to or greater than the argument.
  - UpperBound
```
public FSet64.Iterator UpperBound(TKey key)
```
    Finds an iterator to the first element in a set that is greater than a specified element.
    
    Parameters:
    key - The key from the set being searched.
    
    Returns:
    An iterator that addresses the location of an element in a set that is greater than the argument.
  - EqualRange
```
public Pair<FSet64.Iterator,FSet64.Iterator> EqualRange(TKey key)
```
    Finds a pair of iterators respectively to the first element in a set that is greater than or equal to a specified key and to the first element in the set that is greater than the key.
    
    Parameters:
    key - The key from the set being searched.
    
    Returns:
    A pair of iterators where the first is the LowerBound the key.
  Insert public Pair<FSet64.Iterator,java.lang.Boolean> Insert(TKey key) Inserts an element into a set. Parameters: key - The value of an element to be inserted into the set unless the set already contains that element. Returns: A pair of an iterator and a boolean value. The boolean value is true if the specified value was actually inserted and false if the value was already present. The iterator points to the position where the new element was inserted into the set. Insert public <TInpIter extends IInpIter<TKey,TInpIter>> void Insert(TInpIter first, TInpIter last) Inserts a range of elements into the set at a specified position. Parameters: first - An input iterator addressing the position of the first element in the range to be inserted. last - An input iterator addressing the position that is one past the final element in the range to be inserted. Throws: java.lang.RuntimeException - Thrown when the iterator range is invalid. Erase public FSet64.Iterator Erase(FSet64.Iterator pos) Removes an element in a set from a specified position. Parameters: pos - The position of the element to be removed from the set. Returns: An iterator that designates the first element remaining beyond the element removed, or a pointer to the end of the set if no such element exists. Throws: java.lang.RuntimeException - Thrown when the argument iterator is not dereferenceable. Erase public void Erase(FSet64.Iterator first, FSet64.Iterator last) Removes a range of elements in a set from specified positions. Parameters: first - The position of the first element removed from the set. last - Position just beyond the last element removed from the set. Throws: java.lang.RuntimeException - Thrown when the specified range is invalid. Erase public long Erase(TKey key) Removes the elements in a set that match a specified key. Parameters: key - The key value of the elements to be removed from the set. Returns: The number of elements that have been removed from the set. Erase public long Erase(TKey key1, TKey key2) Removes the elements in a set from a specified range. Parameters: key1 - Key of the first element removed from the set. key2 - Key just beyond the last element removed from the set. Returns: The number of elements that have been removed from the set. Swap public void Swap(FSet64<TKey> x) Exchanges the elements of two sets. Parameters: x - A set whose elements are to be exchanged with the current instance. equals public boolean equals(java.lang.Object obj) Tests whether this instance is equal to a specified object. Overrides: equals in class java.lang.Object Parameters: obj - An object to compare with this instance. Returns: True if obj is an instance of FSet64 and equals the value of this instance; otherwise, false. Equals public boolean Equals(FSet64<TKey> other) Tests whether this instance is equal to a specified set. Parameters: other - A set to compare with this instance. Returns: True if x equals the value of this instance; otherwise, false. hashCode public int hashCode() Returns the hash code for this instance. Overrides: hashCode in class java.lang.Object Returns: A 32-bit signed integer hash code. toString public java.lang.String toString() Returns a String that represents the content of the current container. Remarks: If the container has a large number of elements, this function may throw an exception. It is recommended to use the overloaded function to limit the number of elements that are dumped to a string. Overrides: toString in class java.lang.Object ToString public java.lang.String ToString(FSet64.Iterator first, FSet64.Iterator last) Returns a String that represents the elements of the current container from the specified range. Parameters: first - An iterator addressing the position of the first element in the range of elements. last - An iterator addressing the position that is one past the final element in the range of elements. Remarks: If the specified range has a large number of elements, this function may throw an exception. ToStream public void ToStream(java.io.PrintStream sw) Writes the elements of the current container to the specified stream. Parameters: sw - A PrintStream object to write to. ToStream public void ToStream(FSet64.Iterator first, FSet64.Iterator last, java.io.PrintStream sw) Writes the elements of the current container from the specified range to the specified stream. Parameters: first - An iterator addressing the position of the first element in the range of elements. last - An iterator addressing the position that is one past the final element in the range of elements. sw - A PrintStream object to write to.

Class FSet64<TKey>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

Type

Assign

Unique

KeyCompare

Size

MaxSize

Empty

Contains

Add

Remove

Clear

CopyTo

PCopyTo

UBegin

UEnd

Begin

End

UReverseBegin

UReverseEnd

ReverseBegin

ReverseEnd

Count

Find

LowerBound

UpperBound

EqualRange

Insert

Insert

Erase

Erase

Erase

Erase

Swap

equals

Equals

hashCode

toString

ToString

ToStream

ToStream