Skip to content

TermDefinition class

Represents the definition of a term in an optimization model.

It provides a way to define the characteristics of a Term, such as its name, the term set it belongs to (if applicable), and the display name for the term.

Source code in pyorlib/structures/definitions/term_definition.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@dataclass(frozen=True)
class TermDefinition:
    """
    Represents the definition of a term in an optimization model.

    It provides a way to define the characteristics of a Term, such as its name,
    the term set it belongs to (if applicable), and the display name for the term.
    """

    name: Callable[..., str] | str
    """ 
    The name of the term. It can be a callable that returns the indexed name
    of the term (e.g., `lambda` i, j: 'x_i_j'), or a string with the name itself.
    """

    set_name: str | None = None
    """ The name of the term set to which this term belongs (e.g., x_i_j). """

    display_name: str | None = None
    """ The name of the term as it should be displayed to the user. """

Attributes

name instance-attribute 

name: Callable[..., str] | str

The name of the term. It can be a callable that returns the indexed name of the term (e.g., lambda i, j: 'x_i_j'), or a string with the name itself.

set_name class-attribute instance-attribute 

set_name: str | None = None

The name of the term set to which this term belongs (e.g., x_i_j).

display_name class-attribute instance-attribute 

display_name: str | None = None

The name of the term as it should be displayed to the user.

Functions

__init__ 

__init__(name: Callable[..., str] | str, set_name: str | None = None, display_name: str | None = None) -> None