ommx.v1

ommx.v1#

Classes

Name

Description

AdditionalCapability

Constraint type capability flag for non-standard constraint types.

Bound

Variable bound wrapper for Python

Constraint

Constraint wrapper for Python

DecisionVariable

Decision variable in an optimization problem.

DecisionVariableAnalysis

Equality

Equality type for constraints

EvaluatedConstraint

EvaluatedDecisionVariable

EvaluatedNamedFunction

EvaluatedNamedFunction wrapper for Python

Function

General mathematical function of decision variables.

IndicatorConstraint

Instance

Optimization problem instance.

Kind

Kind of decision variable

Linear

Linear function of decision variables.

NamedFunction

NamedFunction wrapper for Python

OneHotConstraint

A one-hot constraint: exactly one variable must be 1, the rest must be 0.

Optimality

Optimality status of a solution

Parameter

Parameter in an optimization problem.

ParametricInstance

Polynomial

Polynomial function of decision variables.

Quadratic

Quadratic function of decision variables.

Relaxation

Relaxation status of a solution

RemovedConstraint

RemovedConstraint wrapper for Python.

RemovedIndicatorConstraint

A removed indicator constraint together with the reason it was removed.

RemovedOneHotConstraint

A removed one-hot constraint together with the reason it was removed.

RemovedSos1Constraint

A removed SOS1 constraint together with the reason it was removed.

Rng

SampleSet

The output of sampling-based optimization algorithms, e.g. simulated annealing (SA).

SampledConstraint

SampledDecisionVariable

SampledNamedFunction

Samples

Collection of State samples

Sense

Sense of optimization (minimize or maximize)

Solution

Idiomatic wrapper of ommx.v1.Solution protobuf message.

Sos1Constraint

A SOS1 (Special Ordered Set type 1) constraint: at most one variable can be non-zero.

State

State wrapper for Python

Type Aliases

Name

Description

ToSamples

ToState