pyvista.core._validation.check.check_greater_than

check_greater_than(

array: _ArrayLikeOrScalar[NumberType],

/,

value: float,

*,

strict: bool = True,

name: str = 'Array',

) → None

配列の要素がすべてある値より大きいかどうかをチェックします．

パラメータ:

arrayfloat | ArrayLike[float]

Number or array to check.

valuefloat

配列の要素がより大きくなければならない値．

strictbool, default: True

もし True ならば，配列の値は value よりも厳密に大きくなければなりません．そうでない場合，値は value よりも大きいか等しくなければなりません．

namestr, default: "Array"

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

エラー処理:

ValueError

配列の全ての要素が指定された値より大きくない場合（ strict=True の場合は等しい場合）．

参考

check_less_than

check_range

check_nonnegative

例

配列の値が0より大きいかどうかをチェックします．

>>> from pyvista import _validation
>>> _validation.check_greater_than([1, 2, 3], value=0)