pyvista.core._validation.validate.validate_arrayN_unsigned

pyvista.core._validation.validate.validate_arrayN_unsigned#

validate_arrayN_unsigned(
arr: VectorLike[float],
/,
*,
reshape: bool = True,
**kwargs,
) → NumpyArray[int][ソース]#

非負 (符号なし) 整数の数値1次元配列を検証する．

配列は，入力値を確認するためにチェックされます:

  • は (N,) の形状を持つか， (N,) に整形することができます．

  • integer-like

  • 非負

返される配列はその値が以下となるようにフォーマットされます:

  • (N,) の形をしています

  • データ型が整数

パラメータ:
arrVectorLike[float]

検証する配列．

reshapebool, default: True

もし True ならば，0次元のスカラーは (1,) に整形され，形状 (1, N) の2次元のベクトルは (1, N) に整形されます．そうでない場合，スカラーと2次元の入力はすべて無効とみなされます．

**kwargsdict, optional

validate_array() に渡す追加のキーワード引数です．

戻り値:
np.ndarray

非負の整数を持つ有効な数値の1次元配列．

参考

validate_arrayN

数値一次元配列の同様な関数 ．

validate_array

汎用的な配列検証関数．

例

4つの非負integer-like要素を持つ1次元配列を検証します．

>>> import numpy as np
>>> from pyvista import _validation
>>> arr = _validation.validate_arrayN_unsigned((1.0, 2.0, 3.0, 4.0))
>>> arr
array([1, 2, 3, 4])

出力データ型が整数であることを確認します．

>>> np.issubdtype(arr.dtype, int)
True

スカラー0次元の値は，自動的に1次元に整形されます．

>>> _validation.validate_arrayN_unsigned(42)
array([42])

最初の次元が単一である2D配列は，自動的に1Dに整形されます．

>>> _validation.validate_arrayN_unsigned([[1, 2]])
array([1, 2])

必要に応じて制約を追加します．

>>> _validation.validate_arrayN_unsigned((1, 2, 3), must_be_in_range=[1, 3])
array([1, 2, 3])
目次