ommx.adapter

Attributes

SamplerInput
SamplerOutput
SolverInput
SolverOutput

Exceptions

InfeasibleDetected	Common base class for all non-exit exceptions.
UnboundedDetected	Common base class for all non-exit exceptions.

Classes

SamplerAdapter	An abstract interface for OMMX Sampler Adapters, defining how samplers should be used with OMMX.
SolverAdapter	An abstract interface for OMMX Solver Adapters, defining how solvers should be used with OMMX.

Module Contents

exception ommx.adapter.InfeasibleDetected

Common base class for all non-exit exceptions.

exception ommx.adapter.UnboundedDetected

Common base class for all non-exit exceptions.

class ommx.adapter.SamplerAdapter(ommx_instance: ommx.v1.Instance)

An abstract interface for OMMX Sampler Adapters, defining how samplers should be used with OMMX.

See the implementation guide for more details.

decode(data: SamplerOutput) → ommx.v1.Solution

abstract decode_to_sampleset(data: SamplerOutput) → ommx.v1.SampleSet

classmethod sample(ommx_instance: ommx.v1.Instance) → ommx.v1.SampleSet

Abstractmethod:

classmethod solve(ommx_instance: ommx.v1.Instance, **kwargs) → ommx.v1.Solution

property sampler_input: SamplerInput

Abstractmethod:

property solver_input: SamplerInput

class ommx.adapter.SolverAdapter(ommx_instance: ommx.v1.Instance)

An abstract interface for OMMX Solver Adapters, defining how solvers should be used with OMMX.

See the implementation guide for more details.

abstract decode(data: SolverOutput) → ommx.v1.Solution

classmethod solve(ommx_instance: ommx.v1.Instance) → ommx.v1.Solution

Abstractmethod:

property solver_input: SolverInput

Abstractmethod:

ommx.adapter.SamplerInput

ommx.adapter.SamplerOutput

ommx.adapter.SolverInput

ommx.adapter.SolverOutput