pyvista.core._validation.check.check_integer

check_integer(arr, /, *, strict=False, name='Array')

Check if an array has integer or integer-like float values.

Parameters:

arrarray_like

Array to check.

strictbool, default: False

If True, the array’s data must be a subtype of np.integer (i.e. float types are not allowed).

namestr, default: “Array”

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

Raises:

ValueError

If any element’s value differs from its floor.

TypeError

If strict=True and the array’s dtype is not integral.

See also

check_nonnegative

Examples

Check if an array has integer-like values.

>>> from pyvista import _validation
>>> _validation.check_integer([1.0, 2.0])