cunumeric.ndim (nv-legate#495)

* Add cunumeric.ndim

* Add Avail. info to ndim, add to docs and API comparison table

* Add some missing function references to docs

* Test cases passing Python values to cunumeric.ndim

Co-authored-by: Manolis Papadakis <manopapad@gmail.com>

cunumeric/_sphinxext/_comparison_config.py

@@ -46,7 +46,6 @@
     "iterable",
     "max",
     "min",
-    "ndim",
     "product",
     "recfromcsv",
     "recfromtxt",
@@ -335,7 +334,7 @@ class SectionConfig:
     "var",
 )
 
-MISC = ("kron",)
+MISC = ("kron", "ndim")
 
 PACK = ("packbits", "unpackbits")
 

cunumeric/module.py

@@ -972,6 +972,36 @@ def triu(m: ndarray, k: int = 0) -> ndarray:
 # Basic operations
 
 
+@add_boilerplate("a")
+def ndim(a: ndarray) -> int:
+    """
+
+    Return the number of dimensions of an array.
+
+    Parameters
+    ----------
+    a : array_like
+        Input array.  If it is not already an ndarray, a conversion is
+        attempted.
+
+    Returns
+    -------
+    number_of_dimensions : int
+        The number of dimensions in `a`.  Scalars are zero-dimensional.
+
+    See Also
+    --------
+    ndarray.ndim : equivalent method
+    shape : dimensions of array
+    ndarray.shape : dimensions of array
+
+    Availability
+    --------
+    Multiple GPUs, Multiple CPUs
+    """
+    return a.ndim
+
+
 @add_boilerplate("a")
 def shape(a: ndarray) -> NdShape:
     """

docs/cunumeric/source/api/manipulation.rst

@@ -9,6 +9,7 @@ Basic operations
 .. autosummary::
    :toctree: generated/
 
+   ndim
    shape
 
 

docs/cunumeric/source/api/math.rst

@@ -57,6 +57,10 @@ Sums, products, differences
 
    prod
    sum
+   cumprod
+   cumsum
+   nancumprod
+   nancumsum
 
 
 Exponents and logarithms

docs/cunumeric/source/api/ndarray.rst

@@ -156,12 +156,12 @@ Calculation
    .. ndarray.round
    .. ndarray.trace
    ndarray.sum
-   .. ndarray.cumsum
+   ndarray.cumsum
    ndarray.mean
    .. ndarray.var
    .. ndarray.std
    ndarray.prod
-   .. ndarray.cumprod
+   ndarray.cumprod
    ndarray.all
    ndarray.any
    ndarray.unique

tests/integration/test_ndim.py

@@ -0,0 +1,40 @@
+# Copyright 2022 NVIDIA Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import numpy as np
+import pytest
+
+import cunumeric as num
+from legate.core import LEGATE_MAX_DIM
+
+
+@pytest.mark.parametrize("ndim", range(LEGATE_MAX_DIM + 1))
+def test_ndarray(ndim):
+    shape = (4,) * ndim
+    a = num.ones(shape)
+    a_np = np.array(a)
+
+    assert np.ndim(a_np) == num.ndim(a)
+
+
+@pytest.mark.parametrize("input", (42, [0, 1, 2], [[0, 1, 2], [3, 4, 5]]))
+def test_python_values(input):
+    assert np.ndim(input) == num.ndim(input)
+
+
+if __name__ == "__main__":
+    import sys
+
+    sys.exit(pytest.main(sys.argv))