Skip to content

Commit

Permalink
Merge pull request numpy#3106 from seberg/remove-maskNA-nditer-doc
Browse files Browse the repository at this point in the history
DOC: Remove documentation of non-existing advanced iter NA flags.
  • Loading branch information
njsmith committed Mar 1, 2013
2 parents d12dad4 + 398b076 commit 2b71ffb
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions doc/source/reference/c-api.iterator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -629,35 +629,6 @@ Construction and Destruction
returns true from the corresponding element in the ARRAYMASK
operand.

.. cvar:: NPY_ITER_USE_MASKNA

.. versionadded:: 1.7

Adds a new operand to the end of the operand list which
iterates over the mask of this operand. If this operand has
no mask and is read-only, it broadcasts a constant
one-valued mask to indicate every value is valid. If this
operand has no mask and is writeable, an error is raised.

Each operand which has this flag applied to it causes
an additional operand to be tacked on the end of the operand
list, in an order matching that of the operand array.
For example, if there are four operands, and operands with index
one and three have the flag :cdata:`NPY_ITER_USE_MASKNA`
specified, there will be six operands total, and they will
look like [op0, op1, op2, op3, op1_mask, op3_mask].

.. cvar:: NPY_ITER_IGNORE_MASKNA

.. versionadded:: 1.7

Under some circumstances, code doing an iteration will
have already called :cfunc:`PyArray_ContainsNA` on an
operand which has a mask, and seen that its return value
was false. When this occurs, it is safe to do the iteration
without simultaneously iterating over the mask, and this
flag allows that to be done.

.. cfunction:: NpyIter* NpyIter_AdvancedNew(npy_intp nop, PyArrayObject** op, npy_uint32 flags, NPY_ORDER order, NPY_CASTING casting, npy_uint32* op_flags, PyArray_Descr** op_dtypes, int oa_ndim, int** op_axes, npy_intp* itershape, npy_intp buffersize)

Extends :cfunc:`NpyIter_MultiNew` with several advanced options providing
Expand Down

0 comments on commit 2b71ffb

Please sign in to comment.