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
`BinaryPowerPreparation`	Reduce powers of active Binary variables during Preparation.
`Bound`	Variable bound wrapper for Python
`BridgeError`	An OMMX bridge protocol, registration, or transfer failure after loading the SDK.
`Constraint`	Constraint wrapper for Python.
`DecisionVariable`	Decision variable in an optimization problem.
`DecisionVariableRole`	Decision variable role in an instance.
`Equality`	Equality type for constraints
`EvaluatedConstraint`
`EvaluatedDecisionVariable`
`EvaluatedNamedFunction`	EvaluatedNamedFunction wrapper for Python.
`ExactIntegerSlackError`	Exact integer-slack conversion is unavailable for the requested inequality.
`FixedPenaltyPreparation`
`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.
`IntegerEncodingPreparation`
`IntegerSlackPreparation`
`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.
`ObjectivePreparation`	Convert the active objective to `target` during Preparation.
`OneHotConstraint`	A one-hot constraint: exactly one variable must be 1, the rest must be 0.
`Optimality`	Optimality status of a solution
`OutputObjective`	Read-only objective semantics used when evaluating solver output.
`Parameter`	Parameter in an optimization problem.
`ParametricInstance`
`Polynomial`	Polynomial function of decision variables.
`PolynomialRequirement`	Polynomial requirement for one function position in an
`PreparationPolicy`	Select optional transformations applied by {meth}~ommx.Instance.prepare.
`PreparationTargetNotReachedError`	Configured Preparation phases were exhausted without reaching the target InstanceClass.
`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.
`Sos1BigMPromotion`	Read-only report for an entire SOS1 Big-M promotion batch.
`Sos1BigMPromotionBatchRejectedError`	One or more requests in a strict SOS1 Big-M promotion batch were rejected.
`Sos1BigMPromotionRequest`	Untrusted stable-ID request for a batch of SOS1 Big-M promotions.
`Sos1BigMSelectorClaim`	Unchecked selector-role claim for one member of an SOS1 Big-M formulation.
`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.
`SpecialConstraintPreparation`
`State`	State wrapper for Python

Functions

Name	Description
`get_default_atol`
`set_default_atol`

Type Aliases

Name	Description
`ToSamples`
`ToState`
`VariableIDLike`	A variable ID or decision-variable object. APIs using this type consume only the OMMX variable ident...