​

Class: Distance

Defined in: distance.ts:209 Distance calculation utility class. Provides multiple distance formulas for different use cases:

• Geographic distances: haversine, vincenty (for Earth coordinates)
• Mathematical distances: euclidean, manhattan, chebyshev, minkowski
• Vector distances: cosine, hamming
• Set distances: jaccard, sorensen-dice

​

Constructors

​

Constructor

new Distance(): Distance

​

Returns

Distance

​

Methods

​

calculate()

static calculate(formula, point1, point2, options?): number

Defined in: distance.ts:419

​

Parameters

formula

DistanceFormula

point1

Coordinates2D | Coordinates3D

point2

Coordinates2D | Coordinates3D

options?

DistanceOptions = {}

​

Returns

number

---

​

calculateSafe()

static calculateSafe(formula, point1, point2, options?): DistanceResult

Defined in: distance.ts:455

​

Parameters

formula

DistanceFormula

point1

Coordinates2D | Coordinates3D

point2

Coordinates2D | Coordinates3D

options?

DistanceOptions = {}

​

Returns

DistanceResult

---

​

chebyshev()

static chebyshev(point1, point2): number

Defined in: distance.ts:327

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

cosine()

static cosine(point1, point2): number

Defined in: distance.ts:359

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

euclidean()

static euclidean(point1, point2): number

Defined in: distance.ts:210

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

hamming()

static hamming(point1, point2): number

Defined in: distance.ts:377

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

haversine()

static haversine(point1, point2): number

Defined in: distance.ts:219

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

haversineMeters()

static haversineMeters(point1, point2): number

Defined in: distance.ts:236

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

jaccard()

static jaccard(point1, point2): number

Defined in: distance.ts:389

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

manhattan()

static manhattan(point1, point2): number

Defined in: distance.ts:320

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

minkowski()

static minkowski(point1, point2, p?): number

Defined in: distance.ts:334

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

p?

number = 2

​

Returns

number

---

​

recommendGeoFormula()

static recommendGeoFormula(maxDistanceKm?): DistanceFormula

Defined in: distance.ts:478

​

Parameters

maxDistanceKm?

number

​

Returns

DistanceFormula

---

​

sorensenDice()

static sorensenDice(point1, point2): number

Defined in: distance.ts:404

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number

---

​

threed()

static threed(point1, point2): number

Defined in: distance.ts:352

​

Parameters

point1

Coordinates3D

point2

Coordinates3D

​

Returns

number

---

​

vincenty()

static vincenty(point1, point2): number

Defined in: distance.ts:240

​

Parameters

point1

Coordinates2D

point2

Coordinates2D

​

Returns

number