pyvista.core._validation.check.check_real

目次

pyvista.core._validation.check.check_real#

check_real(array: _ArrayLikeOrScalar[NumberType], /, *, name: str = 'Array') → None[ソース]#

配列が実数，すなわち浮動小数点数型か整数型かをチェックします．

パラメータ:
arrayfloat | ArrayLike[float]

Number or array to check.

namestr, default: "Array"

エラーメッセージが発生した場合に使用する変数名．

エラー処理:
TypeError

配列が実数を持たない場合．

参考

check_integer

Similar function for integer arrays.

check_number

Similar function for scalar values.

check_finite

Check for finite values.

備考

  • Boolean data types are not considered real and will raise an error.

  • Arrays with infinity or NaN values are considered real and will not raise an error. Use check_finite() to check for finite values.

例

配列が実数値を持つかどうかをチェックします．

>>> from pyvista import _validation
>>> _validation.check_real([1, 2, 3])
目次