PythonObject |= Thing -- augmented bitwise disjunction of Python objects

Operator: |=
Usage:

x |= y
Inputs:
- x, a python object,
- y, a thing,
Outputs:
- a python object, bitwise disjunction of x and y, assigned to x;

Description

Perform the bitwise disjunction ("or") operation on Python objects, and assign the result to the first argument.

i1 : x = toPython 6

o1 = 6

o1 : PythonObject of class int

i2 : x |= toPython 3

o2 = 7

o2 : PythonObject of class int

i3 : x

o3 = 7

o3 : PythonObject of class int

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

i4 : x = toPython 14

o4 = 14

o4 : PythonObject of class int

i5 : x |= 7

o5 = 15

o5 : PythonObject of class int

i6 : x

o6 = 15

o6 : PythonObject of class int

If the Python class of x defines an __ior__ method for in-place or, then it will be called. Otherwise, x will or'ed with y in the usual way, creating a new Python object that is assigned back to x.

For example, NumPy arrays support in-place or. In the example below, x is modified directly, and no new object is created.

i7 : installNumPyMethods();

i8 : x = toPython matrix {{1, 2}, {3, 4}}

o8 = [[1 2]
      [3 4]]

o8 : PythonObject of class numpy.ndarray

i9 : x |= 2

o9 = [[3 2]
      [3 6]]

o9 : PythonObject of class numpy.ndarray

i10 : x

o10 = [[3 2]
       [3 6]]

o10 : PythonObject of class numpy.ndarray

Ways to use this method:

PythonObject |= Thing -- augmented bitwise disjunction of Python objects

The source of this document is in Python/doc/bitwise.m2:394:0.

PythonObject |= Thing -- augmented bitwise disjunction of Python objects

Description

See also

Ways to use this method: