`scipy._external.array_api_extra.testing:assert_less`

source: build-install/usr/lib/python3.14/site-packages/scipy/_external/array_api_extra/testing.py:894

Signature

def assert_less(x: Array, y: Array, *, err_msg: str = '', verbose: bool = True, check_dtype: bool = True, check_shape: bool = True, check_scalar: bool = False, check_device: bool = True, xp: ArrayNamespace | None = None) → None

Summary

Check that two arrays are ordered by less than.

Extended Summary

This is an interface to numpy.testing.assert_array_less which accepts any standard-compatible array and performs additional array namespace, shape, and dtype checks.

Parameters

x, y : Array: Array to compare according to x < y (elementwise).
err_msg : str, optional: Error message to display on failure.
verbose : bool, default: True: Whether to include the conflicting arrays in the error message on failure.
check_dtype : bool, default: True: Whether to check agreement between the dtypes of x and y.
check_shape : bool, default: True: Whether to check agreement between the shapes of x and y.
check_scalar : bool, default: False: NumPy only: whether to check agreement between actual and desired types — 0-D numpy.ndarray vs scalar (e.g. numpy.double).
check_device : bool, default: True: Whether to check agreement between actual and desired devices.
xp : array_namespace, optional: A standard-compatible namespace which x and y must match.

Raises

: AssertionError: If x is not strictly smaller than y, elementwise.
: ImportError: If numpy is not importable in the Python environment.

Aliases