summaryrefslogtreecommitdiff
path: root/numpy/core/numeric.py
diff options
context:
space:
mode:
authorKilian Lieret <kilian.lieret@posteo.de>2022-04-22 14:47:48 +0200
committerKilian Lieret <kilian.lieret@posteo.de>2022-04-23 13:21:22 +0000
commit24d653f11a55f76b125a91d7d4523052ef14b9b9 (patch)
tree26dc9f17ca1045c87734e595770762e029b4092a /numpy/core/numeric.py
parent79a5000a72f6e4432c0a76efa6cf8e3f12ecef9e (diff)
downloadnumpy-24d653f11a55f76b125a91d7d4523052ef14b9b9.tar.gz
DOC: Use math mode
Diffstat (limited to 'numpy/core/numeric.py')
-rw-r--r--numpy/core/numeric.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py
index b89bbe457..b058d06bc 100644
--- a/numpy/core/numeric.py
+++ b/numpy/core/numeric.py
@@ -681,10 +681,10 @@ def correlate(a, v, mode='valid'):
This function computes the correlation as generally defined in signal
processing texts::
- c_{av}[k] = sum_n a[n+k] * conj(v[n])
+ .. math:: c_k = \sum_n a_{n+k} * \overline{v_n}
- with a and v sequences being zero-padded where necessary and conj being
- the conjugate.
+ with a and v sequences being zero-padded where necessary and
+ :math:`\overline x` denoting complex conjugation.
Parameters
----------
@@ -713,9 +713,9 @@ def correlate(a, v, mode='valid'):
The definition of correlation above is not unique and sometimes correlation
may be defined differently. Another common definition is::
- c'_{av}[k] = sum_n a[n] conj(v[n+k])
+ .. math:: c'_k = \sum_n a_{n} * \overline{v_{n+k}
- which is related to ``c_{av}[k]`` by ``c'_{av}[k] = c_{av}[-k]``.
+ which is related to :math:`c_k` by :math:`c'_k = c_{-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