diff options
| author | Mark Wiebe <mwwiebe@gmail.com> | 2011-04-13 15:04:17 -0700 |
|---|---|---|
| committer | Mark Wiebe <mwwiebe@gmail.com> | 2011-04-22 14:04:33 -0700 |
| commit | 58b77b2268c36c4617fb7f1f4b1227eb347d2d5b (patch) | |
| tree | 82480d89e849949f4da1e8abc4ad9190f177eeff /numpy/add_newdocs.py | |
| parent | d97a5e37b2085db9558ff64716e29e6cbf791a4c (diff) | |
| download | numpy-58b77b2268c36c4617fb7f1f4b1227eb347d2d5b.tar.gz | |
DOC: Document the new keyword arguments for ufuncs
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index a2925eeba..37f326867 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -1552,8 +1552,15 @@ add_newdoc('numpy.core.multiarray', 'can_cast', Data type, scalar, or array to cast from. totype : dtype or dtype specifier Data type to cast to. - casting : casting rule - May be any of 'no', 'equiv', 'safe', 'same_kind', or 'unsafe'. + casting : {'no', 'equiv', 'safe', 'same_kind', 'unsafe'}, optional + Controls what kind of data casting may occur. + + * 'no' means the data types should not be cast at all. + * 'equiv' means only byte-order changes are allowed. + * 'safe' means only casts which can preserve values are allowed. + * 'same_kind' means only safe casts or casts within a kind, + like float64 to float32, are allowed. + * 'unsafe' means any data conversions may be done. Returns ------- |