SortedSet¶

Usage

use SortedSet;

or

import SortedSet;

Provides the ‘sortedSet’ type for storing sorted unique elements.

An sortedSet is a collection of unique and sorted elements. The sortedSet accepts a comparator to determine how elements are compared. The default comparator is defaultComparator. In this case, elements are stored and considered in ascending order. For example, these will yield elements in ascending order.

All references to sortedSet elements are invalidated when the sortedSet is cleared or deinitialized.

sortedSet is not parallel safe by default, but can be made parallel safe by setting the param formal parSafe to true in any sortedSet constructor. When constructed from another sortedSet, the new sortedSet will inherit the parallel safety mode of its originating sortedSet.

record sortedSet: writeSerializable¶

type eltType¶: The type of the elements contained in this sortedSet.

param parSafe = false¶: If true, this sortedSet will perform parallel safe operations.

type comparatorType = defaultComparator.type¶

proc init(type eltType, param parSafe = false, type comparatorType = defaultComparator.type)¶

Initializes an empty sortedSet containing elements of the given type.

Arguments

eltType – The type of the elements of this sortedSet.
parSafe – If true, this sortedSet will use parallel safe operations.
comparatorType – The comparator type

proc init(type eltType, param parSafe = false, comparator: record)

Initializes an empty sortedSet containing elements of the given type.

Arguments

eltType – The type of the elements of this sortedSet.
parSafe – If true, this sortedSet will use parallel safe operations.
comparator – The comparator used to compare elements.

proc init(type eltType, iterable, param parSafe = false, comparator: record = defaultComparator) where canResolveMethod(iterable, "these")

Initialize this sortedSet with a unique copy of each element contained in iterable. If an element from iterable is already contained in this sortedSet, it will not be added again. The formal iterable must be a type with an iterator named “these” defined for it.

Arguments

iterable – A collection of elements to add to this sortedSet.
parSafe – If true, this sortedSet will use parallel safe operations.
comparator – The comparator used to compare elements.

proc init=(const ref other: sortedSet(?t))¶

Initialize this sortedSet with a copy of each of the elements contained in the sortedSet other. This sortedSet will inherit the parSafe value of the sortedSet other.

Arguments: other – An sortedSet to initialize this sortedSet with.

proc writeThis(ch: fileWriter) throws¶

Write the contents of this sortedSet to a fileWriter.

Arguments: ch – A fileWriter to write to.

proc size¶: The current number of elements contained in this sortedSet.

proc ref add(in x: eltType)¶

Add a copy of the element x to this sortedSet. Does nothing if this sortedSet already contains an element equal to the value of x.

Arguments: x – The element to add to this sortedSet.

proc contains(const ref x: eltType): bool¶

Returns true if the given element is a member of this sortedSet, and false otherwise.

Arguments: x – The element to test for membership.
Returns: Whether or not the given element is a member of this sortedSet.
Return type: bool

proc ref remove(const ref x: eltType): bool¶

Attempt to remove the item from this sortedSet with a value equal to x. If an element equal to x was removed from this sortedSet, return true, else return false if no such value was found.

Arguments: x – The element to remove.
Returns: Whether or not an element equal to x was removed.
Return type: bool

proc ref clear()¶: Clear the contents of this sortedSet.

Warning

Clearing the contents of this sortedSet will invalidate all existing references to the elements contained in this sortedSet.

proc lowerBound(e: eltType): (bool, eltType)¶

Find the first element in the sortedSet which is not less than e.