From 3f800a240b613a88e1437b618764333770720b79 Mon Sep 17 00:00:00 2001 From: Holger Kohr Date: Mon, 22 Jan 2018 10:41:33 +0100 Subject: [PATCH] DOC: add Return section to convolve doc --- odl/oplib/convolution.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/odl/oplib/convolution.py b/odl/oplib/convolution.py index c3224aa59b1..5bdc94b6b1f 100644 --- a/odl/oplib/convolution.py +++ b/odl/oplib/convolution.py @@ -792,6 +792,13 @@ def convolve(x, y, out=None, **kwargs): Apply zero-padding with this target shape. Cannot be used together with ``padding``. + Returns + ------- + convolved : `Tensor` + The convolution of ``x`` and ``y``. If ``x`` is of type + `DiscreteLpElement`, so is the result. Otherwise the returned + type is `NumpyTensor`. + See Also -------- correlate