A new Sampler

This guide aims to provide a tutorial on how to implement new sampler interfaces using Anneal.jl.

The @anew macro

Using the Anneal.@anew macro is the most straightforward way to get your sampler running right now. Apart from the macro call it is needed to implement the Anneal.sample method.

I. Imports

First of all, we are going to import both Anneal.jl and also MathOptInterface.jl, commonly aliased as MOI.

import Anneal
import MathOptInterface
const MOI = MathOptInterface

II. @anew

This macro takes two arguments: the identifier of the sampler's struct, and a begin...end block containing configuration parameters as key-value pairs. If ommited, the first defaults to Optimizer, following regular MOI conventions. In order to work smoothly, this approach leverages the QUBOTools backend.

We expect that most users will be happy with this approach and it is likely that it will be improved and receive support very often.

MathOptInterface API Coverage

This Document is intended to help keeping track of which MOI API Methods and Properties have been implemented for a new solver or model interface.

Reference:

jump.dev/MathOptInterface.jl/stable/tutorials/implementing/

Optimizer Interface

The copy_to interface

Constraint Support

Attributes

Solution

Warm Start

Key