Skip to content

Parameter class

Bases: ABC

An abstract data class representing a parameter in an optimization model.

The Parameter class is an abstract base class (ABC) that defines the common interface for parameters in an optimization model. It provides information about the type of the parameter and the value type of its values.

Source code in pyorlib/structures/parameters/parameter.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@dataclass(frozen=True)
class Parameter(ABC):
    """
    An abstract data class representing a parameter in an optimization model.

    The `Parameter` class is an abstract base class (ABC) that defines the common interface for parameters in an
    optimization model. It provides information about the type of the parameter and the value type of its values.
    """

    parameter_type: ParameterType
    """ The type of the parameter. """

    value_type: ValueType
    """ The value type of the parameter values. """

    @property
    def is_bounded(self) -> bool:
        """
        Returns a boolean indicating whether the parameter is bounded.
        :return: `True` if the parameter is bounded, `False` otherwise.
        """
        return self.parameter_type == ParameterType.BOUNDED

Attributes

parameter_type instance-attribute 

parameter_type: ParameterType

The type of the parameter.

value_type instance-attribute 

value_type: ValueType

The value type of the parameter values.

is_bounded property 

is_bounded: bool

Returns a boolean indicating whether the parameter is bounded.

RETURNS DESCRIPTION
bool

True if the parameter is bounded, False otherwise.

Functions

__init__ 

__init__(parameter_type: ParameterType, value_type: ValueType) -> None