Module: metrics

Methods

canberra(a, b) → {Number}

Computes the canberra distance between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/canberra.js, line 10
See: https://en.wikipedia.org/wiki/Canberra_distance

Returns:

the canberra distance between a and b.

Type:: Number

chebyshev(a, b) → {Number}

Computes the chebyshev distance (L_∞) between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/chebyshev.js, line 9

Returns:

the chebyshev distance between a and b.

Type:: Number

cosine(a, b) → {Number}

Computes the cosine distance (not similarity) between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/cosine.js, line 15

Returns:

The cosine distance between a and b.

Type:: Number

Example

import * as druid from "@saehrimnir/druidjs";

druid.cosine([1,0],[1,1]) == 0.7853981633974484 == π/4;

euclidean(a, b) → {Number}

Computes the euclidean distance (l₂) between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/euclidean.js, line 10

Returns:

the euclidean distance between a and b.

Type:: Number

euclidean_squared(a, b) → {Number}

Computes the squared euclidean distance (l₂²) between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/euclidean_squared.js, line 9

Returns:

the squared euclidean distance between a and b.

Type:: Number

hamming(a, b) → {Number}

Computes the hamming distance between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/hamming.js, line 9

Returns:

the hamming distance between a and b.

Type:: Number

jaccard(a, b) → {Number}

Computes the jaccard distance between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/jaccard.js, line 9

Returns:

the jaccard distance between a and b.

Type:: Number

manhattan(a, b) → {Number}

Computes the manhattan distance (l₁) between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/manhattan.js, line 9

Returns:

the manhattan distance between a and b.

Type:: Number

sokal_michener(a, b) → {Number}

Computes the Sokal-Michener distance between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/sokal_michener.js, line 9

Returns:

the Sokal-Michener distance between a and b.

Type:: Number

yule(a, b) → {Number}

Computes the yule distance between a and b.

Parameters:

Name	Type	Description
`a`	Array.<Number>
`b`	Array.<Number>

Source: metrics/yule.js, line 9

Returns:

the yule distance between a and b.

Type:: Number