Skip to content

arithmetic

Arithmetic operations for symbolic expressions.

This module provides fundamental arithmetic operations that form the building blocks of symbolic expressions in openscvx. These operations are created automatically through operator overloading on Expr objects.

Arithmetic Operations:

  • Binary operations: Add, Sub, Mul, Div, MatMul, Power - Standard arithmetic
  • Unary operations: Neg - Negation (unary minus)

All arithmetic operations support: - Automatic canonicalization (constant folding, identity elimination, flattening) - Broadcasting following NumPy rules (except MatMul which follows linear algebra rules) - Shape checking and validation

Example

Arithmetic operations are created via operator overloading::

import openscvx as ox

x = ox.State("x", shape=(3,))
y = ox.State("y", shape=(3,))

# Element-wise operations
z = x + y           # Creates Add(x, y)
w = x * 2           # Creates Mul(x, Constant(2))
neg_x = -x          # Creates Neg(x)

# Matrix multiplication
A = ox.State("A", shape=(3, 3))
b = A @ x           # Creates MatMul(A, x)

Add

Bases: Expr

Addition operation for symbolic expressions.

Represents element-wise addition of two or more expressions. Supports broadcasting following NumPy rules. Can be created using the + operator on Expr objects.

Attributes:

Name Type Description
terms

List of expression operands to add together
Example

Define an Add expression:

x = ox.State("x", shape=(3,))
y = ox.State("y", shape=(3,))
z = x + y + 5  # Creates Add(x, y, Constant(5))
Source code in openscvx/symbolic/expr/arithmetic.py 
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
class Add(Expr):
    """Addition operation for symbolic expressions.

    Represents element-wise addition of two or more expressions. Supports broadcasting
    following NumPy rules. Can be created using the + operator on Expr objects.

    Attributes:
        terms: List of expression operands to add together

    Example:
        Define an Add expression:

            x = ox.State("x", shape=(3,))
            y = ox.State("y", shape=(3,))
            z = x + y + 5  # Creates Add(x, y, Constant(5))
    """

    def __init__(self, *args):
        """Initialize an addition operation.

        Args:
            *args: Two or more expressions to add together

        Raises:
            ValueError: If fewer than two operands are provided
        """
        if len(args) < 2:
            raise ValueError("Add requires two or more operands")
        self.terms = [to_expr(a) for a in args]

    def children(self):
        return list(self.terms)

    def canonicalize(self) -> "Expr":
        """Canonicalize addition: flatten, fold constants, and eliminate zeros.

        Returns:
            Expr: Canonical form of the addition expression
        """
        terms = []
        const_vals = []

        for t in self.terms:
            c = t.canonicalize()
            if isinstance(c, Add):
                terms.extend(c.terms)
            elif isinstance(c, Constant):
                const_vals.append(c.value)
            else:
                terms.append(c)

        if const_vals:
            total = sum(const_vals)
            # If not all-zero, keep it
            if not (isinstance(total, np.ndarray) and np.all(total == 0)):
                terms.append(Constant(total))

        if not terms:
            return Constant(np.array(0))
        if len(terms) == 1:
            return terms[0]
        return Add(*terms)

    def check_shape(self) -> Tuple[int, ...]:
        """Check shape compatibility and compute broadcasted result shape like NumPy.

        Returns:
            tuple: The broadcasted shape of all operands

        Raises:
            ValueError: If operand shapes are not broadcastable
        """
        shapes = [child.check_shape() for child in self.children()]
        try:
            return np.broadcast_shapes(*shapes)
        except ValueError as e:
            raise ValueError(f"Add shapes not broadcastable: {shapes}") from e

    def __repr__(self):
        inner = " + ".join(repr(e) for e in self.terms)
        return f"({inner})"
canonicalize() -> Expr

Canonicalize addition: flatten, fold constants, and eliminate zeros.

Returns:

Name Type Description
Expr Expr

Canonical form of the addition expression
Source code in openscvx/symbolic/expr/arithmetic.py 
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def canonicalize(self) -> "Expr":
    """Canonicalize addition: flatten, fold constants, and eliminate zeros.

    Returns:
        Expr: Canonical form of the addition expression
    """
    terms = []
    const_vals = []

    for t in self.terms:
        c = t.canonicalize()
        if isinstance(c, Add):
            terms.extend(c.terms)
        elif isinstance(c, Constant):
            const_vals.append(c.value)
        else:
            terms.append(c)

    if const_vals:
        total = sum(const_vals)
        # If not all-zero, keep it
        if not (isinstance(total, np.ndarray) and np.all(total == 0)):
            terms.append(Constant(total))

    if not terms:
        return Constant(np.array(0))
    if len(terms) == 1:
        return terms[0]
    return Add(*terms)
check_shape() -> Tuple[int, ...]

Check shape compatibility and compute broadcasted result shape like NumPy.

Returns:

Name Type Description
tuple Tuple[int, ...]

The broadcasted shape of all operands

Raises:

Type Description
ValueError

If operand shapes are not broadcastable
Source code in openscvx/symbolic/expr/arithmetic.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def check_shape(self) -> Tuple[int, ...]:
    """Check shape compatibility and compute broadcasted result shape like NumPy.

    Returns:
        tuple: The broadcasted shape of all operands

    Raises:
        ValueError: If operand shapes are not broadcastable
    """
    shapes = [child.check_shape() for child in self.children()]
    try:
        return np.broadcast_shapes(*shapes)
    except ValueError as e:
        raise ValueError(f"Add shapes not broadcastable: {shapes}") from e

Div

Bases: Expr

Element-wise division operation for symbolic expressions.

Represents element-wise division (left / right). Supports broadcasting following NumPy rules. Can be created using the / operator on Expr objects.

Attributes:

Name Type Description
left

Numerator expression
right

Denominator expression
Example

Define a Div expression

x = ox.State("x", shape=(3,))
y = ox.State("y", shape=(3,))
z = x / y  # Creates Div(x, y)
Source code in openscvx/symbolic/expr/arithmetic.py 
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
class Div(Expr):
    """Element-wise division operation for symbolic expressions.

    Represents element-wise division (left / right). Supports broadcasting
    following NumPy rules. Can be created using the / operator on Expr objects.

    Attributes:
        left: Numerator expression
        right: Denominator expression

    Example:
        Define a Div expression

            x = ox.State("x", shape=(3,))
            y = ox.State("y", shape=(3,))
            z = x / y  # Creates Div(x, y)
    """

    def __init__(self, left, right):
        """Initialize a division operation.

        Args:
            left: Expression for the numerator
            right: Expression for the denominator
        """
        self.left = left
        self.right = right

    def children(self):
        return [self.left, self.right]

    def canonicalize(self) -> "Expr":
        """Canonicalize division: fold constants if both sides are constants.

        Returns:
            Expr: Canonical form of the division expression
        """
        lhs = self.left.canonicalize()
        rhs = self.right.canonicalize()
        if isinstance(lhs, Constant) and isinstance(rhs, Constant):
            return Constant(lhs.value / rhs.value)
        return Div(lhs, rhs)

    def check_shape(self) -> Tuple[int, ...]:
        """Check shape compatibility and compute broadcasted result shape like NumPy.

        Returns:
            tuple: The broadcasted shape of both operands

        Raises:
            ValueError: If operand shapes are not broadcastable
        """
        shapes = [child.check_shape() for child in self.children()]
        try:
            return np.broadcast_shapes(*shapes)
        except ValueError as e:
            raise ValueError(f"Div shapes not broadcastable: {shapes}") from e

    def __repr__(self):
        return f"({self.left!r} / {self.right!r})"
canonicalize() -> Expr

Canonicalize division: fold constants if both sides are constants.

Returns:

Name Type Description
Expr Expr

Canonical form of the division expression
Source code in openscvx/symbolic/expr/arithmetic.py 
314
315
316
317
318
319
320
321
322
323
324
def canonicalize(self) -> "Expr":
    """Canonicalize division: fold constants if both sides are constants.

    Returns:
        Expr: Canonical form of the division expression
    """
    lhs = self.left.canonicalize()
    rhs = self.right.canonicalize()
    if isinstance(lhs, Constant) and isinstance(rhs, Constant):
        return Constant(lhs.value / rhs.value)
    return Div(lhs, rhs)
