class Set<+T: Hashable & Equality>

A mutable, growable collection of unique items with O(1) insertion/ membership testing. Iteration order corresponds to the order in which items were first added to the Set.

Notes

Set is backed by a Map where the keys are the set entries and the values are dummy value.

Static Methods

Creating a OrderedSet

static fun sourcemcreate(capacity: Int): mutable this

static fun sourcecreateFromItems<I: readonly Sequence<T>>(items: I): this

static fun sourcemcreateFromItems<I: readonly Sequence<T>>(items: I): mutable this

static fun sourcecreateFromIterator<I: mutable Iterator<T>>(items: I): this

static fun sourcemcreateFromIterator<I: mutable Iterator<T>>(items: I): mutable this

Methods

readonly fun sourceclone(reserve: Int): mutable this

readonly fun sourcechill(): this

Sizing

readonly fun sourcesize(): Int

readonly fun sourceisEmpty(): Bool

mutable fun sourcecapacity(): Int

NOTE: Making capacity observable on frozen values prevents optimizations such as shrinking to fit on freeze. By making it mutable we preserve option value to add such optimizations in the future.

mutable fun sourceensureCapacity(capacity: Int): Void

mutable fun sourceclear(): Void

Accessing Items

readonly fun sourcecontains<T2: Hashable & Equality>(k: T2): Bool

readonly fun sourceget<T2: Hashable & Equality>(k: T2): T

readonly fun sourcemaybeGet<T2: Hashable & Equality>(k: T2): Option<T>

Modifying Items

mutable fun sourceadd(v: T): Void

Adds the item to this set if is not present, otherwise throws.

mutable fun sourceremove(v: T): Void

Removes the item from this set if present, otherwise throws.

mutable fun sourcemaybeRemove(v: T): Bool

Removes the item from this set:

• If the item is present removes it and return true
• Otherwise do nothing and returns false

mutable fun sourceinsert(v: T): Void

Adds the item to the set if is not present, otherwise has no effect.

mutable fun sourcemaybeInsert(v: T): Bool

Inserts the item into this set:

• If not already present adds it and returns true
• If already present does nothing and returns false

mutable fun sourceextend<S: readonly Sequence<T>>(items: S): Void

Add all the items of the second sequence to this set. Ignores items already in this set.

mutable fun sourcesubtract<S: readonly Sequence<T>>(items: S): Void

Remove all the items of the second sequence from this set. Ignores items not in this set.

Iteration

readonly fun sourceeach(f: (T) -> Void): Void

Composition

readonly fun sourcefilter(p: (T) -> Bool): Set<T>

Aggregation

readonly fun sourcefind(p: (T) -> Bool): Option<T>

readonly fun sourceall(f: (T) -> Bool): Bool

readonly fun sourceany(f: (T) -> Bool): Bool

readonly fun sourcejoin(separator: String): String

Set Arithmetic

readonly fun sourceunion<U: Hashable & Equality, S: readonly Sequence<U>>(items: S): Set<U>

Returns a new set containing all the items of this set and the second sequence.

readonly fun sourcedifference<U: Hashable & Equality, S: readonly Sequence<U>>(items: S): Set<U>

Returns a new set containing the items of this set that do not appear in the second sequence.

readonly fun sourceintersection<U: Hashable & Equality, S: readonly Sequence<U>>(items: S): Set<U>

Return a new set containing the items of this set that appear in the second sequence.

readonly fun sourcecontainsAll<S: readonly Sequence<T>>(items: S): Bool

Returns true if this set contains all of the items in the second sequence.

readonly fun sourcecontainsAny<S: readonly Sequence<T>>(items: S): Bool

Returns true if this set contains any of the items in the second sequence.

Trait Implementations

readonly fun source==<T2: Hashable & Equality>(other: readonly Set<T2>): Bool

readonly fun source!=<T2: Hashable & Equality>(other: readonly Set<T2>): Bool

readonly fun sourcetoString(): String

readonly fun sourcehash(): Int

readonly fun sourceinspect(): Inspect

readonly fun sourcetoArray(): Array<T>

Iterators

readonly fun sourcevalues(): mutable Iterator<T>

Inherited Methods

static fun sourcemeta<U: Hashable & Equality, C: MetaClass<U>>(itemClass: C): SetMetaClass<U, C>

static fun sourcegenerator<T2: Hashable & Equality>(generator: QuickCheck.Generator<T2>): QuickCheck.Generator<Set<T2>>

fun sourceperturb(rng: mutable Random): Void

fun sourceshrink(_firstShrink: Bool): mutable Iterator<Set<T>>