summaryrefslogtreecommitdiff
path: root/numpy/core/numeric.py
diff options
context:
space:
mode:
authorFrançois Le Lay <mfworx@gmail.com>2021-02-17 07:24:39 -0500
committerGitHub <noreply@github.com>2021-02-17 07:24:39 -0500
commitdd20b6241590622e847eb4538a224e87eff483f9 (patch)
treece19093db8a459c59819d64e887bb893f5ed11c6 /numpy/core/numeric.py
parent98bf466b42aea9bb804275af6f11d1c7cfdebbad (diff)
parent6f65e1fc25f265ff36bdbfb3aa482f65fd84a684 (diff)
downloadnumpy-dd20b6241590622e847eb4538a224e87eff483f9.tar.gz
Merge branch 'master' into random-standard_t-doc
Diffstat (limited to 'numpy/core/numeric.py')
-rw-r--r--numpy/core/numeric.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py
index 89f56fa09..7675386e7 100644
--- a/numpy/core/numeric.py
+++ b/numpy/core/numeric.py
@@ -710,6 +710,7 @@ def correlate(a, v, mode='valid'):
--------
convolve : Discrete, linear convolution of two one-dimensional sequences.
multiarray.correlate : Old, no conjugate, version of correlate.
+ scipy.signal.correlate : uses FFT which has superior performance on large arrays.
Notes
-----
@@ -720,6 +721,11 @@ def correlate(a, v, mode='valid'):
which is related to ``c_{av}[k]`` by ``c'_{av}[k] = c_{av}[-k]``.
+ `numpy.correlate` may perform slowly in large arrays (i.e. n = 1e5) because it does
+ not use the FFT to compute the convolution; in that case, `scipy.signal.correlate` might
+ be preferable.
+
+
Examples
--------
>>> np.correlate([1, 2, 3], [0, 1, 0.5])