check_shape() -> Tuple[int, ...]

Check shape compatibility and compute broadcasted result shape like NumPy.

Returns:

Name Type Description
tuple Tuple[int, ...]

The broadcasted shape of both operands

Raises:

Type Description
ValueError

If operand shapes are not broadcastable
Source code in openscvx/symbolic/expr/arithmetic.py 
326
327
328
329
330
331
332
333
334
335
336
337
338
339
def check_shape(self) -> Tuple[int, ...]:
    """Check shape compatibility and compute broadcasted result shape like NumPy.

    Returns:
        tuple: The broadcasted shape of both operands

    Raises:
        ValueError: If operand shapes are not broadcastable
    """
    shapes = [child.check_shape() for child in self.children()]
    try:
        return np.broadcast_shapes(*shapes)
    except ValueError as e:
        raise ValueError(f"Div shapes not broadcastable: {shapes}") from e

MatMul

Bases: Expr

Matrix multiplication operation for symbolic expressions.

Represents matrix multiplication following standard linear algebra rules. Can be created using the @ operator on Expr objects. Handles: - Matrix @ Matrix: (m,n) @ (n,k) -> (m,k) - Matrix @ Vector: (m,n) @ (n,) -> (m,) - Vector @ Matrix: (m,) @ (m,n) -> (n,) - Vector @ Vector: (m,) @ (m,) -> scalar

Attributes:

Name Type Description
left

Left-hand side expression
right

Right-hand side expression
Example

Define a MatMul expression:

A = ox.State("A", shape=(3, 4))
x = ox.State("x", shape=(4,))
y = A @ x  # Creates MatMul(A, x), result shape (3,)
Source code in openscvx/symbolic/expr/arithmetic.py 
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
class MatMul(Expr):
    """Matrix multiplication operation for symbolic expressions.

    Represents matrix multiplication following standard linear algebra rules.
    Can be created using the @ operator on Expr objects. Handles:
    - Matrix @ Matrix: (m,n) @ (n,k) -> (m,k)
    - Matrix @ Vector: (m,n) @ (n,) -> (m,)
    - Vector @ Matrix: (m,) @ (m,n) -> (n,)
    - Vector @ Vector: (m,) @ (m,) -> scalar

    Attributes:
        left: Left-hand side expression
        right: Right-hand side expression

    Example:
        Define a MatMul expression:

            A = ox.State("A", shape=(3, 4))
            x = ox.State("x", shape=(4,))
            y = A @ x  # Creates MatMul(A, x), result shape (3,)
    """

    def __init__(self, left, right):
        """Initialize a matrix multiplication operation.

        Args:
            left: Left-hand side expression for matrix multiplication
            right: Right-hand side expression for matrix multiplication
        """
        self.left = left
        self.right = right

    def children(self):
        return [self.left, self.right]

    def canonicalize(self) -> "Expr":
        left = self.left.canonicalize()
        right = self.right.canonicalize()
        return MatMul(left, right)

    def check_shape(self) -> Tuple[int, ...]:
        """Check matrix multiplication shape compatibility and return result shape."""
        L, R = self.left.check_shape(), self.right.check_shape()

        # Handle different matmul cases:
        # Matrix @ Matrix: (m,n) @ (n,k) -> (m,k)
        # Matrix @ Vector: (m,n) @ (n,) -> (m,)
        # Vector @ Matrix: (m,) @ (m,n) -> (n,)
        # Vector @ Vector: (m,) @ (m,) -> ()

        if len(L) == 0 or len(R) == 0:
            raise ValueError(f"MatMul requires at least 1D operands: {L} @ {R}")

        if len(L) == 1 and len(R) == 1:
            # Vector @ Vector -> scalar
            if L[0] != R[0]:
                raise ValueError(f"MatMul incompatible: {L} @ {R}")
            return ()
        elif len(L) == 1:
            # Vector @ Matrix: (m,) @ (m,n) -> (n,)
            if len(R) < 2 or L[0] != R[-2]:
                raise ValueError(f"MatMul incompatible: {L} @ {R}")
            return R[-1:]
        elif len(R) == 1:
            # Matrix @ Vector: (m,n) @ (n,) -> (m,)
            if len(L) < 2 or L[-1] != R[0]:
                raise ValueError(f"MatMul incompatible: {L} @ {R}")
            return L[:-1]
        else:
            # Matrix @ Matrix: (...,m,n) @ (...,n,k) -> (...,m,k)
            if len(L) < 2 or len(R) < 2 or L[-1] != R[-2]:
                raise ValueError(f"MatMul incompatible: {L} @ {R}")
            return L[:-1] + (R[-1],)

    def __repr__(self):
        return f"({self.left!r} * {self.right!r})"
