ommx

ommx#

Classes

Name

Description

AttachedConstraint

Attached constraint — a write-through handle bound to a host

AttachedDecisionVariable

Attached decision variable — a write-through handle bound to a host

AttachedIndicatorConstraint

Attached indicator constraint — a write-through handle bound to a host

AttachedOneHotConstraint

Attached one-hot constraint — a write-through handle bound to a host

AttachedSos1Constraint

Attached SOS1 constraint — a write-through handle bound to a host

Bound

Variable bound wrapper for Python

Constraint

Constraint wrapper for Python.

DecisionVariable

Decision variable in an optimization problem.

DecisionVariableRole

Decision variable role in an instance.

DegreeBound

Cumulative polynomial-degree bound in an :class:InstanceClassClause.

Equality

Equality type for constraints

EvaluatedConstraint

EvaluatedDecisionVariable

EvaluatedNamedFunction

EvaluatedNamedFunction wrapper for Python.

ExactIntegerSlackError

Exact integer-slack conversion is unavailable for the requested inequality.

Function

General mathematical function of decision variables.

IndicatorConstraint

InfeasibleDetected

The mathematical model was proven infeasible.

Instance

Optimization problem instance.

InstanceClass

A set of :class:Instance values represented as a finite union of clauses.

InstanceClassClause

One conjunctive clause in an :class:InstanceClass.

InstanceClassClauseReport

Membership result for one conjunctive instance-class clause.

InstanceClassMembershipReport

Side-effect-free membership report for an :class:InstanceClass.

InstanceClassMismatch

One structured reason an instance is outside a complete clause.

Kind

Kind of decision variable

Linear

Linear function of decision variables.

LogEncodingError

An exact log encoding is unavailable for one requested decision variable.

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.

Provenance

One step in a regular constraint’s transformation history.

ProvenanceKind

Kind of constraint from which a regular {class}~ommx.Constraint was generated.

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

SampledNamedFunction wrapper for Python.

Samples

Collection of State samples

Sense

Sense of optimization (minimize or maximize)

Solution

Python SDK domain type for evaluated optimization results.

Sos1Constraint

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

SpecialConstraintKind

Kind of active special constraint in an instance.

State

State wrapper for Python

Functions

Type Aliases

Name

Description

ToSamples

ToState

VariableIDLike

A variable ID or decision-variable object. APIs using this type consume only the OMMX variable ident…