summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorMark Wiebe <mwwiebe@gmail.com>2011-01-25 23:23:30 -0800
committerMark Wiebe <mwwiebe@gmail.com>2011-01-27 21:40:13 -0800
commit3e58b8db5d2ff4b850f63373e1b1d1c812454264 (patch)
tree0bc2e781e86c9b847ad9eafd7fe3dd9a2dc45d0b /numpy/add_newdocs.py
parent0a011429b13d7267a87e1cbc8c5b8fe42c22df5d (diff)
downloadnumpy-3e58b8db5d2ff4b850f63373e1b1d1c812454264.tar.gz
ENH: core: Make NumPy trunk ABI-compatible with 1.5
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py13
1 files changed, 12 insertions, 1 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index 854338a9c..9bd714a8a 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -1514,11 +1514,22 @@ add_newdoc('numpy.core', 'einsum',
If provided, the calculation is done into this array.
dtype : None or data type
If provided, forces the calculation to use the data type specified.
+ Note that you may have to also give a more liberal ``casting``
+ parameter to allow the conversions.
order : 'C', 'F', 'A', or 'K'
- Controls the memory layout of the output.
+ Controls the memory layout of the output. 'C' means it should
+ be Fortran contiguous. 'F' means it should be Fortran contiguous,
+ 'A' means it should be 'F' if the inputs are all 'F', 'C' otherwise.
+ 'K' means it should be as close to the layout as the inputs as
+ is possible, including arbitrarily permuted axes.
casting : 'no', 'equiv', 'safe', 'same_kind', 'unsafe'
Controls what kind of data casting may occur. Setting this to
'unsafe' is not recommended, as it can adversely affect accumulations.
+ '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
-------