ommx.v1.decision_variables_pb2

Classes

`Bound`	Upper and lower bound of the decision variable.
`DecisionVariable`	Decison variable which mathematical programming solver will optimize.

Module Contents

class ommx.v1.decision_variables_pb2.Bound(*, lower: float = ..., upper: float = ...)

Upper and lower bound of the decision variable.

ClearField(field_name: Literal['lower', b'lower', 'upper', b'upper']) → None

LOWER_FIELD_NUMBER: int

UPPER_FIELD_NUMBER: int

lower: float: Lower bound of the decision variable.

upper: float: Upper bound of the decision variable.

class ommx.v1.decision_variables_pb2.DecisionVariable(*, id: int = ..., kind: global___DecisionVariable = ..., bound: global___Bound | None = ..., name: str | None = ..., subscripts: collections.abc.Iterable[int] | None = ..., parameters: collections.abc.Mapping[str, str] | None = ..., description: str | None = ..., substituted_value: float | None = ...)

Decison variable which mathematical programming solver will optimize. It must have its kind, i.e. binary, integer, real or others and unique identifier of 64-bit integer. It may have its name and subscripts which are used to identify in modeling tools.

class Kind

Kind of the decision variable

type V = ValueType

ValueType

class ParametersEntry(*, key: str = ..., value: str = ...)

ClearField(field_name: Literal['key', b'key', 'value', b'value']) → None

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

value: str

ClearField(field_name: Literal['_bound', b'_bound', '_description', b'_description', '_name', b'_name', '_substituted_value', b'_substituted_value', 'bound', b'bound', 'description', b'description', 'id', b'id', 'kind', b'kind', 'name', b'name', 'parameters', b'parameters', 'subscripts', b'subscripts', 'substituted_value', b'substituted_value']) → None

HasField(field_name: Literal['_bound', b'_bound', '_description', b'_description', '_name', b'_name', '_substituted_value', b'_substituted_value', 'bound', b'bound', 'description', b'description', 'name', b'name', 'substituted_value', b'substituted_value']) → bool

WhichOneof(oneof_group: Literal['_bound', b'_bound']) → Literal['bound'] | None
WhichOneof(oneof_group: Literal['_description', b'_description']) → Literal['description'] | None
WhichOneof(oneof_group: Literal['_name', b'_name']) → Literal['name'] | None
WhichOneof(oneof_group: Literal['_substituted_value', b'_substituted_value']) → Literal['substituted_value'] | None

BOUND_FIELD_NUMBER: int

DESCRIPTION_FIELD_NUMBER: int

ID_FIELD_NUMBER: int

KIND_BINARY: DecisionVariable

KIND_CONTINUOUS: DecisionVariable

KIND_FIELD_NUMBER: int

KIND_INTEGER: DecisionVariable

KIND_SEMI_CONTINUOUS: DecisionVariable: Semi-continuous decision variable is a decision variable that can take only continuous values in the given range or zero.

KIND_SEMI_INTEGER: DecisionVariable: Semi-integer decision variable is a decision variable that can take only integer values in the given range or zero.

KIND_UNSPECIFIED: DecisionVariable

NAME_FIELD_NUMBER: int

PARAMETERS_FIELD_NUMBER: int

SUBSCRIPTS_FIELD_NUMBER: int

SUBSTITUTED_VALUE_FIELD_NUMBER: int

property bound: global___Bound: Bound of the decision variable If the bound is not specified, the decision variable is considered as unbounded.

description: str: Detail human-readable description of the decision variable.

id: int

Decision variable ID.

IDs are not required to be sequential.

kind: global___DecisionVariable.Kind.ValueType: Kind of the decision variable

name: str: Name of the decision variable. e.g. x

property parameters: google.protobuf.internal.containers.ScalarMap[str, str]: Additional parameters for decision variables

property subscripts: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int]: Subscripts of the decision variable. e.g. [1, 3] for an element of multidimensional deicion variable x[1, 3]

substituted_value: float: The value substituted by partial evaluation of the instance. Not determined by the solver.