utils

Utility functions for the package.

utils.scale_01(x)[source]

Scales array to 0-1.

Parameters

x (iter) – 1d array of float

Returns

scaled 1d array

Return type

np.array

Example

>>> scale_01([1, 2, 3, 5]).tolist()
[0.0, 0.25, 0.5, 1.0]
utils.abs_distance(x, y)[source]

Returns absolute distance.

Parameters
  • x (float) – input 1

  • y (float) – input 2

Returns

|x-y|

Return type

float

Example

>>> abs_distance(5, 7)
2.0
>>> abs_distance(4, 1)
3.0
utils.euclidean_distance(x, y)[source]

Returns Euclidean distance.

Parameters
  • x (float or iter) – input 1

  • y (float or iter) – input 2

Returns

Euclidean distance

Return type

float

References

https://numpy.org/doc/stable/reference/generated/numpy.linalg.norm.html

Examples

>>> x, y = 1, 2
>>> euclidean_distance(x, y)
1.0
>>> x, y = [1, 2], [4, 6]
>>> euclidean_distance(x, y)
5.0