summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortakanori-pskq <takanori17h@gmail.com>2020-10-25 14:01:25 +0900
committertakanori-pskq <takanori17h@gmail.com>2020-10-25 14:02:38 +0900
commit70c3565244ada9edaae1c1f86e48fb42cfde04d3 (patch)
tree75e5690d11773483b110255bcb9db41a5c323c79
parentd483de0f32baec73b0856230dd35f08373ecbb85 (diff)
downloadnumpy-70c3565244ada9edaae1c1f86e48fb42cfde04d3.tar.gz
DOC: Add ``identity_value`` to ``PyUFuncObject``
-rw-r--r--doc/source/reference/c-api/types-and-structures.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/source/reference/c-api/types-and-structures.rst b/doc/source/reference/c-api/types-and-structures.rst
index 8c1a679dc..d9c48c039 100644
--- a/doc/source/reference/c-api/types-and-structures.rst
+++ b/doc/source/reference/c-api/types-and-structures.rst
@@ -790,8 +790,8 @@ PyUFunc_Type and PyUFuncObject
npy_uint32 *iter_flags;
/* new in API version 0x0000000D */
npy_intp *core_dim_sizes;
- npy_intp *core_dim_flags;
-
+ npy_uint32 *core_dim_flags;
+ PyObject *identity_value;
} PyUFuncObject;
.. c:macro: PyObject_HEAD
@@ -956,7 +956,8 @@ PyUFunc_Type and PyUFuncObject
.. c:member:: npy_intp *core_dim_sizes
For each distinct core dimension, the possible
- :ref:`frozen <frozen>` size if :c:data:`UFUNC_CORE_DIM_SIZE_INFERRED` is 0
+ :ref:`frozen <frozen>` size if
+ :c:data:`UFUNC_CORE_DIM_SIZE_INFERRED` is ``0``
.. c:member:: npy_uint32 *core_dim_flags
@@ -971,6 +972,11 @@ PyUFunc_Type and PyUFuncObject
if the dim size will be determined from the operands
and not from a :ref:`frozen <frozen>` signature
+ .. c:member:: PyObject *identity_value
+
+ Identity for reduction, when :c:member:`PyUFuncObject.identity`
+ is equal to :c:data:`PyUFunc_IdentityValue`.
+
PyArrayIter_Type and PyArrayIterObject
--------------------------------------