File tree Expand file tree Collapse file tree 1 file changed +4
-9
lines changed Expand file tree Collapse file tree 1 file changed +4
-9
lines changed Original file line number Diff line number Diff line change 36
36
37
37
__all__ = [
38
38
"assert_2d" ,
39
- "check_stacked_2d " ,
39
+ "assert_stacked_2d " ,
40
40
"check_stacked_square" ,
41
41
"dpnp_cholesky" ,
42
42
"dpnp_cond" ,
@@ -710,9 +710,9 @@ def assert_2d(*arrays):
710
710
)
711
711
712
712
713
- def check_stacked_2d (* arrays ):
713
+ def assert_stacked_2d (* arrays ):
714
714
"""
715
- Return ``True`` if each array in `arrays` has at least two dimensions.
715
+ Check that each array in `arrays` has at least two dimensions.
716
716
717
717
If any array is less than two-dimensional, `dpnp.linalg.LinAlgError` will be raised.
718
718
@@ -721,11 +721,6 @@ def check_stacked_2d(*arrays):
721
721
arrays : {dpnp.ndarray, usm_ndarray}
722
722
A sequence of input arrays to check for dimensionality.
723
723
724
- Returns
725
- -------
726
- out : bool
727
- ``True`` if each array in `arrays` is at least two-dimensional.
728
-
729
724
Raises
730
725
------
731
726
dpnp.linalg.LinAlgError
@@ -751,7 +746,7 @@ def check_stacked_square(*arrays):
751
746
beforehand. For example,
752
747
753
748
>>> def solve(a):
754
- ... check_stacked_2d (a)
749
+ ... assert_stacked_2d (a)
755
750
... check_stacked_square(a)
756
751
... ...
757
752
You can’t perform that action at this time.
0 commit comments