check_shape() -> Tuple[int, ...]

Check matrix multiplication shape compatibility and return result shape.

Source code in openscvx/symbolic/expr/arithmetic.py 
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
def check_shape(self) -> Tuple[int, ...]:
    """Check matrix multiplication shape compatibility and return result shape."""
    L, R = self.left.check_shape(), self.right.check_shape()

    # Handle different matmul cases:
    # Matrix @ Matrix: (m,n) @ (n,k) -> (m,k)
    # Matrix @ Vector: (m,n) @ (n,) -> (m,)
    # Vector @ Matrix: (m,) @ (m,n) -> (n,)
    # Vector @ Vector: (m,) @ (m,) -> ()

    if len(L) == 0 or len(R) == 0:
        raise ValueError(f"MatMul requires at least 1D operands: {L} @ {R}")

    if len(L) == 1 and len(R) == 1:
        # Vector @ Vector -> scalar
        if L[0] != R[0]:
            raise ValueError(f"MatMul incompatible: {L} @ {R}")
        return ()
    elif len(L) == 1:
        # Vector @ Matrix: (m,) @ (m,n) -> (n,)
        if len(R) < 2 or L[0] != R[-2]:
            raise ValueError(f"MatMul incompatible: {L} @ {R}")
        return R[-1:]
    elif len(R) == 1:
        # Matrix @ Vector: (m,n) @ (n,) -> (m,)
        if len(L) < 2 or L[-1] != R[0]:
            raise ValueError(f"MatMul incompatible: {L} @ {R}")
        return L[:-1]
    else:
        # Matrix @ Matrix: (...,m,n) @ (...,n,k) -> (...,m,k)
        if len(L) < 2 or len(R) < 2 or L[-1] != R[-2]:
            raise ValueError(f"MatMul incompatible: {L} @ {R}")
        return L[:-1] + (R[-1],)

Mul

Bases: Expr

Element-wise multiplication operation for symbolic expressions.

Represents element-wise (Hadamard) multiplication of two or more expressions. Supports broadcasting following NumPy rules. Can be created using the * operator on Expr objects. For matrix multiplication, use MatMul or the @ operator.

Attributes:

Name Type Description
factors

List of expression operands to multiply together
Example

Define a Mul expression:

