fatf.utils.distances.binary_array_distance

fatf.utils.distances.binary_array_distance(X: numpy.ndarray, Y: numpy.ndarray, **kwargs) → numpy.ndarray

Calculates the binary distance matrix between rows in X and Y.

Both X and Y have to be 2-dimensional numpy arrays of the same width.

Either of the input arrays is not of a base dtype. (See fatf.utils.array.validation.is_base_array function description for the explanation of a base dtype.)

Parameters

Xnumpy.ndarray

A numpy array – has to be 2-dimensional.

Ynumpy.ndarray

A numpy array – has to be 2-dimensional.

**kwargsboolean

Keyword arguments that are passed to the fatf.utils.distances.binary_distance function responsible for calculating the binary distance.

Returns

distance_matrixnumpy.ndarray

An matrix of binary distances between rows in X and Y.

Raises

IncorrectShapeError

Either X or Y is not 2-dimensional or X and Y do not have the same number of columns.