Skip to content

Expression class

Bases: Element

Represents a mathematical expression used to encapsulate expressions in an optimization model.

The Expression class is a subclass of the Element class and serves as a representation of a mathematical expression within an optimization model. It is specifically designed to encapsulate expressions and offers methods for performing various mathematical operations on those expressions.

Note: The supported mathematical operations on an Expression instance depend on the operations supported in the encapsulated expression. These operations can include arithmetic operations, functions, and any other operations defined by the underlying mathematical expression.

Source code in pyorlib/algebra/expressions/expression.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
class Expression(Element):
    """
    Represents a mathematical expression used to encapsulate expressions in an optimization model.

    The `Expression` class is a subclass of the `Element` class and serves as a representation of a mathematical
    expression within an optimization model. It is specifically designed to encapsulate expressions and offers
    methods for performing various mathematical operations on those expressions.

    **Note**: The supported mathematical operations on an `Expression` instance depend on the operations supported
    in the encapsulated expression. These operations can include arithmetic operations, functions, and
    any other operations defined by the underlying mathematical expression.
    """

    @property
    def raw(self) -> Any:
        return self.__expression

    def __init__(self, expression: Any):
        """
        Initialize an Expression instance.
        :param expression: The expression value to be encapsulated.
        :raises ValueError: If the expression is None.
        """
        # Applies validations
        if expression is None:
            raise ValueError("Expression cannot be None")

        # Instance attributes
        self.__expression: Any = expression
        """ The mathematical expression. """

    def _build_expression(self, expression: Any) -> Element:
        return Expression(expression=expression)

    def __str__(self) -> str:
        return str(self.raw)

    def __iadd__(self, other: Any) -> Element:
        if isinstance(other, Element):
            self.__expression += other.raw
        else:
            self.__expression += other
        return self

    def __isub__(self, other: Any) -> Element:
        if isinstance(other, Element):
            self.__expression -= other.raw
        else:
            self.__expression -= other
        return self

    def __imul__(self, other: Any) -> Element:
        if isinstance(other, Element):
            self.__expression *= other.raw
        else:
            self.__expression *= other
        return self

    def __itruediv__(self, other: Any) -> Element:
        if isinstance(other, Element):
            self.__expression /= other.raw
        else:
            self.__expression /= other
        return self

    def __ifloordiv__(self, other: Any) -> Element:
        if isinstance(other, Element):
            self.__expression //= other.raw
        else:
            self.__expression //= other
        return self

    def __imod__(self, other: Any) -> Element:
        if isinstance(other, Element):
            self.__expression %= other.raw
        else:
            self.__expression %= other
        return self

    def __ipow__(self, other: Any) -> Element:
        if isinstance(other, Element):
            self.__expression **= other.raw
        else:
            self.__expression **= other
        return self

Attributes

raw property 

raw: Any

Functions

__add__ 

__add__(other: Any) -> Element

Addition operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be added.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the addition.
Source code in pyorlib/algebra/element.py 
56
57
58
59
60
61
62
63
64
65
def __add__(self, other: Any) -> "Element":
    """
    Addition operation.
    :param other: The `number` or `Element` instance to be added.
    :return: A new `Element` instance representing the addition.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw + other.raw)
    else:
        return self._build_expression(expression=self.raw + other)

__radd__ 

__radd__(other: Any) -> Element

Right addition operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be added.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the addition.
Source code in pyorlib/algebra/element.py 
67
68
69
70
71
72
73
74
75
76
def __radd__(self, other: Any) -> "Element":
    """
    Right addition operation.
    :param other: The `number` or `Element` instance to be added.
    :return: A new `Element` instance representing the addition.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=other.raw + self.raw)
    else:
        return self._build_expression(expression=other + self.raw)

__sub__ 

__sub__(other: Any) -> Element

Subtraction operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be subtracted.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the subtraction.
Source code in pyorlib/algebra/element.py 
88
89
90
91
92
93
94
95
96
97
def __sub__(self, other: Any) -> "Element":
    """
    Subtraction operation.
    :param other: The `number` or `Element` instance to be subtracted.
    :return: A new `Element` instance representing the subtraction.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw - other.raw)
    else:
        return self._build_expression(expression=self.raw - other)

__rsub__ 

__rsub__(other: Any) -> Element

Right subtraction operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be subtracted.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the subtraction.
Source code in pyorlib/algebra/element.py 
 99
100
101
102
103
104
105
106
107
108
def __rsub__(self, other: Any) -> "Element":
    """
    Right subtraction operation.
    :param other: The `number` or `Element` instance to be subtracted.
    :return: A new `Element` instance representing the subtraction.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=other.raw - self.raw)
    else:
        return self._build_expression(expression=other - self.raw)

