vocalpy.validators.validators.is_1d_ndarray

vocalpy.validators.validators.is_1d_ndarray(y: ndarray[Any, dtype[_ScalarType_co]], name: str | None = None) → bool

Validates that y is a 1-dimensional numpy.ndarray.

Parameters:

y: numpy.ndarray

Array to be validated.

name: str, optional

Name of array in calling function. Used in any error message if supplied.

Returns:

is_1d_ndarray: bool

True if y is valid.

Examples

>>> y = np.array([0, 1, 2])
>>> vocalpy.validators.is_1d_ndarray(y)
True