pyvista_validation.check.check_finite

pyvista_validation.check.check_finite(array, *, name='Array')

Check if an array has finite values, that is, no NaN or Inf values.

Parameters:

arrayfloat | ArrayLikeFloat

Number or array to check.

namestr, default: “Array”

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

Returns:

array_like

The input, unchanged.

Raises:

ValueError

If the array has any Inf or NaN values.

See also

check_real

Examples

Check if an array’s values are finite.

>>> from pyvista_validation import check_finite
>>> check_finite([1, 2, 3])
[1, 2, 3]