diff options
| author | Johannes Schönberger <hannesschoenberger@gmail.com> | 2013-01-01 10:13:03 +0100 |
|---|---|---|
| committer | Johannes Schönberger <jschoenberger@demuc.de> | 2013-06-06 21:15:14 +0200 |
| commit | 0fe4df2726d76b2093aa5d26f0ca839ef47c3770 (patch) | |
| tree | 0b3707d3f8456b41e43d4d6915f8bdf03d5ad7b7 /numpy/core/numeric.py | |
| parent | 6c5ef3406baf4e91fb0adfce053d2368bc09566b (diff) | |
| download | numpy-0fe4df2726d76b2093aa5d26f0ca839ef47c3770.tar.gz | |
Add short note in doc string about dtype for non-numbers
Diffstat (limited to 'numpy/core/numeric.py')
| -rw-r--r-- | numpy/core/numeric.py | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py index 09797b990..5a38e5872 100644 --- a/numpy/core/numeric.py +++ b/numpy/core/numeric.py @@ -235,6 +235,9 @@ def nans(shape, dtype=None, order='C'): """ Return a new array of given shape and type, filled with nans. + Note that only floating point numbers can represent non-numers as defined + in IEEE 754-1985. + Please refer to the documentation for `zeros` for further details. See Also @@ -260,6 +263,9 @@ def nans_like(a, dtype=None, order='K', subok=True): """ Return an array of nans with the same shape and type as a given array. + Note that only floating point numbers can represent non-numers as defined + in IEEE 754-1985. + With default parameters, is equivalent to ``a.copy().fill(np.nan)``. Parameters @@ -303,6 +309,9 @@ def infs(shape, dtype=None, order='C'): """ Return a new array of given shape and type, filled with infs. + Note that only floating point numbers can represent non-numers as defined + in IEEE 754-1985. + Please refer to the documentation for `zeros` for further details. See Also @@ -328,6 +337,9 @@ def infs_like(a, dtype=None, order='K', subok=True): """ Return an array of infs with the same shape and type as a given array. + Note that only floating point numbers can represent non-numers as defined + in IEEE 754-1985. + With default parameters, is equivalent to ``a.copy().fill(np.inf)``. Parameters |