pyvista.core._validation.check.check_length

check_length(

sized_input: float | Sized,

/,

exact_length: int | VectorLike[int] | None = None,

*,

min_length: int | None = None,

max_length: int | None = None,

must_be_1d: bool = False,

allow_scalar: bool = False,

name: str = 'Array',

) → None

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

パラメータ:

sized_inputfloat | Sized

Number or array to check.

exact_lengthint | VectorLike[int], optional

配列が与えられた長さを持つかどうかをチェックします．複数の数値が与えられた場合，配列の長さはいずれかの数値と一致しなければなりません．

min_lengthint, optional

配列がこの長さ以上かどうかをチェックします．

max_lengthint, optional

配列がこの長さ以下かどうかをチェックします．

must_be_1dbool, default: False

もし True ならば，配列の形状が一次元であるかどうか，つまり配列の形状が (1,) であるかどうかをチェックします．

allow_scalarbool, default: False

もし True ならば，スカラー入力は1の長さを持つように整形されます．そうでなければ，スカラーは長さを持たないのでチェックは失敗します．

namestr, default: "Array"

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

エラー処理:

ValueError

配列の長さが指定範囲外の場合．

参考

check_shape

check_ndim

備考

デフォルトでは、この関数は多次元配列に対して動作し， len(arr) は配列の要素数と異なる場合があります．一次元の場合 (len(arr) == arr.size の場合）には， must_be_1D=True を設定してください．

例

配列が長さが2か3かどうかをチェックします．

>>> from pyvista import _validation
>>> _validation.check_length([1, 2], exact_length=[2, 3])

配列が最小長さが3かどうかをチェックします．

>>> _validation.check_length((1, 2, 3), min_length=3)

多次元配列の最大長さが2かどうかをチェックします．

>>> _validation.check_length([[1, 2, 3], [4, 5, 6]], max_length=2)