__mul__ 

__mul__(other: Any) -> Element

Multiplication operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be multiplied.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the multiplication.
Source code in pyorlib/algebra/element.py 
120
121
122
123
124
125
126
127
128
129
def __mul__(self, other: Any) -> "Element":
    """
    Multiplication operation.
    :param other: The `number` or `Element` instance to be multiplied.
    :return: A new `Element` instance representing the multiplication.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw * other.raw)
    else:
        return self._build_expression(expression=self.raw * other)

__rmul__ 

__rmul__(other: Any) -> Element

Right multiplication operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be multiplied.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the multiplication.
Source code in pyorlib/algebra/element.py 
131
132
133
134
135
136
137
138
139
140
def __rmul__(self, other: Any) -> "Element":
    """
    Right multiplication operation.
    :param other: The `number` or `Element` instance to be multiplied.
    :return: A new `Element` instance representing the multiplication.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=other.raw * self.raw)
    else:
        return self._build_expression(expression=other * self.raw)

__truediv__ 

__truediv__(other: Any) -> Element

Division operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be divided.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the division.
Source code in pyorlib/algebra/element.py 
152
153
154
155
156
157
158
159
160
161
def __truediv__(self, other: Any) -> "Element":
    """
    Division operation.
    :param other: The `number` or `Element` instance to be divided.
    :return: A new `Element` instance representing the division.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw / other.raw)
    else:
        return self._build_expression(expression=self.raw / other)

__rtruediv__ 

__rtruediv__(other: Any) -> Element

Right division operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be divided.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the division.
Source code in pyorlib/algebra/element.py 
163
164
165
166
167
168
169
170
171
172
def __rtruediv__(self, other: Any) -> "Element":
    """
    Right division operation.
    :param other: The `number` or `Element` instance to be divided.
    :return: A new `Element` instance representing the division.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=other.raw / self.raw)
    else:
        return self._build_expression(expression=other / self.raw)

__floordiv__ 

__floordiv__(other: Any) -> Element

Floor division operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be floor divided.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the floor division.
Source code in pyorlib/algebra/element.py 
184
185
186
187
188
189
190
191
192
193
def __floordiv__(self, other: Any) -> "Element":
    """
    Floor division operation.
    :param other: The `number` or `Element` instance to be floor divided.
    :return: A new `Element` instance representing the floor division.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw // other.raw)
    else:
        return self._build_expression(expression=self.raw // other)

__rfloordiv__ 

__rfloordiv__(other: Any) -> Element

Right floor division operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be floor divided.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the floor division.
Source code in pyorlib/algebra/element.py 
195
196
197
198
199
200
201
202
203
204
def __rfloordiv__(self, other: Any) -> "Element":
    """
    Right floor division operation.
    :param other: The `number` or `Element` instance to be floor divided.
    :return: A new `Element` instance representing the floor division.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=other.raw // self.raw)
    else:
        return self._build_expression(expression=other // self.raw)

__mod__ 

__mod__(other: Any) -> Element

Modulo operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be used for modulo.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the modulo operation.
Source code in pyorlib/algebra/element.py 
216
217
218
219
220
221
222
223
224
225
def __mod__(self, other: Any) -> "Element":
    """
    Modulo operation.
    :param other: The `number` or `Element` instance to be used for modulo.
    :return: A new `Element` instance representing the modulo operation.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw % other.raw)
    else:
        return self._build_expression(expression=self.raw % other)

__rmod__ 

__rmod__(other: Any) -> Element

Right modulo operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be used for modulo.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the modulo operation.
Source code in pyorlib/algebra/element.py 
227
228
229
230
231
232
233
234
235
236
def __rmod__(self, other: Any) -> "Element":
    """
    Right modulo operation.
    :param other: The `number` or `Element` instance to be used for modulo.
    :return: A new `Element` instance representing the modulo operation.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=other.raw % self.raw)
    else:
        return self._build_expression(expression=other % self.raw)

