summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api.ufunc.rst
diff options
context:
space:
mode:
authorJay Bourque <jay.bourque@continuum.io>2013-05-13 10:50:55 -0500
committerJay Bourque <jay.bourque@continuum.io>2013-05-14 18:02:22 -0500
commitc2f30f9eca1a513601b27d2ae2a9c85d3ad15860 (patch)
tree29af816e49c4ba70f39ff9bf69f5ab50ba45c54e /doc/source/reference/c-api.ufunc.rst
parent84fa1845878c070f190f15e37507bb7575c39d06 (diff)
downloadnumpy-c2f30f9eca1a513601b27d2ae2a9c85d3ad15860.tar.gz
Change name of RegisterLoopForStructType to RegisterLoopByDescr
Diffstat (limited to 'doc/source/reference/c-api.ufunc.rst')
-rw-r--r--doc/source/reference/c-api.ufunc.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/source/reference/c-api.ufunc.rst b/doc/source/reference/c-api.ufunc.rst
index 1dfc0c6c9..a01f32355 100644
--- a/doc/source/reference/c-api.ufunc.rst
+++ b/doc/source/reference/c-api.ufunc.rst
@@ -140,13 +140,15 @@ Functions
in as *arg_types* which must be a pointer to memory at least as
large as ufunc->nargs.
-.. cfunction:: int PyUFunc_RegisterLoopForStructType(PyUFuncObject* ufunc,
+.. cfunction:: int PyUFunc_RegisterLoopByDescr(PyUFuncObject* ufunc,
PyArray_Descr* userdtype, PyUFuncGenericFunction function,
PyArray_Descr** arg_dtypes, void* data)
This function behaves like PyUFunc_RegisterLoopForType above, except
- that it allows the user to register a 1-d loop for structured array
- data-dtypes instead of scalar data-types.
+ that it allows the user to register a 1-d loop using PyArray_Descr
+ objects instead of dtype type num values. This allows a 1-d loop to be
+ registered for structured array data-dtypes and custom data-types
+ instead of scalar data-types.
.. cfunction:: int PyUFunc_ReplaceLoopBySignature(PyUFuncObject* ufunc,
PyUFuncGenericFunction newfunc, int* signature,