x = ox.State("x", shape=(3,))
y = ox.State("y", shape=(3,))
z = x * y * 2  # Creates Mul(x, y, Constant(2))
Source code in openscvx/symbolic/expr/arithmetic.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
class Mul(Expr):
    """Element-wise multiplication operation for symbolic expressions.

    Represents element-wise (Hadamard) multiplication of two or more expressions.
    Supports broadcasting following NumPy rules. Can be created using the * operator
    on Expr objects. For matrix multiplication, use MatMul or the @ operator.

    Attributes:
        factors: List of expression operands to multiply together

    Example:
        Define a Mul expression:

            x = ox.State("x", shape=(3,))
            y = ox.State("y", shape=(3,))
            z = x * y * 2  # Creates Mul(x, y, Constant(2))
    """

    def __init__(self, *args):
        """Initialize an element-wise multiplication operation.

        Args:
            *args: Two or more expressions to multiply together

        Raises:
            ValueError: If fewer than two operands are provided
        """
        if len(args) < 2:
            raise ValueError("Mul requires two or more operands")
        self.factors = [to_expr(a) for a in args]

    def children(self):
        return list(self.factors)

    def canonicalize(self) -> "Expr":
        """Canonicalize multiplication: flatten, fold constants, and eliminating ones.

        Returns:
            Expr: Canonical form of the multiplication expression
        """
        factors = []
        const_vals = []

        for f in self.factors:
            c = f.canonicalize()
            if isinstance(c, Mul):
                factors.extend(c.factors)
            elif isinstance(c, Constant):
                const_vals.append(c.value)
            else:
                factors.append(c)

        if const_vals:
            # Multiply constants element-wise (broadcasting), not reducing with prod
            prod = const_vals[0]
            for val in const_vals[1:]:
                prod = prod * val

            # If prod != 1, keep it
            # Check both scalar and array cases
            is_identity = False
            if isinstance(prod, np.ndarray):
                is_identity = np.all(prod == 1)
            else:
                is_identity = prod == 1

            if not is_identity:
                factors.append(Constant(prod))

        if not factors:
            return Constant(np.array(1))
        if len(factors) == 1:
            return factors[0]
        return Mul(*factors)

    def check_shape(self) -> Tuple[int, ...]:
        """Check shape compatibility and compute broadcasted result shape like NumPy.


        Returns:
            tuple: The broadcasted shape of all operands

        Raises:
            ValueError: If operand shapes are not broadcastable
        """
        shapes = [child.check_shape() for child in self.children()]
        try:
            return np.broadcast_shapes(*shapes)
        except ValueError as e:
            raise ValueError(f"Mul shapes not broadcastable: {shapes}") from e

    def __repr__(self):
        inner = " * ".join(repr(e) for e in self.factors)
        return f"({inner})"
canonicalize() -> Expr

Canonicalize multiplication: flatten, fold constants, and eliminating ones.

Returns:

Name Type Description
Expr Expr

Canonical form of the multiplication expression
Source code in openscvx/symbolic/expr/arithmetic.py 
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def canonicalize(self) -> "Expr":
    """Canonicalize multiplication: flatten, fold constants, and eliminating ones.

    Returns:
        Expr: Canonical form of the multiplication expression
    """
    factors = []
    const_vals = []

    for f in self.factors:
        c = f.canonicalize()
        if isinstance(c, Mul):
            factors.extend(c.factors)
        elif isinstance(c, Constant):
            const_vals.append(c.value)
        else:
            factors.append(c)

    if const_vals:
        # Multiply constants element-wise (broadcasting), not reducing with prod
        prod = const_vals[0]
        for val in const_vals[1:]:
            prod = prod * val

        # If prod != 1, keep it
        # Check both scalar and array cases
        is_identity = False
        if isinstance(prod, np.ndarray):
            is_identity = np.all(prod == 1)
        else:
            is_identity = prod == 1

        if not is_identity:
            factors.append(Constant(prod))

    if not factors:
        return Constant(np.array(1))
    if len(factors) == 1:
        return factors[0]
    return Mul(*factors)
check_shape() -> Tuple[int, ...]

Check shape compatibility and compute broadcasted result shape like NumPy.

Returns:

Name Type Description
tuple Tuple[int, ...]

The broadcasted shape of all operands

Raises:

Type Description
ValueError

If operand shapes are not broadcastable
Source code in openscvx/symbolic/expr/arithmetic.py 
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
def check_shape(self) -> Tuple[int, ...]:
    """Check shape compatibility and compute broadcasted result shape like NumPy.


    Returns:
        tuple: The broadcasted shape of all operands

    Raises:
        ValueError: If operand shapes are not broadcastable
    """
    shapes = [child.check_shape() for child in self.children()]
    try:
        return np.broadcast_shapes(*shapes)
    except ValueError as e:
        raise ValueError(f"Mul shapes not broadcastable: {shapes}") from e

Neg

Bases: Expr

Negation operation for symbolic expressions.

Represents element-wise negation (unary minus). Can be created using the unary - operator on Expr objects.

Attributes:

Name Type Description
operand