__pow__ 

__pow__(other: Any) -> Element

Exponentiation operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be used as the exponent.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the exponentiation.
Source code in pyorlib/algebra/element.py 
248
249
250
251
252
253
254
255
256
257
def __pow__(self, other: Any) -> "Element":
    """
    Exponentiation operation.
    :param other: The `number` or `Element` instance to be used as the exponent.
    :return: A new `Element` instance representing the exponentiation.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw**other.raw)
    else:
        return self._build_expression(expression=self.raw**other)

__rpow__ 

__rpow__(other: Any) -> Element

Right exponentiation operation.

PARAMETER DESCRIPTION
other

The number or Element instance to be used as the base.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the exponentiation.
Source code in pyorlib/algebra/element.py 
259
260
261
262
263
264
265
266
267
268
def __rpow__(self, other: Any) -> "Element":
    """
    Right exponentiation operation.
    :param other: The `number` or `Element` instance to be used as the base.
    :return: A new `Element` instance representing the exponentiation.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=other.raw**self.raw)
    else:
        return self._build_expression(expression=other**self.raw)

__neg__ 

__neg__() -> Element

Negation operation.

RETURNS DESCRIPTION
Element

A new Element instance representing the negation.
Source code in pyorlib/algebra/element.py 
280
281
282
283
284
285
def __neg__(self) -> "Element":
    """
    Negation operation.
    :return: A new `Element` instance representing the negation.
    """
    return self._build_expression(expression=-self.raw)

__pos__ 

__pos__() -> Element

Positive operation.

RETURNS DESCRIPTION
Element

A new Element instance representing the positive value.
Source code in pyorlib/algebra/element.py 
287
288
289
290
291
292
def __pos__(self) -> "Element":
    """
    Positive operation.
    :return: A new `Element` instance representing the positive value.
    """
    return self._build_expression(expression=+self.raw)

__abs__ 

__abs__() -> Element

Absolute value operation.

RETURNS DESCRIPTION
Element

A new Element instance representing the absolute value.
Source code in pyorlib/algebra/element.py 
294
295
296
297
298
299
def __abs__(self) -> "Element":
    """
    Absolute value operation.
    :return: A new `Element` instance representing the absolute value.
    """
    return self._build_expression(expression=abs(self.raw))

__eq__ 

__eq__(other: Any) -> Element

Equal to comparison.

PARAMETER DESCRIPTION
other

The number or Element instance to be compared.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the comparison result.
Source code in pyorlib/algebra/element.py 
302
303
304
305
306
307
308
309
310
311
def __eq__(self, other: Any) -> "Element":  # type: ignore[override]
    """
    Equal to comparison.
    :param other: The `number` or `Element` instance to be compared.
    :return: A new `Element` instance representing the comparison result.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw == other.raw)
    else:
        return self._build_expression(expression=self.raw == other)

__ne__ 

__ne__(other: Any) -> Element

Not equal to comparison.

PARAMETER DESCRIPTION
other

The number or Element instance to be compared.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the comparison result.
Source code in pyorlib/algebra/element.py 
313
314
315
316
317
318
319
320
321
322
def __ne__(self, other: Any) -> "Element":  # type: ignore[override]
    """
    Not equal to comparison.
    :param other: The `number` or `Element` instance to be compared.
    :return: A new `Element` instance representing the comparison result.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw != other.raw)
    else:
        return self._build_expression(expression=self.raw != other)

__lt__ 

__lt__(other: Any) -> Element

Less than comparison.

PARAMETER DESCRIPTION
other

The number or Element instance to be compared.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the comparison result.
Source code in pyorlib/algebra/element.py 
324
325
326
327
328
329
330
331
332
333
def __lt__(self, other: Any) -> "Element":
    """
    Less than comparison.
    :param other: The `number` or `Element` instance to be compared.
    :return: A new `Element` instance representing the comparison result.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw < other.raw)
    else:
        return self._build_expression(expression=self.raw < other)

__le__ 

__le__(other: Any) -> Element

Less than or equal to comparison.

PARAMETER DESCRIPTION
other

The number or Element instance to be compared.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the comparison result.
Source code in pyorlib/algebra/element.py 
335
336
337
338
339
340
341
342
343
344
def __le__(self, other: Any) -> "Element":
    """
    Less than or equal to comparison.
    :param other: The `number` or `Element` instance to be compared.
    :return: A new `Element` instance representing the comparison result.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw <= other.raw)
    else:
        return self._build_expression(expression=self.raw <= other)

