Note: using in-place operations on NumPy arrays that share memory in no longer a problem in version 1.13.0 onward (see details here). The two operation will produce the same result. This answer only applies to earlier versions of NumPy.
Mutating arrays while they’re being used in computations can lead to unexpected results!
In the example in the question, subtraction with -=
modifies the second element of a
and then immediately uses that modified second element in the operation on the third element of a
.
Here is what happens with a[1:] -= a[:-1]
step by step:
-
a
is the array with the data[1, 2, 3]
. -
We have two views onto this data:
a[1:]
is[2, 3]
, anda[:-1]
is[1, 2]
. -
The in-place subtraction
-=
begins. The first element ofa[:-1]
, 1, is subtracted from the first element ofa[1:]
. This has modifieda
to be[1, 1, 3]
. Now we have thata[1:]
is a view of the data[1, 3]
, anda[:-1]
is a view of the data[1, 1]
(the second element of arraya
has been changed). -
a[:-1]
is now[1, 1]
and NumPy must now subtract its second element which is 1 (not 2 anymore!) from the second element ofa[1:]
. This makesa[1:]
a view of the values[1, 2]
. -
a
is now an array with the values[1, 1, 2]
.
b[1:] = b[1:] - b[:-1]
does not have this problem because b[1:] - b[:-1]
creates a new array first and then assigns the values in this array to b[1:]
. It does not modify b
itself during the subtraction, so the views b[1:]
and b[:-1]
do not change.
The general advice is to avoid modifying one view inplace with another if they overlap. This includes the operators -=
, *=
, etc. and using the out
parameter in universal functions (like np.subtract
and np.multiply
) to write back to one of the arrays.