commonMain.org.antlr.v4.kotlinruntime.misc.IntSet.kt Maven / Gradle / Ivy
// Copyright 2017-present Strumenta and contributors, licensed under Apache 2.0.
// Copyright 2024-present Strumenta and contributors, licensed under BSD 3-Clause.
package org.antlr.v4.kotlinruntime.misc
/**
* A generic set of integers.
*
* @see IntervalSet
*/
public interface IntSet {
/**
* Returns `true` if this set contains no elements.
*
* @return `true` if the current set contains no elements, otherwise `false`
*/
public val isNil: Boolean
/**
* Adds the specified value to the current set.
*
* @param el The value to add
* @throws IllegalStateException If the current set is read-only
*/
public fun add(el: Int)
/**
* Modify the current [IntSet] object to contain all elements that are
* present in itself, the specified [set], or both.
*
* @param set The set to add to the current set.
* A `null` argument is treated as though it were an empty set
* @return `this` (to support chained calls)
*
* @throws IllegalStateException If the current set is read-only
*/
public fun addAll(set: IntSet): IntSet
/**
* Return a new [IntSet] object containing all elements that are
* present in both the current set and the specified set [a].
*
* @param a The set to intersect with the current set.
* A `null` argument is treated as though it were an empty set.
* @return A new [IntSet] instance containing the intersection of the
* current set and `a`. The value `null` may be returned in
* place of an empty result set
*/
public fun and(a: IntSet): IntSet
/**
* Return a new [IntSet] object containing all elements that are
* present in [elements] but not present in the current set.
*
* The following expressions are equivalent for input non-`null`
* [IntSet] instances `x` and `y`.
*
* - `x.complement(y)`
* - `y.subtract(x)`
*
* @param elements The set to compare with the current set.
* A `null` argument is treated as though it were an empty set.
* @return A new [IntSet] instance containing the elements present in
* `elements` but not present in the current set. The value
* `null` may be returned in place of an empty result set
*/
public fun complement(elements: IntSet): IntSet
/**
* Return a new [IntSet] object containing all elements that are
* present in the current set, the specified set [a], or both.
*
* This method is similar to [addAll], but returns a new
* [IntSet] instance instead of modifying the current set.
*
* @param a The set to union with the current set.
* A `null` argument is treated as though it were an empty set.
* @return A new [IntSet] instance containing the union of the current
* set and `a`. The value `null` may be returned in place of an
* empty result set
*/
public fun or(a: IntSet): IntSet
/**
* Return a new [IntSet] object containing all elements that are
* present in the current set but not present in the input set [a].
*
* The following expressions are equivalent for input non-`null`
* [IntSet] instances `x` and `y`.
*
* - `y.subtract(x)`
* - `x.complement(y)`
*
* @param a The set to compare with the current set.
* A `null` argument is treated as though it were an empty set.
* @return A new [IntSet] instance containing the elements present in
* `elements` but not present in the current set.
* The value `null` may be returned in place of an empty result set
*/
public fun subtract(a: IntSet): IntSet
/**
* Return the total number of elements represented by the current set.
*
* @return The total number of elements represented by the current set,
* regardless of the manner in which the elements are stored
*/
public fun size(): Int
/**
* Returns `true` if the set contains the specified element.
*
* @param el The element to check for
* @return `true` if the set contains `el`, otherwise `false`
*/
public fun contains(el: Int): Boolean
/**
* Removes the specified value from the current set.
* If the current set does not contain the element, no changes are made.
*
* @param el The value to remove
* @throws IllegalStateException If the current set is read-only
*/
public fun remove(el: Int)
/**
* Return a list containing the elements represented by the current set.
* The list is returned in ascending numerical order.
*
* @return A list containing all element present in the current set,
* sorted in ascending numerical order
*/
public fun toList(): List
override fun equals(other: Any?): Boolean
override fun hashCode(): Int
override fun toString(): String
}