pyvista.core._validation.check.check_integer

check_integer(

array: _ArrayLikeOrScalar[NumberType],

/,

*,

strict: bool = False,

name: str = 'Array',

) → None

配列が整数または整数のような浮動小数点値を持つかどうかをチェックします．

パラメータ:

arrayfloat | ArrayLike[float]

Number or array to check.

strictbool, default: False

If True, the array's data must be a subtype of int or np.integer. Otherwise, floats are allowed but must be whole numbers.

namestr, default: "Array"

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

エラー処理:

ValueError

要素の値がフロアと異なる場合．

TypeError

もし strict=True で配列のdtypeがintegralでない場合．

参考

check_nonnegative

check_subdtype

例

配列が整数のような値を持つかどうかをチェックします．

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