fatf.utils.array.validation.is_1d_array

fatf.utils.array.validation.is_1d_array(array)[source]

Determines whether a numpy array-like object is 1-dimensional.

Parameters
arraynumpy.ndarray

The array to be checked.

Returns
is_1dboolean

True if the array is 1-dimensional, False otherwise.

Raises
TypeError

The input array is not a numpy array-like object.

Warns
UserWarning

The input array is 1-dimensional but its components are 1D structured.