Public API

QUBODecomposition.Optimizer — Type
Optimizer(; child_optimizer=nothing, max_variables=nothing, kwargs...)

A composite sampler with serial defaults, whole-model dispatch for fitting inputs, independent-component solves and bounded conditioned neighborhood sweeps. The default strategy is :components_then_sweeps; :components rejects oversized components and :whole_model rejects oversized nonconstant inputs. Opt into exhaustive conditioning with strategy=:separator, separator=[...] in original free-variable indices, or separator=:articulation for automatic single-articulation discovery, and max_separator_size=8 (hard ceiling 16). Neighborhood selection defaults to :strongest_edge; opt into state-aware blocks with :single_flip_gain, multi-hop neighborhoods with :bfs, or seeded permutation blocks with :random_blocks via the selection option. Use selection=:partition with partition_plan as an owned vector of blocks or a callback (indices, adjacency, max_variables) -> blocks. Use strategy=:frozen_batch with selection=:strongest_edge or :bfs, batch_size=8 (1:64) and repair=true for transactional unweighted voting. Use strategy=:sample_fixing with an explicit labelled sample_pool for bounded unary majority fixing and original-space incumbent retention; see the sample-fixing manual. Use strategy=:coarse with coarse_groups=[[1,2],[3,4]] for one bounded block-orientation proposal from the frozen complete incumbent. Use strategy=:consensus with consensus_plan=[[1,2],[2,3]] for bounded serial overlapping-block Lagrangian coordination; see the consensus manual. Use component_executor=SequentialComponentExecutor() or ProcessComponentExecutor(pool; max_inflight=2) with strategy=:components for the frozen independent-component job path, bypassing the whole-model shortcut. Use preprocessing=:dominance for opt-in root certification with QUBOPreprocessing. It supports the serial whole-model/components/sweeps routes with automatic selection; explicit index plans and advanced strategies require separate mappings. max_work bounds structural passes plus declared child reservations, separately from candidate and call caps; see the certified root preprocessing manual. The zero-argument constructor permits configuration with raw MOI attributes. See the package manual's Construction and configuration, Results and statuses, and Budgets, timing, seeds and reads pages for validation and metadata contracts.

source
QUBODecomposition.ComponentJob — Type
ComponentJob

Owned immutable input to a component child factory. id is (solve_token, invocation, component); indices and labels map reduced positions to original free variables. problem contains immutable normalized coefficients, domain, sense, scale and conditioned offset. reference is the frozen component start. seed, absolute local-host monotonic deadline, child_time_limit_sec, and candidate_limit are generic limits. Factories may accept this job or no arguments. Do not transport an optimizer or a shared mutable observer in a factory closure.

source
QUBODecomposition.ComponentResult — Type
ComponentResult(id, status, reported_results, rows, diagnostics)

Owned child output. Each row is (state=tuple, energy=reported_energy, primal_status=MOI.FEASIBLE_POINT, multiplicity=nothing_or_count). The coordinator validates the identity, complete scan and all rows, reconstructs only the owning component and independently evaluates the full original objective. diagnostics is a NamedTuple with execution_sec and may include executor-specific fields.

source
QUBODecomposition.AbstractComponentExecutor — Type
AbstractComponentExecutor

Independent-component executor protocol: implement executor_width(executor) and submit_component(executor, factory, job). Submission returns a handle with isready(handle) and fetch(handle) producing exactly one ComponentResult or throwing an execution error. Submission must return promptly and dispatch at most one job. Handles must remain fetchable for draining after a stop. Executors must isolate mutable child state, preserve job identity and never retry implicitly.

source
QUBODecomposition.ProcessComponentExecutor — Type
ProcessComponentExecutor(pool::Distributed.WorkerPool; max_inflight=length(workers(pool)))

Use an explicitly supplied caller-owned local-host worker pool. Initialize the package and factory definitions on each worker before solving. One optimizer is constructed on its worker per job; no workers are created or terminated. A pool must be dedicated to these solves (do not concurrently use the same executor or pool). The coordinator drains submitted jobs on every exit, returning workers to the pool; opaque child calls can overrun the cooperative deadline during draining.

source
QUBODecomposition.submit_component — Function
submit_component(executor, factory, job)

Submit one reserved component job and return a fetchable handle. Custom executors can use the supported job context to configure allocation and attach diagnostics.

source
QUBODecomposition.execute_component — Function
execute_component(factory, job::ComponentJob) -> ComponentResult

Construct, copy, configure and execute an isolated child where called, extracting bounded owned rows. This worker-side boundary does not accept incumbents or certify global results. Parent deadlines are cooperative and require a shared local-host monotonic clock; distributed hosts are outside the supported executor.

source

Released interface entry points

The composite implements the released interfaces below. Configuration and detailed semantics have one authoritative source in this manual.

InterfaceUseContract
MOI.RawOptimizerAttribute(name)Read/set constructor options by their string namesConfiguration
MOI.copy_to, MOI.optimize!, MOI.empty!Copy a model, solve, clear itResults
MOI.TerminationStatus, MOI.PrimalStatus, MOI.ResultCountRead truthful completion and result availabilityResults
MOI.ObjectiveValue, MOI.VariablePrimalRead original compiled energy and copied-model primalsResults
MOI.TimeLimitSec, MOI.SolveTimeSecSet invocation allowance; read effective elapsed timeBudgets
QUBODrivers.set_model!, QUBOTools.backend, QUBOTools.state, QUBOTools.solutionDirect labeled QUBOTools model/resultsConfiguration
QUBODrivers.RandomSeed, FinalNumberOfReads, PostSampleCallback, PostSampleTransformReleased sampler attributes (last three qualified by QUBODrivers)Results, reads/seeds
QUBOTools.metadata(QUBOTools.solution(opt))Read decomposition schema version 1 and framework metadataBudgets

ModelStorage and internal clocks/checkpoints are implementation details. The runtime exposes no additional global-optimality certificate for coupled sweeps.