Expression to negate
Example

Define a Neg expression:

x = ox.State("x", shape=(3,))
y = -x  # Creates Neg(x)
Source code in openscvx/symbolic/expr/arithmetic.py 
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
class Neg(Expr):
    """Negation operation for symbolic expressions.

    Represents element-wise negation (unary minus). Can be created using the
    unary - operator on Expr objects.

    Attributes:
        operand: Expression to negate

    Example:
        Define a Neg expression:

            x = ox.State("x", shape=(3,))
            y = -x  # Creates Neg(x)
    """

    def __init__(self, operand):
        """Initialize a negation operation.

        Args:
            operand: Expression to negate
        """
        self.operand = operand

    def children(self):
        return [self.operand]

    def canonicalize(self) -> "Expr":
        """Canonicalize negation: fold constant negations.

        Returns:
            Expr: Canonical form of the negation expression
        """
        o = self.operand.canonicalize()
        if isinstance(o, Constant):
            return Constant(-o.value)
        return Neg(o)

    def check_shape(self) -> Tuple[int, ...]:
        """Negation preserves the shape of its operand."""
        return self.operand.check_shape()

    def __repr__(self):
        return f"(-{self.operand!r})"
canonicalize() -> Expr

Canonicalize negation: fold constant negations.

Returns:

Name Type Description
Expr Expr

Canonical form of the negation expression
Source code in openscvx/symbolic/expr/arithmetic.py 
450
451
452
453
454
455
456
457
458
459
def canonicalize(self) -> "Expr":
    """Canonicalize negation: fold constant negations.

    Returns:
        Expr: Canonical form of the negation expression
    """
    o = self.operand.canonicalize()
    if isinstance(o, Constant):
        return Constant(-o.value)
    return Neg(o)
check_shape() -> Tuple[int, ...]

Negation preserves the shape of its operand.

Source code in openscvx/symbolic/expr/arithmetic.py 
461
462
463
def check_shape(self) -> Tuple[int, ...]:
    """Negation preserves the shape of its operand."""
    return self.operand.check_shape()

Power

Bases: Expr

Element-wise power operation for symbolic expressions.

Represents element-wise exponentiation (base ** exponent). Supports broadcasting following NumPy rules. Can be created using the ** operator on Expr objects.

Attributes:

Name Type Description
base

Base expression
exponent

Exponent expression
Example

Define a Power expression:

x = ox.State("x", shape=(3,))
y = x ** 2  # Creates Power(x, Constant(2))
Source code in openscvx/symbolic/expr/arithmetic.py 
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
class Power(Expr):
    """Element-wise power operation for symbolic expressions.

    Represents element-wise exponentiation (base ** exponent). Supports broadcasting
    following NumPy rules. Can be created using the ** operator on Expr objects.

    Attributes:
        base: Base expression
        exponent: Exponent expression

    Example:
        Define a Power expression:

            x = ox.State("x", shape=(3,))
            y = x ** 2  # Creates Power(x, Constant(2))
    """

    def __init__(self, base, exponent):
        """Initialize a power operation.

        Args:
            base: Base expression
            exponent: Exponent expression
        """
        self.base = to_expr(base)
        self.exponent = to_expr(exponent)

    def children(self):
        return [self.base, self.exponent]

    def canonicalize(self) -> "Expr":
        """Canonicalize power by canonicalizing base and exponent.

        Returns:
            Expr: Canonical form of the power expression
        """
        base = self.base.canonicalize()
        exponent = self.exponent.canonicalize()
        return Power(base, exponent)

    def check_shape(self) -> Tuple[int, ...]:
        shapes = [child.check_shape() for child in self.children()]
        try:
            return np.broadcast_shapes(*shapes)
        except ValueError as e:
            raise ValueError(f"Power shapes not broadcastable: {shapes}") from e

    def __repr__(self):
        return f"({self.base!r})**({self.exponent!r})"
canonicalize() -> Expr

Canonicalize power by canonicalizing base and exponent.

Returns:

Name Type Description
Expr Expr

