pyvista.core._validation.check

pyvista.core._validation.check#

入力のタイプと/または値をチェックする関数.

Added in version 0.43.0.

check 関数は通常,次のように動作します:

  • 単一の入力変数に対して単純な検証を行う.

  • 無効な入力によりチェックに失敗した場合,エラーを発生させます.

  • 入力を変更したり,何も返したりしません.

関数

check_contains(container, /, must_contain, *)

Check if an item is in a container.

check_finite(array, /, *[, name])

配列が有限の値を持つかどうか,つまりNaNやInfの値を持たないかどうかをチェックします.

check_greater_than(array, /, value, *[, ...])

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

check_instance(obj, /, classinfo, *[, ...])

オブジェクトが与えられた型または複数型のインスタンスであるかどうかをチェックします.

check_integer(array, /, *[, strict, name])

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

check_iterable(obj, /, *[, name])

オブジェクトが Iterable のインスタンスであるかどうかをチェックします.

check_iterable_items(iterable_obj, /, ...[, ...])

イテラブルのアイテムがすべて指定された型を持っているかどうかをチェックします.

check_length(sized_input, /[, exact_length, ...])

配列の長さが特定の条件を満たすかどうかをチェックします.

check_less_than(array, /, value, *[, ...])

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

check_ndim(array, /, ndim, *[, name])

Check if an array has the specified number of dimensions.

check_nonnegative(array, /, *[, name])

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

check_number(num, /, *[, name])

オブジェクトが Number のインスタンスであるかどうかをチェックします.

check_range(array, /, rng, *[, ...])

配列の値がすべて特定の範囲内にあるかどうかをチェックします.

check_real(array, /, *[, name])

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

check_sequence(obj, /, *[, name])

オブジェクトが Sequence のインスタンスであるかどうかをチェックします.

check_shape(array, /, shape, *[, name])

配列が指定された形状を持つかどうかをチェックします.

check_sorted(array, /, *[, ascending, ...])

配列の値がソートされているかどうかをチェックします.

check_string(obj, /, *[, allow_subclass, name])

オブジェクトが str のインスタンスであるかどうかをチェックします.

check_subdtype(input_obj, /, base_dtype, *)

Check if an input's data-type is a subtype of another data-type(s).

check_type(obj, /, classinfo, *[, name])

オブジェクトが与えられた型または複数型のどれかであるかどうかをチェックします.