diff options
| author | Jay Bourque <jay.bourque@continuum.io> | 2012-09-21 17:17:04 -0500 |
|---|---|---|
| committer | Jay Bourque <jay.bourque@continuum.io> | 2013-05-14 18:01:09 -0500 |
| commit | 8e642e6d69a448ed80e117644abdfde9ef2ed25b (patch) | |
| tree | bd9b9d0446c663d122dcb13b9142ac43a8f50a69 | |
| parent | 10efdbb0aca50a96f53ccabc682f23f4d4b75af9 (diff) | |
| download | numpy-8e642e6d69a448ed80e117644abdfde9ef2ed25b.tar.gz | |
Add comments for new RegisterLoopForStructType API method
| -rw-r--r-- | numpy/core/src/umath/ufunc_object.c | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/numpy/core/src/umath/ufunc_object.c b/numpy/core/src/umath/ufunc_object.c index c67874246..e7f44cd1e 100644 --- a/numpy/core/src/umath/ufunc_object.c +++ b/numpy/core/src/umath/ufunc_object.c @@ -4425,6 +4425,16 @@ _loop1d_list_free(void *ptr) /*UFUNC_API*/ +/* + * This function allows the user to register a 1-d loop for structured arrays + * with an already created ufunc. The ufunc is called whenever any of it's input + * arguments match the user_dtype argument. + * ufunc - ufunc object created from call to PyUFunc_FromFuncAndData + * user_dtype - struct dtype that ufunc will be registered with + * function - 1-d loop function pointer + * arg_dtypes - array of struct dtype objects describing the ufunc operands + * data - arbitrary data pointer passed in to loop function + */ NPY_NO_EXPORT int PyUFunc_RegisterLoopForStructType(PyUFuncObject *ufunc, PyArray_Descr *user_dtype, |