Skip to content

Commit 41c107d

Browse files
committed
Remove PyArray_MultiIter_SIZE definition. Tentative definition for PyArray_FinalizeFunc.
1 parent 51d6900 commit 41c107d

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

doc/source/reference/c-api/array.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,16 @@ and its sub-types).
151151
152152
`numpy.ndarray.item` is identical to PyArray_GETITEM.
153153
154+
.. c:function:: int PyArray_FinalizeFunc(PyArrayObject* arr, PyObject* obj)
155+
156+
The function pointed to by the CObject
157+
:obj:`~numpy.class.__array_finalize__`.
158+
The first argument is the newly created sub-type. The second argument
159+
(if not NULL) is the "parent" array (if the array was created using
160+
slicing or some other operation where a clearly-distinguishable parent
161+
is present). This routine can do anything it wants to. It should
162+
return a -1 on error and 0 otherwise.
163+
154164
155165
Data access
156166
^^^^^^^^^^^
@@ -2562,10 +2572,6 @@ Broadcasting (multi-iterators)
25622572
through all of the elements (of the broadcasted result), otherwise
25632573
it evaluates FALSE.
25642574
2565-
.. c:function:: int PyArray_MultiIter_SIZE(PyObject* multi)
2566-
2567-
Returns the size of the multi-iterator object.
2568-
25692575
.. c:function:: int PyArray_Broadcast(PyArrayMultiIterObject* mit)
25702576
25712577
This function encapsulates the broadcasting rules. The *mit*

doc/source/user/c-info.beyond-basics.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -472,8 +472,8 @@ The __array_finalize\__ method
472472
members are filled in. Finally, the :obj:`~numpy.class.__array_finalize__`
473473
attribute is looked-up in the object dictionary. If it is present
474474
and not None, then it can be either a CObject containing a pointer
475-
to a ``PyArray_FinalizeFunc`` or it can be a method taking a
476-
single argument (which could be None).
475+
to a :c:func:`PyArray_FinalizeFunc` or it can be a method taking a
476+
single argument (which could be None)
477477
478478
If the :obj:`~numpy.class.__array_finalize__` attribute is a CObject, then the pointer
479479
must be a pointer to a function with the signature:

numpy/core/include/numpy/ndarraytypes.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1308,9 +1308,6 @@ typedef struct {
13081308
#define PyArray_MultiIter_NOTDONE(multi) \
13091309
(_PyMIT(multi)->index < _PyMIT(multi)->size)
13101310

1311-
#define PyArray_MultiIter_SIZE(multi) \
1312-
_PyMIT(multi)->size
1313-
13141311
/*
13151312
* Store the information needed for fancy-indexing over an array. The
13161313
* fields are slightly unordered to keep consec, dataptr and subspace

0 commit comments

Comments
 (0)