Skip to main content

interface ProximityMap.Context<UK>

A context instance for a ProximityMap that acts as a factory for every instance of this type of collection.

Type parameters​

NameDescription
UKthe upper key type bound for which the context can be used

Properties​

distanceFunction​

The function used to compute the distance between stored keys and any research key

Definition​

readonly distanceFunction: DistanceFunction<UK>;

hashMapContext​

The context used by the internal HashMap

Definition​

readonly hashMapContext: HashMap.Context<UK>;

typeTag​

undocumented

Definition​

readonly typeTag: 'ProximityMap';

Methods​

createBuilder​

Creates a builder given the optional non-empty source map

Definition​

createBuilder<K extends UK, V>(source?: ProximityMap.NonEmpty<K, V>): ProximityMap.Builder<K, V>;

Type parameters​

NameConstraintsDescription
KUK
V

Parameters​

NameTypeDescription
sourceProximityMap.NonEmpty<K, V>Optional non-empty map used to fill the builder