pyvista.core._validation.check.check_nonnegative

pyvista.core._validation.check.check_nonnegative#

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

配列の要素がすべて非負かどうかをチェックします.

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

Number or array to check.

namestr, default: "Array"

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

エラー処理:
ValueError

もし配列に負の値があれば.

配列の値が非負かどうかをチェックします.

>>> from pyvista import _validation
>>> _validation.check_nonnegative([1, 2, 3])