summaryrefslogtreecommitdiff
path: root/doc/source/reference/maskedarray.baseclass.rst
diff options
context:
space:
mode:
authormattip <matti.picus@gmail.com>2019-02-24 10:10:47 +0200
committermattip <matti.picus@gmail.com>2019-02-28 11:46:34 +0200
commit2f41bb26b061821c77aff6982630de937ad9007a (patch)
tree8e6f8988fd3cf08adbf99e72d2589b072cb8e9f2 /doc/source/reference/maskedarray.baseclass.rst
parent62433284d65a3629a199958da2df3a807c60fab4 (diff)
downloadnumpy-2f41bb26b061821c77aff6982630de937ad9007a.tar.gz
DOC: fixes from review
Diffstat (limited to 'doc/source/reference/maskedarray.baseclass.rst')
-rw-r--r--doc/source/reference/maskedarray.baseclass.rst90
1 files changed, 9 insertions, 81 deletions
diff --git a/doc/source/reference/maskedarray.baseclass.rst b/doc/source/reference/maskedarray.baseclass.rst
index 0b7482f2b..204ebfe08 100644
--- a/doc/source/reference/maskedarray.baseclass.rst
+++ b/doc/source/reference/maskedarray.baseclass.rst
@@ -49,11 +49,11 @@ The :class:`MaskedArray` class
.. class:: MaskedArray
- A subclass of :class:`~numpy.ndarray` designed to manipulate numerical arrays with missing data.
+A subclass of :class:`~numpy.ndarray` designed to manipulate numerical arrays with missing data.
- An instance of :class:`MaskedArray` can be thought as the combination of several elements:
+An instance of :class:`MaskedArray` can be thought as the combination of several elements:
* The :attr:`~MaskedArray.data`, as a regular :class:`numpy.ndarray` of any shape or datatype (the data).
* A boolean :attr:`~numpy.ma.MaskedArray.mask` with the same shape as the data, where a ``True`` value indicates that the corresponding element of the data is invalid.
@@ -69,91 +69,19 @@ Attributes and properties of masked arrays
.. seealso:: :ref:`Array Attributes <arrays.ndarray.attributes>`
+.. autoattribute:: MaskedArray.data
-.. _ma-data:
-.. attribute:: MaskedArray.data
+.. autoattribute:: MaskedArray.mask
- Returns the underlying data, as a view of the masked array.
- If the underlying data is a subclass of :class:`numpy.ndarray`, it is
- returned as such.
+.. autoattribute:: MaskedArray.recordmask
- >>> x = ma.array(np.matrix([[1, 2], [3, 4]]), mask=[[0, 1], [1, 0]])
- >>> x.data
- matrix([[1, 2],
- [3, 4]])
+.. autoattribute:: MaskedArray.fill_value
- The type of the data can be accessed through the :attr:`baseclass`
- attribute.
+.. autoattribute:: MaskedArray.baseclass
-.. _ma-mask:
-
-.. attribute:: MaskedArray.mask
-
- Returns the underlying mask, as an array with the same shape and structure
- as the data, but where all fields are atomically booleans.
- A value of ``True`` indicates an invalid entry.
-
-
-.. _ma-recordmask:
-
-.. attribute:: MaskedArray.recordmask
-
- Returns the mask of the array if it has no named fields. For structured
- arrays, returns a ndarray of booleans where entries are ``True`` if **all**
- the fields are masked, ``False`` otherwise::
-
- >>> x = ma.array([(1, 1), (2, 2), (3, 3), (4, 4), (5, 5)],
- ... mask=[(0, 0), (1, 0), (1, 1), (0, 1), (0, 0)],
- ... dtype=[('a', int), ('b', int)])
- >>> x.recordmask
- array([False, False, True, False, False])
-
-
-.. _ma-fillvalue:
-
-.. attribute:: MaskedArray.fill_value
-
- Returns the value used to fill the invalid entries of a masked array.
- The value is either a scalar (if the masked array has no named fields),
- or a 0-D ndarray with the same :attr:`dtype` as the masked array if it has
- named fields.
-
- The default filling value depends on the datatype of the array:
-
- ======== ========
- datatype default
- ======== ========
- bool True
- int 999999
- float 1.e20
- complex 1.e20+0j
- object '?'
- string 'N/A'
- ======== ========
-
-
-
-.. attribute:: MaskedArray.baseclass
-
- Returns the class of the underlying data.
-
- >>> x = ma.array(np.matrix([[1, 2], [3, 4]]), mask=[[0, 0], [1, 0]])
- >>> x.baseclass
- <class 'numpy.matrixlib.defmatrix.matrix'>
-
-
-.. attribute:: MaskedArray.sharedmask
-
- Returns whether the mask of the array is shared between several masked arrays.
- If this is the case, any modification to the mask of one array will be
- propagated to the others.
-
-
-.. attribute:: MaskedArray.hardmask
-
- Returns whether the mask is hard (``True``) or soft (``False``).
- When the mask is hard, masked entries cannot be unmasked.
+.. autoattribute:: MaskedArray.sharedmask
+.. autoattribute:: MaskedArray.hardmask
As :class:`MaskedArray` is a subclass of :class:`~numpy.ndarray`, a masked array also inherits all the attributes and properties of a :class:`~numpy.ndarray` instance.