Skip to content

ParameterDefinition class

Represents the definition of a parameter in an optimization model.

It provides various attributes to define the characteristics of the parameter in an optimization problem.

Source code in pyorlib/structures/definitions/parameter_definition.py 
 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
@dataclass(frozen=True)
class ParameterDefinition:
    """
    Represents the definition of a parameter in an optimization model.

    It provides various attributes to define the characteristics of the parameter in an optimization problem.
    """

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

    parameter_types: Set[ParameterType]
    """ A set of parameter types supported by the parameter. """

    value_types: Set[ValueType]
    """ A set of value types supported by the parameter. """

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

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

    min: float | int | None = None
    """ The minimum value allowed for the parameter. """

    max: float | int | None = None
    """ The maximum value allowed for the parameter. """

Attributes

name instance-attribute 

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

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

parameter_types instance-attribute 

parameter_types: Set[ParameterType]

A set of parameter types supported by the parameter.

value_types instance-attribute 

value_types: Set[ValueType]

A set of value types supported by the parameter.

set_name class-attribute instance-attribute 

set_name: str | None = None

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

display_name class-attribute instance-attribute 

display_name: str | None = None

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

min class-attribute instance-attribute 

min: float | int | None = None

The minimum value allowed for the parameter.

max class-attribute instance-attribute 

max: float | int | None = None

The maximum value allowed for the parameter.

Functions

__init__ 

__init__(name: Callable[..., str] | str, parameter_types: Set[ParameterType], value_types: Set[ValueType], set_name: str | None = None, display_name: str | None = None, min: float | int | None = None, max: float | int | None = None) -> None