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.
`ConstraintCollection`	Live, read-only mapping of all active constraint families in a model.
`ConstraintFamilyView`	Live, read-only mapping of one constraint family, created by `of_kind`.
`ConstraintID`	A regular constraint ID. Unequal to integers and IDs of other constraint families.
`ConstraintIDBase`	Common base of constraint IDs, including families introduced by future SDKs.
`ConstraintKind`	An extensible constraint family selector. Use Regular, Indicator, OneHot or Sos1; keep a rejecting f…
`ConstraintView`	Common metadata interface for rows fetched from constraint collections.
`DecisionVariable`	Decision variable in an optimization problem.
`DecisionVariableRole`	How a decision variable obtains its value in an {class}~ommx.Instance.
`Equality`	Equality type for constraints
`EvaluatedConstraint`
`EvaluatedConstraintCollection`	Live mapping of a Solution’s constraint results, including retained removed rows.
`EvaluatedDecisionVariable`
`EvaluatedIndicatorConstraint`	An owned evaluated indicator result. Fetched by typed ID from the owning result’s constraints collec…
`EvaluatedNamedFunction`	EvaluatedNamedFunction wrapper for Python.
`EvaluatedOneHotConstraint`	An owned evaluated one-hot result. Fetched by typed ID from the owning result’s constraints collecti…
`EvaluatedSos1Constraint`	An owned evaluated SOS1 result. Fetched by typed ID from the owning result’s constraints collection.
`ExactIntegerSlackError`	Exact integer-slack conversion is unavailable for the requested inequality.
`FixedPenaltyPreparation`	Selection for the fixed-weight penalty Preparation phase.
`Function`	A scalar expression used in optimization objectives and constraint bodies.
`IndicatorConstraint`	A condition enforced when a controlling Binary variable equals one.
`IndicatorConstraintID`	An indicator constraint ID. Unequal to integers and IDs of other constraint families.
`InfeasibleDetected`	The mathematical model was proven infeasible.
`Instance`	An optimization problem with variable domains, an objective, and constraints.
`InstanceClass`	A set of exact {class}~ommx.Instance representations, used for inspection and
`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`	Selection for the used-Integer encoding Preparation phase.
`IntegerSlackPreparation`	Integer-slack Preparation for active regular inequalities.
`Kind`	Numeric scalar decision-variable domain kind.
`Linear`	Linear function of decision variables.
`LogEncodingError`	An exact log encoding is unavailable for one requested decision variable.
`NamedFunction`	A labeled expression for reporting a candidate’s additional metrics.
`ObjectivePreparation`	Selection for the active-objective Preparation phase.
`OneHotConstraint`	Require exactly one member of a nonempty set of Binary variables to equal one.
`OneHotConstraintID`	A one-hot constraint ID. Unequal to integers and IDs of other constraint families.
`Optimality`	Optimality status of a solution
`OutputObjective`	Read-only objective semantics used when evaluating solver output.
`Parameter`	A symbolic numerical input to a fixed-structure optimization problem.
`ParametricInstance`	A family of optimization problems with fixed variables and constraints.
`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`	Source constraint family. Additional provenance families may be added.
`Quadratic`	Quadratic function of decision variables.
`Relaxation`	Relaxation status of a solution
`RemovedConstraint`	RemovedConstraint wrapper for Python.
`RemovedConstraintCollection`	Live mapping of all retained removed constraint families in a model.
`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`	Multiple candidates evaluated against the same optimization problem.
`SampledConstraint`
`SampledConstraintCollection`	Live mapping of a SampleSet’s constraint results, including retained removed rows.
`SampledDecisionVariable`
`SampledIndicatorConstraint`	An owned sampled indicator result. Fetched by typed ID from the owning result’s constraints collecti…
`SampledNamedFunction`	SampledNamedFunction wrapper for Python.
`SampledOneHotConstraint`	An owned sampled one-hot result. Fetched by typed ID from the owning result’s constraints collection…
`SampledSos1Constraint`	An owned sampled SOS1 result. Fetched by typed ID from the owning result’s constraints collection.
`Samples`	Multiple candidate assignments, each identified by a sample ID.
`Sense`	Sense of optimization (minimize or maximize)
`Solution`	A candidate evaluated against a particular optimization problem.
`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 Special Ordered Set type 1: at most one member may be nonzero.
`Sos1ConstraintID`	An SOS1 constraint ID. Unequal to integers and IDs of other constraint families.
`SpecialConstraintPreparation`	Selection for the special-constraint Preparation phase.
`State`	A candidate assignment from integer decision-variable IDs to numeric values.

Functions

Name	Description
`get_default_atol`
`set_default_atol`

Type Aliases

Name	Description
`NamedState`	Decision-variable values grouped by name and tuple subscripts. Use () for scalars and (i,) for one-d…
`ToSamples`
`ToState`
`VariableIDLike`	A variable ID or decision-variable object. APIs using this type consume only the OMMX variable ident…