summaryrefslogtreecommitdiff
path: root/doc/source/reference
diff options
context:
space:
mode:
authorChiara Marmo <chiara.marmo@inria.fr>2021-07-27 18:47:13 +0200
committerChiara Marmo <chiara.marmo@inria.fr>2021-07-27 18:47:13 +0200
commit41c107dabf740527a4ee18adedd3b750059a4de0 (patch)
tree621946e0c457eaf2641540f5942d3c90a675fb2a /doc/source/reference
parent51d69005c6611c245aae51dc987bab83d5cded48 (diff)
downloadnumpy-41c107dabf740527a4ee18adedd3b750059a4de0.tar.gz
Remove PyArray_MultiIter_SIZE definition. Tentative definition for PyArray_FinalizeFunc.
Diffstat (limited to 'doc/source/reference')
-rw-r--r--doc/source/reference/c-api/array.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst
index c7a2576c0..909f9ec53 100644
--- a/doc/source/reference/c-api/array.rst
+++ b/doc/source/reference/c-api/array.rst
@@ -151,6 +151,16 @@ and its sub-types).
`numpy.ndarray.item` is identical to PyArray_GETITEM.
+.. c:function:: int PyArray_FinalizeFunc(PyArrayObject* arr, PyObject* obj)
+
+ The function pointed to by the CObject
+ :obj:`~numpy.class.__array_finalize__`.
+ The first argument is the newly created sub-type. The second argument
+ (if not NULL) is the "parent" array (if the array was created using
+ slicing or some other operation where a clearly-distinguishable parent
+ is present). This routine can do anything it wants to. It should
+ return a -1 on error and 0 otherwise.
+
Data access
^^^^^^^^^^^
@@ -2562,10 +2572,6 @@ Broadcasting (multi-iterators)
through all of the elements (of the broadcasted result), otherwise
it evaluates FALSE.
-.. c:function:: int PyArray_MultiIter_SIZE(PyObject* multi)
-
- Returns the size of the multi-iterator object.
-
.. c:function:: int PyArray_Broadcast(PyArrayMultiIterObject* mit)
This function encapsulates the broadcasting rules. The *mit*