rx-datatable API
    Preparing search index...

    Interface ISortedSetF<K>

    An interface for a functional sorted set: a functional set in which the keys (items) are sorted. This is a subinterface of ISortedMapF.

    interface ISortedSetF<K = any> {
        size: number;
        filter(
            callback: (k: K, v: any, counter: number) => boolean,
            returnThisIfUnchanged?: boolean,
        ): ISetF<K>;
        forRange(
            low: K,
            high: K,
            includeHigh: boolean,
            onFound?: (k: K, v: any, counter: number) => void,
            initialCounter?: number,
        ): number;
        has(key: K): boolean;
        keys(firstKey?: K): IterableIterator<K>;
        maxKey(): K | undefined;
        minKey(): K | undefined;
        nextHigherKey(key?: K): K | undefined;
        nextLowerKey(key?: K): K | undefined;
        with(key: K): ISetF<K>;
        withKeys(keys: K[], returnThisIfUnchanged?: boolean): ISetF<K>;
        without(key: K): ISetF<K>;
        withoutKeys(keys: K[], returnThisIfUnchanged?: boolean): ISetF<K>;
    }

    Type Parameters

    • K = any

    Hierarchy (View Summary)

    Index
    size
    filter forRange has keys maxKey minKey nextHigherKey nextLowerKey with withKeys without withoutKeys
    size: number

    Returns the number of key/value pairs in the map object.

    • Returns a copy of the tree with items removed whenever the callback function returns false.

      Parameters

      • callback: (k: K, v: any, counter: number) => boolean

        A function to call for each item in the set. The second parameter to callback exists because ISetF is a subinterface of IMapF. If the object is a map, v is the value associated with the key, otherwise v could be undefined or another copy of the third parameter (counter).

      • OptionalreturnThisIfUnchanged: boolean

      Returns ISetF<K>

    • Calls callback on the specified range of keys, in ascending order by key.

      Parameters

      • low: K

        The first key scanned will be greater than or equal to low.

      • high: K

        Scanning stops when a key larger than this is reached.

      • includeHigh: boolean

        If the high key is present in the map, onFound is called for that final pair if and only if this parameter is true.

      • OptionalonFound: (k: K, v: any, counter: number) => void

        A function that is called for each key pair. Because this is a subinterface of ISortedMapSource, if there is a value associated with the key, it is passed as the second parameter.

      • OptionalinitialCounter: number

        Initial third argument of onFound. This value increases by one each time onFound is called. Default: 0

      Returns number

      Number of pairs found and the number of times onFound was called.

    • Returns a boolean asserting whether the key exists in the map object or not.

      Parameters

      • key: K

      Returns boolean

    • Returns a new iterator for iterating the items in the set (the order is implementation-dependent).

      Parameters

      • OptionalfirstKey: K

      Returns IterableIterator<K>

    • Returns the next key larger than the specified key (or undefined if there is none). Also, nextHigherKey(undefined) returns the lowest key.

      Parameters

      • Optionalkey: K

      Returns K | undefined

    • Returns the next key smaller than the specified key (or undefined if there is none). Also, nextLowerKey(undefined) returns the highest key.

      Parameters

      • Optionalkey: K

      Returns K | undefined

    • Returns a copy of the set with the specified key included.

      Parameters

      • key: K

      Returns ISetF<K>

      You might wonder why this method accepts only one key instead of ...keys: K[]. The reason is that the derived interface IMapF expects the second parameter to be a value. Therefore withKeys() is provided to set multiple keys at once.

    • Returns a copy of the tree with all the keys in the specified array present.

      Parameters

      • keys: K[]

        The keys to add.

      • OptionalreturnThisIfUnchanged: boolean

        If true, the method returns this when all of the keys are already present in the collection. The default value may be true or false depending on the concrete implementation of the interface (in BTree, the default is false.)

      Returns ISetF<K>

    • Returns a copy of the tree with all the keys in the specified array removed.

      Parameters

      • keys: K[]
      • OptionalreturnThisIfUnchanged: boolean

      Returns ISetF<K>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods