Rename check functions in dpnp_utils_linalg.py (#1807)

* Add check_2d to __all__ for dpnp_utils_linalg.py

* Rename check_2d to assert_2d

* Rename check_stacked_2d to assert_stacked_2d

* Rename check_stacked_square to assert_stacked_square

---------

Co-authored-by: Anton <[email protected]>

Author: vlad-perevezentsev

dpnp/linalg/dpnp_iface_linalg.py

@@ -42,9 +42,9 @@
 import dpnp
 
 from .dpnp_utils_linalg import (
-    check_2d,
-    check_stacked_2d,
-    check_stacked_square,
+    assert_2d,
+    assert_stacked_2d,
+    assert_stacked_square,
     dpnp_cholesky,
     dpnp_cond,
     dpnp_det,
@@ -140,8 +140,8 @@ def cholesky(a, upper=False):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     return dpnp_cholesky(a, upper=upper)
 
@@ -243,8 +243,8 @@ def det(a):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     return dpnp_det(a)
 
@@ -334,8 +334,8 @@ def eig(a):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     a_sycl_queue = a.sycl_queue
     a_usm_type = a.usm_type
@@ -408,8 +408,8 @@ def eigh(a, UPLO="L"):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     UPLO = UPLO.upper()
     if UPLO not in ("L", "U"):
@@ -478,8 +478,8 @@ def eigvals(a):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     # Since geev function from OneMKL LAPACK is not implemented yet,
     # use NumPy for this calculation.
@@ -535,8 +535,8 @@ def eigvalsh(a, UPLO="L"):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     UPLO = UPLO.upper()
     if UPLO not in ("L", "U"):
@@ -591,8 +591,8 @@ def inv(a):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     return dpnp_inv(a)
 
@@ -663,7 +663,7 @@ def lstsq(a, b, rcond=None):
     """
 
     dpnp.check_supported_arrays_type(a, b)
-    check_2d(a)
+    assert_2d(a)
     if rcond is not None and not isinstance(rcond, (int, float)):
         raise TypeError("rcond must be integer, floating type, or None")
 
@@ -724,8 +724,8 @@ def matrix_power(a, n):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     if not isinstance(n, int):
         raise TypeError("exponent must be an integer")
@@ -896,7 +896,7 @@ def pinv(a, rcond=1e-15, hermitian=False):
 
     dpnp.check_supported_arrays_type(a)
     dpnp.check_supported_arrays_type(rcond, scalar_type=True)
-    check_stacked_2d(a)
+    assert_stacked_2d(a)
 
     return dpnp_pinv(a, rcond=rcond, hermitian=hermitian)
 
@@ -1067,7 +1067,7 @@ def qr(a, mode="reduced"):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
+    assert_stacked_2d(a)
 
     if mode not in ("reduced", "complete", "r", "raw"):
         raise ValueError(f"Unrecognized mode {mode}")
@@ -1114,8 +1114,8 @@ def solve(a, b):
     """
 
     dpnp.check_supported_arrays_type(a, b)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     if not (
         (a.ndim == b.ndim or a.ndim == b.ndim + 1)
@@ -1222,7 +1222,7 @@ def svd(a, full_matrices=True, compute_uv=True, hermitian=False):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
+    assert_stacked_2d(a)
 
     return dpnp_svd(a, full_matrices, compute_uv, hermitian)
 
@@ -1277,8 +1277,8 @@ def slogdet(a):
     """
 
     dpnp.check_supported_arrays_type(a)
-    check_stacked_2d(a)
-    check_stacked_square(a)
+    assert_stacked_2d(a)
+    assert_stacked_square(a)
 
     return dpnp_slogdet(a)
 

dpnp/linalg/dpnp_utils_linalg.py

@@ -35,8 +35,9 @@
 from dpnp.dpnp_utils import get_usm_allocations
 
 __all__ = [
-    "check_stacked_2d",
-    "check_stacked_square",
+    "assert_2d",
+    "assert_stacked_2d",
+    "assert_stacked_square",
     "dpnp_cholesky",
     "dpnp_cond",
     "dpnp_det",
@@ -683,9 +684,9 @@ def _triu_inplace(a, host_tasks, depends=None):
     return out
 
 
-def check_2d(*arrays):
+def assert_2d(*arrays):
     """
-    Return ``True`` if each array in `arrays` is exactly two dimensions.
+    Check that each array in `arrays` is exactly two-dimensional.
 
     If any array is not two-dimensional, `dpnp.linalg.LinAlgError` will be raised.
 
@@ -694,11 +695,6 @@ def check_2d(*arrays):
     arrays : {dpnp.ndarray, usm_ndarray}
         A sequence of input arrays to check for dimensionality.
 
-    Returns
-    -------
-    out : bool
-        ``True`` if each array in `arrays` is exactly two-dimensional.
-
     Raises
     ------
     dpnp.linalg.LinAlgError
@@ -714,9 +710,9 @@ def check_2d(*arrays):
             )
 
 
-def check_stacked_2d(*arrays):
+def assert_stacked_2d(*arrays):
     """
-    Return ``True`` if each array in `arrays` has at least two dimensions.
+    Check that each array in `arrays` has at least two dimensions.
 
     If any array is less than two-dimensional, `dpnp.linalg.LinAlgError` will be raised.
 
@@ -725,11 +721,6 @@ def check_stacked_2d(*arrays):
     arrays : {dpnp.ndarray, usm_ndarray}
         A sequence of input arrays to check for dimensionality.
 
-    Returns
-    -------
-    out : bool
-        ``True`` if each array in `arrays` is at least two-dimensional.
-
     Raises
     ------
     dpnp.linalg.LinAlgError
@@ -745,30 +736,25 @@ def check_stacked_2d(*arrays):
             )
 
 
-def check_stacked_square(*arrays):
+def assert_stacked_square(*arrays):
     """
-    Return ``True`` if each array in `arrays` is a square matrix.
+    Check that each array in `arrays` is a square matrix.
 
     If any array does not form a square matrix, `dpnp.linalg.LinAlgError` will be raised.
 
     Precondition: `arrays` are at least 2d. The caller should assert it
     beforehand. For example,
 
     >>> def solve(a):
-    ...     check_stacked_2d(a)
-    ...     check_stacked_square(a)
+    ...     assert_stacked_2d(a)
+    ...     assert_stacked_square(a)
     ...     ...
 
     Parameters
     ----------
     arrays : {dpnp.ndarray, usm_ndarray}
         A sequence of input arrays to check for square matrix shape.
 
-    Returns
-    -------
-    out : bool
-        ``True`` if each array in `arrays` forms a square matrix.
-
     Raises
     ------
     dpnp.linalg.LinAlgError
@@ -2309,7 +2295,7 @@ def dpnp_svd(
     """
 
     if hermitian:
-        check_stacked_square(a)
+        assert_stacked_square(a)
 
         # _gesvd returns eigenvalues with s ** 2 sorted descending,
         # but dpnp.linalg.eigh returns s sorted ascending so we re-order the eigenvalues