diff options
| author | Travis Oliphant <oliphant@enthought.com> | 2006-11-17 00:33:28 +0000 |
|---|---|---|
| committer | Travis Oliphant <oliphant@enthought.com> | 2006-11-17 00:33:28 +0000 |
| commit | e6ef04049867f2174c766e2e81e27d79f531b44d (patch) | |
| tree | 492a8f6a235f91c7ddf66322a080724ff7a6e9c5 /numpy/core/numeric.py | |
| parent | 20cd8f309b54b4cab803c625abb90f5cb2cccb0b (diff) | |
| download | numpy-e6ef04049867f2174c766e2e81e27d79f531b44d.tar.gz | |
Add docstring to correlate.
Diffstat (limited to 'numpy/core/numeric.py')
| -rw-r--r-- | numpy/core/numeric.py | 4 |
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) |