pyvista.core._validation.check.check_sorted

check_sorted(

array: _ArrayLikeOrScalar[NumberType],

/,

*,

ascending: bool = True,

strict: bool = False,

axis: int = -1,

name: str = 'Array',

) → None

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

パラメータ:

arrayfloat | ArrayLike[float]

Number or array to check.

ascendingbool, default: True

もし True ならば，配列の要素が昇順かどうかをチェックします．もし False なら，配列の要素が降順かどうかをチェックします．

strictbool, default: False

もし True ならば，配列の要素は厳密に増加するか（もし ascending=True ならば），厳密に減少しなければなりません（もし ascending=False ならば）．事実上，これは配列がソートされていること、そしてその値が一意であることを意味します。

axisint | None, default: -1

Axis along which to check sorting. If None, the array is flattened before checking. The default is -1, which checks sorting along the last axis.

namestr, default: "Array"

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

エラー処理:

ValueError

配列が昇順にソートされていない場合．

参考

check_range

例

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

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