fatf.utils.array.validation.is_numerical_dtype

fatf.utils.array.validation.is_numerical_dtype(dtype: numpy.dtype) → bool[source]

Determines whether a numpy dtype object is of numerical type.

Checks whether the dtype is of one of the following (numerical) types: unsigned byte, boolean, (signed) byte – boolean, unsigned integer, (signed) integer, floating-point or complex-floating point.

Parameters
dtypenumpy.dtype

The dtype to be checked.

Returns
is_numericalboolean

True if the dtype is of a numerical type, False otherwise.

Raises
TypeError

The input is not a numpy’s dtype object.

ValueError

The dtype is structured – this function only accepts plane dtypes.