QUBODrivers.jl Documentation
Introduction
QUBODrivers.jl provides a common MathOptInterface-compatible API for QUBO samplers and annealing backends.
The package includes:
- utility samplers for exact enumeration, random sampling, warm-start identity sampling, and MIP-backed baseline solving;
- a macro for declaring sampler optimizers and user-facing attributes;
- MOI and QUBOTools plumbing for model conversion and result access;
- a reusable test suite for sampler implementations.
If you want to solve a model, start with Solving QUBO. If you want to implement a new sampler wrapper, start with Sampler Setup and Implementing a Sampler.
Quick Start
Installation
QUBODrivers.jl is registered in Julia's General Registry and is available for download using the standard package manager.
julia> import Pkg
julia> Pkg.add("QUBODrivers")Example
using JuMP
using QUBODrivers
model = Model(ExactSampler.Optimizer)
Q = [
-1.0 2.0 2.0
2.0 -1.0 2.0
2.0 2.0 -1.0
]
@variable(model, x[1:3], Bin)
@objective(model, Min, x' * Q * x)
optimize!(model)
for i = 1:result_count(model)
xi = value.(x; result=i)
yi = objective_value(model; result=i)
println("f($xi) = $yi")
endf([1.0, 0.0, 0.0]) = -1.0
f([0.0, 1.0, 0.0]) = -1.0
f([0.0, 0.0, 1.0]) = -1.0
f([0.0, 0.0, 0.0]) = 0.0
f([1.0, 0.0, 1.0]) = 2.0
f([0.0, 1.0, 1.0]) = 2.0
f([1.0, 1.0, 0.0]) = 2.0
f([1.0, 1.0, 1.0]) = 9.0Citing QUBODrivers.jl
<!– citation-policy:start –> For general use of QUBODrivers.jl and the broader QUBO.jl ecosystem, cite the published journal article. The earlier arXiv preprint remains available, but the journal article is the version of record.
For a direct software citation, use the Zenodo concept DOI. The concept DOI is the evergreen identifier for QUBODrivers.jl, resolves to the latest archived release, and is the DOI recorded in CITATION.cff. When reproducibility requires an exact release, cite the matching Zenodo version DOI instead; the archive for v0.6.8 is 10.5281/zenodo.23648751.
The BibTeX entries below cite the ecosystem article and the v0.6.8 software archive. Replace the @software entry's doi and url with the concept DOI when an evergreen software citation is preferred:
@article{xavier2026qubojl,
author = {Maciel Xavier, Pedro and Ripper, Pedro and Andrade, Tiago and Dias Garcia, Joaquim and Maculan, Nelson and Bernal Neira, David E.},
title = {{QUBO.jl: a Julia ecosystem for quadratic unconstrained binary optimization}},
journal = {Optimization Methods and Software},
year = {2026},
pages = {1--24},
doi = {10.1080/10556788.2026.2702926},
url = {https://doi.org/10.1080/10556788.2026.2702926}
}
@software{qubodrivers:2026,
author = {Maciel Xavier, Pedro and Ripper, Pedro and Andrade, Tiago and Dias Garcia, Joaquim and Bernal Neira, David E.},
title = {{QUBODrivers.jl}},
year = {2026},
publisher = {Zenodo},
version = {v0.6.8},
doi = {10.5281/zenodo.23648751},
url = {https://doi.org/10.5281/zenodo.23648751},
note = {Evergreen concept DOI: 10.5281/zenodo.7811951}
}Machine-readable metadata is in CITATION.cff, with BibTeX in CITATION.bib. <!– citation-policy:end –>