diff options
author | Pauli Virtanen <pav@iki.fi> | 2017-01-21 20:09:34 +0100 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2017-01-21 20:09:34 +0100 |
commit | 734d5f6de64c882c2431a77f47651cc0df04e425 (patch) | |
tree | 742095e992ba74116d03ad1d55d7634876978ba9 /doc/source/reference/c-api.iterator.rst | |
parent | a67d1d24dc22ab9c634c08615deda48cc44b0591 (diff) | |
download | numpy-734d5f6de64c882c2431a77f47651cc0df04e425.tar.gz |
ENH: core: rename NPY_ITER_OVERLAP_ALLOW_SAME to NPY_ITER_OVERLAP_ASSUME_ELEMENTWISE
Make the flag name indicate more clearly on what is the precise
assumption made.
Diffstat (limited to 'doc/source/reference/c-api.iterator.rst')
-rw-r--r-- | doc/source/reference/c-api.iterator.rst | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/doc/source/reference/c-api.iterator.rst b/doc/source/reference/c-api.iterator.rst index 367dc15ef..679763067 100644 --- a/doc/source/reference/c-api.iterator.rst +++ b/doc/source/reference/c-api.iterator.rst @@ -608,17 +608,14 @@ Construction and Destruction returns true from the corresponding element in the ARRAYMASK operand. - .. c:var:: NPY_ITER_OVERLAP_ALLOW_SAME + .. c:var:: NPY_ITER_OVERLAP_ASSUME_ELEMENTWISE - In memory overlap checks, operands with ``NPY_ITER_OVERLAP_ALLOW_SAME`` - set are considered non-overlapping if they point to exactly the same array. - This means arrays with the same shape, dtype, strides, and start address. - In other cases, the default rules implied by - ``NPY_ITER_COPY_IF_OVERLAP`` apply. + In memory overlap checks, assume that operands with + ``NPY_ITER_OVERLAP_ASSUME_ELEMENTWISE`` enabled are accessed only + in the iterator order. - This flag can be enabled on the set of operands that are accessed - only in the iterator order, i.e. the operation is element-wise, - to avoid unnecessary copies. + This enables the iterator to reason about data dependency, + possibly avoiding unnecessary copies. This flag has effect only if ``NPY_ITER_COPY_IF_OVERLAP`` is enabled on the iterator. |