PythonObject += Thing -- augmented addition of Python objects

Operator: +=
Usage:

x += y
Inputs:
- x, a python object,
- y, a thing,
Outputs:
- a python object, the sum of x and y, assigned to x;

Description

Add two Python objects and assign the result to the first argument.

i1 : x = toPython 2

o1 = 2

o1 : PythonObject of class int

i2 : x += toPython 3

o2 = 5

o2 : PythonObject of class int

i3 : x

o3 = 5

o3 : PythonObject of class int

If the right-hand side is a Macaulay2 object, then it is first converted to a Python object before adding.

i4 : x = toPython 4

o4 = 4

o4 : PythonObject of class int

i5 : x += 5

o5 = 9

o5 : PythonObject of class int

i6 : x

o6 = 9

o6 : PythonObject of class int

If the Python class of x defines an __iadd__ method for in-place addition, then it will be called. Otherwise, x and y will be added in the usual way, creating a new Python object that is assigned back to x.

For example, Python lists support in-place addition. In the example below, x is modified directly, and no new object is created.

i7 : x = toPython {1, 2, 3}

o7 = [1, 2, 3]

o7 : PythonObject of class list

i8 : x += {4}

o8 = [1, 2, 3, 4]

o8 : PythonObject of class list

i9 : x

o9 = [1, 2, 3, 4]

o9 : PythonObject of class list

Ways to use this method:

PythonObject += Thing -- augmented addition of Python objects

The source of this document is in Python/doc/arithmetic.m2:83:0.

PythonObject += Thing -- augmented addition of Python objects

Description

See also

Ways to use this method: