pyvista.core._validation.check.check_less_than

pyvista.core._validation.check.check_less_than#

check_less_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 の場合は等しい場合).

配列の値が0より小さいかどうかをチェックします.

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