__gt__ 

__gt__(other: Any) -> Element

Greater than comparison.

PARAMETER DESCRIPTION
other

The number or Element instance to be compared.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the comparison result.
Source code in pyorlib/algebra/element.py 
346
347
348
349
350
351
352
353
354
355
def __gt__(self, other: Any) -> "Element":
    """
    Greater than comparison.
    :param other: The `number` or `Element` instance to be compared.
    :return: A new `Element` instance representing the comparison result.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw > other.raw)
    else:
        return self._build_expression(expression=self.raw > other)

__ge__ 

__ge__(other: Any) -> Element

Greater than or equal to comparison.

PARAMETER DESCRIPTION
other

The number or Element instance to be compared.

TYPE: Any

RETURNS DESCRIPTION
Element

A new Element instance representing the comparison result.
Source code in pyorlib/algebra/element.py 
357
358
359
360
361
362
363
364
365
366
def __ge__(self, other: Any) -> "Element":
    """
    Greater than or equal to comparison.
    :param other: The `number` or `Element` instance to be compared.
    :return: A new `Element` instance representing the comparison result.
    """
    if isinstance(other, Element):
        return self._build_expression(expression=self.raw >= other.raw)
    else:
        return self._build_expression(expression=self.raw >= other)

__init__ 

__init__(expression: Any)

Initialize an Expression instance.

PARAMETER DESCRIPTION
expression

The expression value to be encapsulated.

TYPE: Any

RAISES DESCRIPTION
ValueError

If the expression is None.
Source code in pyorlib/algebra/expressions/expression.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
def __init__(self, expression: Any):
    """
    Initialize an Expression instance.
    :param expression: The expression value to be encapsulated.
    :raises ValueError: If the expression is None.
    """
    # Applies validations
    if expression is None:
        raise ValueError("Expression cannot be None")

    # Instance attributes
    self.__expression: Any = expression
    """ The mathematical expression. """

__iadd__ 

__iadd__(other: Any) -> Element
Source code in pyorlib/algebra/expressions/expression.py 
43
44
45
46
47
48
def __iadd__(self, other: Any) -> Element:
    if isinstance(other, Element):
        self.__expression += other.raw
    else:
        self.__expression += other
    return self

__isub__ 

__isub__(other: Any) -> Element
Source code in pyorlib/algebra/expressions/expression.py 
50
51
52
53
54
55
def __isub__(self, other: Any) -> Element:
    if isinstance(other, Element):
        self.__expression -= other.raw
    else:
        self.__expression -= other
    return self

__imul__ 

__imul__(other: Any) -> Element
Source code in pyorlib/algebra/expressions/expression.py 
57
58
59
60
61
62
def __imul__(self, other: Any) -> Element:
    if isinstance(other, Element):
        self.__expression *= other.raw
    else:
        self.__expression *= other
    return self

__itruediv__ 

__itruediv__(other: Any) -> Element
Source code in pyorlib/algebra/expressions/expression.py 
64
65
66
67
68
69
def __itruediv__(self, other: Any) -> Element:
    if isinstance(other, Element):
        self.__expression /= other.raw
    else:
        self.__expression /= other
    return self

__ifloordiv__ 

__ifloordiv__(other: Any) -> Element
Source code in pyorlib/algebra/expressions/expression.py 
71
72
73
74
75
76
def __ifloordiv__(self, other: Any) -> Element:
    if isinstance(other, Element):
        self.__expression //= other.raw
    else:
        self.__expression //= other
    return self

__imod__ 

__imod__(other: Any) -> Element
Source code in pyorlib/algebra/expressions/expression.py 
78
79
80
81
82
83
def __imod__(self, other: Any) -> Element:
    if isinstance(other, Element):
        self.__expression %= other.raw
    else:
        self.__expression %= other
    return self

__ipow__ 

__ipow__(other: Any) -> Element
Source code in pyorlib/algebra/expressions/expression.py 
85
86
87
88
89
90
def __ipow__(self, other: Any) -> Element:
    if isinstance(other, Element):
        self.__expression **= other.raw
    else:
        self.__expression **= other
    return self