antlr4ts/misc/Interval.d.ts

ANTLR 4 runtime for JavaScript written in Typescript

/*!
 * Copyright 2016 The ANTLR Project. All rights reserved.
 * Licensed under the BSD-3-Clause license. See LICENSE file in the project root for license information.
 */
import { Equatable } from "./Stubs";
/** An immutable inclusive interval a..b */
export declare class Interval implements Equatable {
    a: number;
    b: number;
    private static _INVALID;
    static get INVALID(): Interval;
    private static readonly cache;
    /**
     * @param a The start of the interval
     * @param b The end of the interval (inclusive)
     */
    constructor(a: number, b: number);
    /** Interval objects are used readonly so share all with the
     *  same single value a==b up to some max size.  Use an array as a perfect hash.
     *  Return shared object for 0..INTERVAL_POOL_MAX_VALUE or a new
     *  Interval object with a..a in it.  On Java.g4, 218623 IntervalSets
     *  have a..a (set with 1 element).
     */
    static of(a: number, b: number): Interval;
    /** return number of elements between a and b inclusively. x..x is length 1.
     *  if b < a, then length is 0.  9..10 has length 2.
     */
    get length(): number;
    equals(o: any): boolean;
    hashCode(): number;
    /** Does this start completely before other? Disjoint */
    startsBeforeDisjoint(other: Interval): boolean;
    /** Does this start at or before other? Nondisjoint */
    startsBeforeNonDisjoint(other: Interval): boolean;
    /** Does this.a start after other.b? May or may not be disjoint */
    startsAfter(other: Interval): boolean;
    /** Does this start completely after other? Disjoint */
    startsAfterDisjoint(other: Interval): boolean;
    /** Does this start after other? NonDisjoint */
    startsAfterNonDisjoint(other: Interval): boolean;
    /** Are both ranges disjoint? I.e., no overlap? */
    disjoint(other: Interval): boolean;
    /** Are two intervals adjacent such as 0..41 and 42..42? */
    adjacent(other: Interval): boolean;
    properlyContains(other: Interval): boolean;
    /** Return the interval computed from combining this and other */
    union(other: Interval): Interval;
    /** Return the interval in common between this and o */
    intersection(other: Interval): Interval;
    /** Return the interval with elements from `this` not in `other`;
     *  `other` must not be totally enclosed (properly contained)
     *  within `this`, which would result in two disjoint intervals
     *  instead of the single one returned by this method.
     */
    differenceNotProperlyContained(other: Interval): Interval | undefined;
    toString(): string;
}