ommx_openjij_adapter.adapter

ommx_openjij_adapter.adapter#

Direct OpenJij Adapter implementation.

Classes#

OMMXOpenJijSAAdapter

Implementation of ommx_openjij_adapter.OMMXOpenJijSAAdapter.

Module Contents#

Implementation of ommx_openjij_adapter.OMMXOpenJijSAAdapter.

classmethod check_applicability(ommx_instance: Instance) → InstanceClassMembershipReport#: Check INPUT_CLASS membership without mutation.

decode(data: openjij.Response) → Solution#: Decode sampler output and return its best feasible solution.

decode_to_samples(data: openjij.Response) → Samples#

Convert openjij.Response to ommx.Samples

There is a static method decode_to_samples() that does the same thing.

decode_to_sampleset(data: openjij.Response) → SampleSet#

classmethod recommended_preparation_policy() → PreparationPolicy#

Recommend the model changes commonly needed by OpenJij.

The recommendation lowers every special-constraint family, converts the active objective to minimization, adds Integer slack while permitting an inequality to remain when exact equality conversion is unavailable, and log-encodes every used Integer variable. Both Integer slack ranges use 32.

Fixed penalty magnitudes remain explicit caller parameters because sufficient values depend on the application. The shared Instance owner operation validates their nonnegative-with-tolerance domain. Set fixed_penalty on the fresh returned policy when active constraints must be removed.

classmethod require_applicable(ommx_instance: Instance) → InstanceClassMembershipReport#: Return the membership report or raise AdapterNotApplicableError.

Prepare and sample an isolated copy of ommx_instance.

This obtains a fresh recommended policy. For a complete example with an explicit penalty weight, see ommx_openjij_adapter.OMMXOpenJijSAAdapter.

OpenJij initial_state values are defined against the solver-variable representation of an exact Adapter input, so they are accepted only by sample_without_preparation().

Sample an exact OpenJij Adapter input without preparing it.

See ommx_openjij_adapter.OMMXOpenJijSAAdapter for a complete example from an explicitly prepared constrained model to candidate evaluation and selection.

initial_state is defined against this exact input’s solver-variable representation.

Prepare, sample, and return the best feasible result.

Selects from the obtained candidates and does not prove optimality. Raises ValueError if no sampled candidate is feasible. Use sample() to retain all candidates for inspection.

OpenJij initial_state values are defined against the solver-variable representation of an exact Adapter input, so they are accepted only by solve_without_preparation().

Return the best feasible result from sample_without_preparation().

Selection uses the reported objective and retained feasibility checks. It does not prove optimality and raises ValueError when no feasible candidate was obtained. Use sample_without_preparation() to inspect all candidates, as shown in ommx_openjij_adapter.OMMXOpenJijSAAdapter.

initial_state is defined against the exact Adapter input’s solver-variable representation.

INPUT_CLASS: ClassVar[InstanceClass]#: Required condition for an exact Adapter input.

MAX_OPENJIJ_VARIABLE_ID: ClassVar[int] = 9223372036854775807#

beta_max: float | None = None#: maximum value of inverse temperature

beta_min: float | None = None#: minimal value of inverse temperature

initial_state: list | dict | None = None#: initial state (parameter only used if problem is QUBO)

num_reads: int | None = None#: number of reads

num_sweeps: int | None = None#: number of sweeps

ommx_instance: Instance#: Isolated copy of the exact Adapter input used to evaluate returned samples.

reinitialize_state: bool | None = None#: if true reinitialize state for each run (parameter only used if problem is QUBO)

property sampler_input: dict[tuple[int, ...], float]#

schedule: list | None = None#: list of inverse temperature (parameter only used if problem is QUBO)

seed: int | None = None#: seed for Monte Carlo algorithm

property solver_input: dict[tuple[int, ...], float]#: Expose sampler_input through the SolverAdapter interface.

sparse: bool | None = None#: use sparse matrix or not (parameter only used if problem is QUBO)

updater: str | None = None#: updater algorithm