summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api.ufunc.rst
diff options
context:
space:
mode:
authorMark Wiebe <mwwiebe@gmail.com>2011-01-20 13:43:23 -0800
committerMark Wiebe <mwwiebe@gmail.com>2011-01-20 13:43:23 -0800
commita8f5b4ca6759c46abf4d169bed0178559518b641 (patch)
treecaf87360e22d8dfc0bf85b4bfa8d1c601864eaa7 /doc/source/reference/c-api.ufunc.rst
parentfa08ee2832e68f91a4ea38aa8d1d55dbb143cfd4 (diff)
downloadnumpy-a8f5b4ca6759c46abf4d169bed0178559518b641.tar.gz
ENH: ufunc: Restructure iterator ufunc evaluation into functions
Diffstat (limited to 'doc/source/reference/c-api.ufunc.rst')
-rw-r--r--doc/source/reference/c-api.ufunc.rst20
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/source/reference/c-api.ufunc.rst b/doc/source/reference/c-api.ufunc.rst
index f299251cb..45268b261 100644
--- a/doc/source/reference/c-api.ufunc.rst
+++ b/doc/source/reference/c-api.ufunc.rst
@@ -153,15 +153,17 @@ Functions
followed by the outputs assumed by the 1-d loop.
.. cfunction:: int PyUFunc_GenericFunction(PyUFuncObject* self,
- PyObject* args, PyArrayObject** mps)
-
- A generic ufunc call. The ufunc is passed in as *self*, the
- arguments to the ufunc as *args*. The *mps* argument is an array
- of :ctype:`PyArrayObject` pointers containing the converted input
- arguments as well as the ufunc outputs on return. The user is
- responsible for managing this array and receives a new reference
- for each array in *mps*. The total number of arrays in *mps* is
- given by *self* ->nin + *self* ->nout.
+ PyObject* args, PyObject* kwds, PyArrayObject** mps)
+
+ A generic ufunc call. The ufunc is passed in as *self*, the arguments
+ to the ufunc as *args* and *kwds*. The *mps* argument is an array of
+ :ctype:`PyArrayObject` pointers whose values are discarded and which
+ receive the converted input arguments as well as the ufunc outputs
+ when success is returned. The user is responsible for managing this
+ array and receives a new reference for each array in *mps*. The total
+ number of arrays in *mps* is given by *self* ->nin + *self* ->nout.
+
+ Returns 0 on success, -1 on error.
.. cfunction:: int PyUFunc_checkfperr(int errmask, PyObject* errobj)