Canonical form of the power expression
Source code in openscvx/symbolic/expr/arithmetic.py 
499
500
501
502
503
504
505
506
507
def canonicalize(self) -> "Expr":
    """Canonicalize power by canonicalizing base and exponent.

    Returns:
        Expr: Canonical form of the power expression
    """
    base = self.base.canonicalize()
    exponent = self.exponent.canonicalize()
    return Power(base, exponent)

Sub

Bases: Expr

Subtraction operation for symbolic expressions.

Represents element-wise subtraction (left - right). Supports broadcasting following NumPy rules. Can be created using the - operator on Expr objects.

Attributes:

Name Type Description
left

Left-hand side expression (minuend)
right

Right-hand side expression (subtrahend)
Example

Define a Sub expression:

x = ox.State("x", shape=(3,))
y = ox.State("y", shape=(3,))
z = x - y  # Creates Sub(x, y)
Source code in openscvx/symbolic/expr/arithmetic.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
class Sub(Expr):
    """Subtraction operation for symbolic expressions.

    Represents element-wise subtraction (left - right). Supports broadcasting
    following NumPy rules. Can be created using the - operator on Expr objects.

    Attributes:
        left: Left-hand side expression (minuend)
        right: Right-hand side expression (subtrahend)

    Example:
        Define a Sub expression:

            x = ox.State("x", shape=(3,))
            y = ox.State("y", shape=(3,))
            z = x - y  # Creates Sub(x, y)
    """

    def __init__(self, left, right):
        """Initialize a subtraction operation.

        Args:
            left: Expression to subtract from (minuend)
            right: Expression to subtract (subtrahend)
        """
        self.left = left
        self.right = right

    def children(self):
        return [self.left, self.right]

    def canonicalize(self) -> "Expr":
        """Canonicalize subtraction: fold constants if both sides are constants.

        Returns:
            Expr: Canonical form of the subtraction expression
        """
        left = self.left.canonicalize()
        right = self.right.canonicalize()
        if isinstance(left, Constant) and isinstance(right, Constant):
            return Constant(left.value - right.value)
        return Sub(left, right)

    def check_shape(self) -> Tuple[int, ...]:
        """Check shape compatibility and compute broadcasted result shape like NumPy.

        Returns:
            tuple: The broadcasted shape of all operands

        Raises:
            ValueError: If operand shapes are not broadcastable
        """
        shapes = [child.check_shape() for child in self.children()]
        try:
            return np.broadcast_shapes(*shapes)
        except ValueError as e:
            raise ValueError(f"Sub shapes not broadcastable: {shapes}") from e

    def __repr__(self):
        return f"({self.left!r} - {self.right!r})"
canonicalize() -> Expr

Canonicalize subtraction: fold constants if both sides are constants.

Returns:

Name Type Description
Expr Expr

Canonical form of the subtraction expression
Source code in openscvx/symbolic/expr/arithmetic.py 
156
157
158
159
160
161
162
163
164
165
166
def canonicalize(self) -> "Expr":
    """Canonicalize subtraction: fold constants if both sides are constants.

    Returns:
        Expr: Canonical form of the subtraction expression
    """
    left = self.left.canonicalize()
    right = self.right.canonicalize()
    if isinstance(left, Constant) and isinstance(right, Constant):
        return Constant(left.value - right.value)
    return Sub(left, right)
check_shape() -> Tuple[int, ...]

Check shape compatibility and compute broadcasted result shape like NumPy.

Returns:

Name Type Description
tuple Tuple[int, ...]

The broadcasted shape of all operands

Raises:

Type Description
ValueError

If operand shapes are not broadcastable
Source code in openscvx/symbolic/expr/arithmetic.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def check_shape(self) -> Tuple[int, ...]:
    """Check shape compatibility and compute broadcasted result shape like NumPy.

    Returns:
        tuple: The broadcasted shape of all operands

    Raises:
        ValueError: If operand shapes are not broadcastable
    """
    shapes = [child.check_shape() for child in self.children()]
    try:
        return np.broadcast_shapes(*shapes)
    except ValueError as e:
        raise ValueError(f"Sub shapes not broadcastable: {shapes}") from e