Add functions to public API. (#623)

hameerabbasi · web-flow · commit 91bec56a7fd8 · 2024-01-10T10:34:01.000+01:00
diff --git a/docs/generated/sparse.abs.rst b/docs/generated/sparse.abs.rst
@@ -0,0 +1,6 @@
+abs
+===
+
+.. currentmodule:: sparse
+
+.. autofunction:: abs
diff --git a/docs/generated/sparse.all.rst b/docs/generated/sparse.all.rst
@@ -0,0 +1,6 @@
+all
+===
+
+.. currentmodule:: sparse
+
+.. autofunction:: all
diff --git a/docs/generated/sparse.any.rst b/docs/generated/sparse.any.rst
@@ -0,0 +1,6 @@
+any
+===
+
+.. currentmodule:: sparse
+
+.. autofunction:: any
diff --git a/docs/generated/sparse.argmax.rst b/docs/generated/sparse.argmax.rst
@@ -0,0 +1,6 @@
+argmax
+======
+
+.. currentmodule:: sparse
+
+.. autofunction:: argmax
diff --git a/docs/generated/sparse.argmin.rst b/docs/generated/sparse.argmin.rst
@@ -0,0 +1,6 @@
+argmin
+======
+
+.. currentmodule:: sparse
+
+.. autofunction:: argmin
diff --git a/docs/generated/sparse.asCOO.rst b/docs/generated/sparse.asCOO.rst
@@ -0,0 +1,6 @@
+asCOO
+=====
+
+.. currentmodule:: sparse
+
+.. autofunction:: asCOO
diff --git a/docs/generated/sparse.asarray.rst b/docs/generated/sparse.asarray.rst
@@ -0,0 +1,6 @@
+asarray
+=======
+
+.. currentmodule:: sparse
+
+.. autofunction:: asarray
diff --git a/docs/generated/sparse.asnumpy.rst b/docs/generated/sparse.asnumpy.rst
@@ -0,0 +1,6 @@
+asnumpy
+=======
+
+.. currentmodule:: sparse
+
+.. autofunction:: asnumpy
diff --git a/docs/generated/sparse.astype.rst b/docs/generated/sparse.astype.rst
@@ -0,0 +1,6 @@
+astype
+======
+
+.. currentmodule:: sparse
+
+.. autofunction:: astype
diff --git a/docs/generated/sparse.broadcast_arrays.rst b/docs/generated/sparse.broadcast_arrays.rst
@@ -0,0 +1,6 @@
+broadcast\_arrays
+=================
+
+.. currentmodule:: sparse
+
+.. autofunction:: broadcast_arrays
diff --git a/docs/generated/sparse.broadcast_to.rst b/docs/generated/sparse.broadcast_to.rst
@@ -0,0 +1,6 @@
+broadcast\_to
+=============
+
+.. currentmodule:: sparse
+
+.. autofunction:: broadcast_to
diff --git a/docs/generated/sparse.concat.rst b/docs/generated/sparse.concat.rst
@@ -0,0 +1,6 @@
+concat
+======
+
+.. currentmodule:: sparse
+
+.. autofunction:: concat
diff --git a/docs/generated/sparse.empty.rst b/docs/generated/sparse.empty.rst
@@ -0,0 +1,6 @@
+empty
+=====
+
+.. currentmodule:: sparse
+
+.. autofunction:: empty
diff --git a/docs/generated/sparse.empty_like.rst b/docs/generated/sparse.empty_like.rst
@@ -0,0 +1,6 @@
+empty\_like
+===========
+
+.. currentmodule:: sparse
+
+.. autofunction:: empty_like
diff --git a/docs/generated/sparse.equal.rst b/docs/generated/sparse.equal.rst
@@ -0,0 +1,6 @@
+equal
+=====
+
+.. currentmodule:: sparse
+
+.. autofunction:: equal
diff --git a/docs/generated/sparse.isfinite.rst b/docs/generated/sparse.isfinite.rst
@@ -0,0 +1,6 @@
+isfinite
+========
+
+.. currentmodule:: sparse
+
+.. autofunction:: isfinite
diff --git a/docs/generated/sparse.isinf.rst b/docs/generated/sparse.isinf.rst
@@ -0,0 +1,6 @@
+isinf
+=====
+
+.. currentmodule:: sparse
+
+.. autofunction:: isinf
diff --git a/docs/generated/sparse.isnan.rst b/docs/generated/sparse.isnan.rst
@@ -0,0 +1,6 @@
+isnan
+=====
+
+.. currentmodule:: sparse
+
+.. autofunction:: isnan
diff --git a/docs/generated/sparse.max.rst b/docs/generated/sparse.max.rst
@@ -0,0 +1,6 @@
+max
+===
+
+.. currentmodule:: sparse
+
+.. autofunction:: max
diff --git a/docs/generated/sparse.mean.rst b/docs/generated/sparse.mean.rst
@@ -0,0 +1,6 @@
+mean
+====
+
+.. currentmodule:: sparse
+
+.. autofunction:: mean
diff --git a/docs/generated/sparse.min.rst b/docs/generated/sparse.min.rst
@@ -0,0 +1,6 @@
+min
+===
+
+.. currentmodule:: sparse
+
+.. autofunction:: min
diff --git a/docs/generated/sparse.nonzero.rst b/docs/generated/sparse.nonzero.rst
@@ -0,0 +1,6 @@
+nonzero
+=======
+
+.. currentmodule:: sparse
+
+.. autofunction:: nonzero
diff --git a/docs/generated/sparse.permute_dims.rst b/docs/generated/sparse.permute_dims.rst
@@ -0,0 +1,6 @@
+permute\_dims
+=============
+
+.. currentmodule:: sparse
+
+.. autofunction:: permute_dims
diff --git a/docs/generated/sparse.prod.rst b/docs/generated/sparse.prod.rst
@@ -0,0 +1,6 @@
+prod
+====
+
+.. currentmodule:: sparse
+
+.. autofunction:: prod
diff --git a/docs/generated/sparse.reshape.rst b/docs/generated/sparse.reshape.rst
@@ -0,0 +1,6 @@
+reshape
+=======
+
+.. currentmodule:: sparse
+
+.. autofunction:: reshape
diff --git a/docs/generated/sparse.round.rst b/docs/generated/sparse.round.rst
@@ -0,0 +1,6 @@
+round
+=====
+
+.. currentmodule:: sparse
+
+.. autofunction:: round
diff --git a/docs/generated/sparse.rst b/docs/generated/sparse.rst
@@ -18,21 +18,42 @@ API
 
     SparseArray
 
-
-
-
 .. rubric:: Functions
 .. autosummary::
     :toctree:
 
+    abs
+
+    all
+
+    any
+
+    argmax
+
+    argmin
+
     argwhere
 
+    asCOO
+
     as_coo
 
-    concatenate
+    asarray
+
+    asnumpy
+
+    astype
+
+    broadcast_arrays
+
+    broadcast_to
 
     clip
 
+    concat
+
+    concatenate
+
     diagonal
 
     diagonalize
@@ -43,22 +64,42 @@ API
 
     elemwise
 
+    empty
+
+    empty_like
+
+    equal
+
     eye
 
     full
 
     full_like
 
-    isposinf
+    isfinite
+
+    isinf
+
+    isnan
 
     isneginf
 
+    isposinf
+
     kron
 
     load_npz
 
     matmul
 
+    max
+
+    mean
+
+    min
+
+    moveaxis
+
     moveaxis
 
     nanmax
@@ -73,6 +114,8 @@ API
 
     nansum
 
+    nonzero
+
     ones
 
     ones_like
@@ -81,22 +124,40 @@ API
 
     pad
 
+    permute_dims
+
+    prod
+
     random
 
+    reshape
+
     result_type
 
     roll
 
+    round
+
     save_npz
 
+    squeeze
+
     stack
 
+    std
+
+    sum
+
     tensordot
 
     tril
 
     triu
 
+    unique_counts
+
+    unique_values
+
     where
 
     zeros
diff --git a/docs/generated/sparse.squeeze.rst b/docs/generated/sparse.squeeze.rst
@@ -0,0 +1,6 @@
+squeeze
+=======
+
+.. currentmodule:: sparse
+
+.. autofunction:: squeeze
diff --git a/docs/generated/sparse.std.rst b/docs/generated/sparse.std.rst
@@ -0,0 +1,6 @@
+std
+===
+
+.. currentmodule:: sparse
+
+.. autofunction:: std
diff --git a/docs/generated/sparse.sum.rst b/docs/generated/sparse.sum.rst
@@ -0,0 +1,6 @@
+sum
+===
+
+.. currentmodule:: sparse
+
+.. autofunction:: sum
diff --git a/docs/generated/sparse.unique_counts.rst b/docs/generated/sparse.unique_counts.rst
@@ -0,0 +1,6 @@
+unique\_counts
+==============
+
+.. currentmodule:: sparse
+
+.. autofunction:: unique_counts
diff --git a/docs/generated/sparse.unique_values.rst b/docs/generated/sparse.unique_values.rst
@@ -0,0 +1,6 @@
+unique\_values
+==============
+
+.. currentmodule:: sparse
+
+.. autofunction:: unique_values
diff --git a/sparse/__init__.py b/sparse/__init__.py
diff --git a/sparse/_coo/common.py b/sparse/_coo/common.py

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +abs
 +===
++
 +.. currentmodule:: sparse
++
 +.. autofunction:: abs