diff options
| author | Marten van Kerkwijk <mhvk@astro.utoronto.ca> | 2017-11-30 20:49:27 -0500 |
|---|---|---|
| committer | Marten van Kerkwijk <mhvk@astro.utoronto.ca> | 2018-04-25 11:13:21 -0400 |
| commit | b6e8a13b6fecf4938e169f528c46b601dbf02a01 (patch) | |
| tree | 40cd7e75265fc40ba82a3598020c302aedb2dd5b /doc/source/reference | |
| parent | d7d5cb3feccc1fc6cf57159e8b9fe0a733968706 (diff) | |
| download | numpy-b6e8a13b6fecf4938e169f528c46b601dbf02a01.tar.gz | |
DOC: advise against use of matrix.
Diffstat (limited to 'doc/source/reference')
| -rw-r--r-- | doc/source/reference/arrays.classes.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/reference/arrays.classes.rst b/doc/source/reference/arrays.classes.rst index 2719f9239..f17cb932a 100644 --- a/doc/source/reference/arrays.classes.rst +++ b/doc/source/reference/arrays.classes.rst @@ -215,6 +215,13 @@ Matrix objects .. index:: single: matrix +.. note:: + It is strongly advised *not* to use the matrix subclass. As described + below, it makes writing functions that deal consistently with matrices + and regular arrays very difficult. Currently, they are mainly used for + interacting with ``scipy.sparse``. We hope to provide an alternative + for this use, however, and eventually remove the ``matrix`` subclass. + :class:`matrix` objects inherit from the ndarray and therefore, they have the same attributes and methods of ndarrays. There are six important differences of matrix objects, however, that may lead to |