helpers.check_bounds

helpers.check_bounds(arr, lower_bounds, upper_bounds)

Check conditions for bounds input

Parameters

Name Type Description Default
arr numpy.numpy.ArrayLike A numpy ndarray required
lower_bounds numpy.numpy.ArrayLike Lower bounds of data required
upper_bounds numpy.numpy.ArrayLike Upper bounds of data required

Raises

Type Description
ValueError If lower, upper bounds are not same dimension of sample arr
ValueError Whenver any of the lower bounds are greater than any of the upper bounds

Returns

Type Description
tuple[numpy.numpy.ArrayLike, …] tuple[npt.ArrayLike, …]: A tuple of numpy.ndarrays