pyvista.core._validation.check.check_nonnegative

check_nonnegative(

array: _ArrayLikeOrScalar[NumberType],

/,

*,

name: str = 'Array',

) → None

Check if an array’s elements are all nonnegative.

Parameters:

arrayfloat | ArrayLike[float]

Number or array to check.

namestr, default: “Array”

Variable name to use in the error messages if any are raised.

Raises:

ValueError

If the array has any negative values.

See also

check_greater_than

check_less_than

Examples

Check if an array’s values are non-negative.

>>> from pyvista import _validation
>>> _validation.check_nonnegative([1, 2, 3])