summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2020-09-29 20:06:08 -0700
committerRoss Barnowski <rossbar@berkeley.edu>2020-09-29 20:06:08 -0700
commitd1d725b10a568da98ade43e81deeef3e41789ab8 (patch)
tree7b0f2e578e9d06e4b3b643447d1a5a93dc2e07df
parentcb107d1ca6ac633702650a21152de7d05d31862a (diff)
downloadnumpy-d1d725b10a568da98ade43e81deeef3e41789ab8.tar.gz
DOC: Add arraysetops to autosummary.
* Generate stub for module, fixes 7 broken links * Modify arraysetops module docstring w/ rst formatting * Remove listing of functions from module docstring.
-rw-r--r--doc/source/reference/routines.set.rst5
-rw-r--r--numpy/lib/arraysetops.py21
2 files changed, 10 insertions, 16 deletions
diff --git a/doc/source/reference/routines.set.rst b/doc/source/reference/routines.set.rst
index b12d3d5f5..149c33a8b 100644
--- a/doc/source/reference/routines.set.rst
+++ b/doc/source/reference/routines.set.rst
@@ -3,6 +3,11 @@ Set routines
.. currentmodule:: numpy
+.. autosummary::
+ :toctree: generated/
+
+ lib.arraysetops
+
Making proper sets
------------------
.. autosummary::
diff --git a/numpy/lib/arraysetops.py b/numpy/lib/arraysetops.py
index 6a2ad004c..9464692e0 100644
--- a/numpy/lib/arraysetops.py
+++ b/numpy/lib/arraysetops.py
@@ -1,28 +1,17 @@
"""
Set operations for arrays based on sorting.
-:Contains:
- unique,
- isin,
- ediff1d,
- intersect1d,
- setxor1d,
- in1d,
- union1d,
- setdiff1d
-
-:Notes:
+Notes
+-----
For floating point arrays, inaccurate results may appear due to usual round-off
and floating point comparison issues.
Speed could be gained in some operations by an implementation of
-sort(), that can provide directly the permutation vectors, avoiding
-thus calls to argsort().
+`numpy.sort`, that can provide directly the permutation vectors, thus avoiding
+calls to `numpy.argsort`.
-To do: Optionally return indices analogously to unique for all functions.
-
-:Author: Robert Cimrman
+Original author: Robert Cimrman
"""
import functools