Class BindingsIndexUndef<V>

A simple efficient tree-based index for maintaining bindings, and checking whether or not a bindings is contained in this index.

This will consider bindings with a variable term or an undefined term as a 'match-all' with other terms.

Type Parameters

V

Implements

IBindingsIndex<V>

Index

Constructors

Methods

get getFirst getRecursive getRecursiveFirst isBindingsValid put values

Constructors

constructor

new BindingsIndexUndef<V>(
    keys: MetadataVariable[],
    hashFn: (term: undefined | Term) => string,
    allowDisjointDomains: boolean,
): BindingsIndexUndef<V>
Type Parameters
- V
Parameters
- keys: MetadataVariable[]
- hashFn: (term: undefined | Term) => string
- allowDisjointDomains: boolean
Returns BindingsIndexUndef<V>
- Defined in BindingsIndexUndef.ts:18

Methods

get

get(bindings: Bindings): V[]
Get the value of the given bindings is contained in this index.
Parameters
- bindings: Bindings
  A bindings.
Returns V[]
The values.
Implementation of IBindingsIndex.get
- Defined in BindingsIndexUndef.ts:65

getFirst

getFirst(bindings: Bindings, matchUndefsAsWildcard?: boolean): undefined | V
Get the first value of the given bindings is contained in this index.
Parameters
- bindings: Bindings
  A bindings.
- matchUndefsAsWildcard: boolean = true
  If undefs in the given bindings should match with any existing values. Otherwise, undefs will only match values that were inserted as undefs.
Returns undefined | V
The value.
Implementation of IBindingsIndex.getFirst
- Defined in BindingsIndexUndef.ts:112

`Protected`getRecursive

getRecursive(
    bindings: undefined | Bindings,
    keys: Variable[],
    dataIndexes: IDataIndex<V>[],
): V[]
Parameters
- bindings: undefined | Bindings
- keys: Variable[]
- dataIndexes: IDataIndex<V>[]
Returns V[]
- Defined in BindingsIndexUndef.ts:74

`Protected`getRecursiveFirst

getRecursiveFirst(
    bindings: Bindings,
    keys: Variable[],
    dataIndexes: IDataIndex<V>[],
    matchUndefsAsWildcard: boolean,
): undefined | V
Parameters
- bindings: Bindings
- keys: Variable[]
- dataIndexes: IDataIndex<V>[]
- matchUndefsAsWildcard: boolean
Returns undefined | V
- Defined in BindingsIndexUndef.ts:121

`Protected`isBindingsValid

isBindingsValid(bindings: Bindings): boolean
Parameters
- bindings: Bindings
Returns boolean
- Defined in BindingsIndexUndef.ts:49

put

put(bindings: Bindings, value: V): V
Add the given bindings to the index.
Parameters
- bindings: Bindings
  A bindings.
- value: V
  The value to put.
Returns V
Implementation of IBindingsIndex.put
- Defined in BindingsIndexUndef.ts:33

values

values(): V[]
Returns V[]
Implementation of IBindingsIndex.values
- Defined in BindingsIndexUndef.ts:162