diff options
| -rw-r--r-- | doc/release/2.0.0-notes.rst | 5 | ||||
| -rw-r--r-- | doc/source/reference/arrays.maskna.rst | 5 | ||||
| -rw-r--r-- | numpy/add_newdocs.py | 11 |
3 files changed, 21 insertions, 0 deletions
diff --git a/doc/release/2.0.0-notes.rst b/doc/release/2.0.0-notes.rst index 7c2bfa8a5..eec2b7933 100644 --- a/doc/release/2.0.0-notes.rst +++ b/doc/release/2.0.0-notes.rst @@ -18,6 +18,11 @@ Preliminary support for NA missing values similar to those in R has been implemented. This was done by adding optional NA masks to the core array object. +.. note:: The NA API is *experimental*, and may undergo changes in future + versions of NumPy. The current implementation based on masks will likely be + supplemented by a second one based on bit-patterns, and it is possible that + a difference will be made between missing and ignored data. + While a significant amount of the NumPy functionality has been extended to support NA masks, not everything is yet supported. Here is an (incomplete) list of things that do and do not work with NA values: diff --git a/doc/source/reference/arrays.maskna.rst b/doc/source/reference/arrays.maskna.rst index 2faabde83..bd9516eba 100644 --- a/doc/source/reference/arrays.maskna.rst +++ b/doc/source/reference/arrays.maskna.rst @@ -14,6 +14,11 @@ core ndarray. This system is highly flexible, allowing NAs to be used with any underlying dtype, and supports creating multiple views of the same data with different choices of NAs. +.. note:: The NA API is *experimental*, and may undergo changes in future + versions of NumPy. The current implementation based on masks will likely be + supplemented by a second one based on bit-patterns, and it is possible that + a difference will be made between missing and ignored data. + Other Missing Data Approaches ============================= diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index dd48191b6..6b7d98c4d 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -685,11 +685,17 @@ add_newdoc('numpy.core.multiarray', 'array', If this is set to False, it forces the array to not have an NA mask. If the input is an array with a mask, and has no NA values, it will create a copy of the input without an NA mask. + + .. versionadded:: 1.7.0 + ownmaskna : bool, optional If this is set to True, forces the array to have a mask which it owns. It may still return a view of the data from the input, but the result will always own its own mask. + .. versionadded:: 1.7.0 + + Returns ------- out : ndarray @@ -699,6 +705,11 @@ add_newdoc('numpy.core.multiarray', 'array', -------- empty, empty_like, zeros, zeros_like, ones, ones_like, fill + Notes + ----- + The `maskna` and `ownmaskna` keywords are *experimental* in the 1.7 + release; their behavior may change in future versions. + Examples -------- >>> np.array([1, 2, 3]) |