summaryrefslogtreecommitdiff
path: root/numpy/core/numeric.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/core/numeric.py')
-rw-r--r--numpy/core/numeric.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py
index a9749b479..27f4a068c 100644
--- a/numpy/core/numeric.py
+++ b/numpy/core/numeric.py
@@ -207,6 +207,10 @@ def _mode_from_name(mode):
return mode
def correlate(a,v,mode='valid'):
+ """Return the discrete, linear correlation of 1-D sequences
+ a and v; mode can be 0 (valid), 1 (same), or 2 (full)
+ to specify the size of the resulting sequence
+ """
mode = _mode_from_name(mode)
return multiarray.correlate(a,v,mode)