Rust API Reference

The anneal-core crate provides the typed sampler components, preset drivers, Bayesian pilot and mixer machinery, GLE-Langevin moves, surrogate independence proposals, local polish helpers, and the Rust surfaces behind the Python and C bindings.

The API documentation below is generated from the crate source through sphinxcontrib_rust and sphinx-rustdoc-postprocess, then linked into this site under the same reference tree as the user-facing parameter tables.

See also:

• Presets and Advanced Drivers for the stable user-facing driver surface.

• Architecture for the five component signatures and L1-L4 laws.

• eindir documentation for the Objective, low-discrepancy, GLE, and surrogate layer used by these drivers.

Rust API (anneal-core)

• Crate anneal_core
  • mod accept
  • mod adapter
  • mod allocate
  • mod bias
  • mod calibrate
  • mod catalog
  • mod construct
  • mod contextual
  • mod cool
  • mod curvature
  • mod delayed
  • mod diversity
  • mod dos
  • mod error
  • mod exchange
  • mod floors
  • mod free_energy
  • mod funnel_bo
  • mod funnel_spectral
  • mod grad
  • mod graphkey
  • mod history
  • mod hmc
  • mod lattice
  • mod laws
  • mod localkey
  • mod methods
  • mod model_hessian
  • mod movekernel
  • mod neigh
  • mod neighbors
  • mod noise_accept
  • mod path
  • mod potentials
  • mod quench
  • mod residual_field
  • mod runner
  • mod sampler
  • mod screen
  • mod ace
  • mod soap
  • mod spectral
  • mod structure
  • mod symmetrise
  • mod terminate
  • mod twin
  • mod types
  • mod variant
  • mod version
  • mod ffi
  • mod shape
  • mod python