summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark Wiebe <mwiebe@enthought.com>2011-07-19 17:06:08 -0500
committerCharles Harris <charlesr.harris@gmail.com>2011-08-27 07:26:45 -0600
commit263df0ccb21e7ccb53ea3b6654387eb85feec932 (patch)
treead6983581476cf2f71de1b6c2fc729dcde778cad /doc
parentaa55ba7437fbe6b8772a360a641b5aa7d3e669e0 (diff)
downloadnumpy-263df0ccb21e7ccb53ea3b6654387eb85feec932.tar.gz
ENH: missingdata: Add the NA mask members to PyArrayObject
Diffstat (limited to 'doc')
-rw-r--r--doc/neps/missing-data.rst17
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/neps/missing-data.rst b/doc/neps/missing-data.rst
index f983d0ce3..6aedbadc7 100644
--- a/doc/neps/missing-data.rst
+++ b/doc/neps/missing-data.rst
@@ -837,9 +837,22 @@ This gives us the following additions to the PyArrayObject::
*/
npy_intp *maskna_strides;
-There are 2 (or 3) flags which must be added to the array flags::
+These fields can be accessed through the inline functions::
+
+ PyArray_Descr *
+ PyArray_MASKNA_DESCR(PyArrayObject *arr);
+
+ npy_mask *
+ PyArray_MASKNA_DATA(PyArrayObject *arr);
+
+ npy_intp *
+ PyArray_MASKNA_STRIDES(PyArrayObject *arr);
+
+ npy_bool
+ PyArray_HASMASKNA(PyArrayObject *arr);
+
+There are 1 or 2 flags which must be added to the array flags::
- NPY_ARRAY_HASMASKNA
NPY_ARRAY_OWNMASKNA
/* To possibly add in a later revision */
NPY_ARRAY_HARDMASKNA