spac.utils.check_distances(distances)

Check that the distances are valid: must be an array-like of incremental positive values.

Parameters:

distances (list, tuple, or np.ndarray) – The list of increasing distances for the neighborhood profile.

Returns:

Raises a ValueError or TypeError if the distances are invalid.

Return type:

None

Notes

The distances must be a list of positive real numbers and must be monotonically increasing.