anneal anneal anneal
    • eindir Typed primitives for ND objectives and sampling (used by anneal)
    • rgpycrumbs Chemical physics utilities and visualization
/

Getting started

  • Quickstart
  • Classical Presets
  • Cluster Search
  • Bayesian Pilot and Mixer
  • GLE Colored-Noise Langevin
  • Prerequisites
  • Step 1: Define obj + grad
  • Step 2: Call gle_langevin (the exposed driver)
  • Step 3: The thermostat inside (what the algebra buys)
  • Why this works
  • Polish, Device, and Scale

How-to Guides

  • Installation
  • Decision Tree
  • Three Channels
  • How do I pick between the presets?
  • What is the Bayesian mixer and when does it help?
  • Do I need to supply a gradient?
  • Precision and float16/float32 policy?
  • Reproducibility guarantees?
  • FAQ

Explanation

  • Architecture
  • The five components (signatures)
  • The four laws (plain English)
  • Reuse table (the concrete payoff)
  • How every advanced driver is still just the algebra
  • Bayesian Pilot and Mixer Details
  • GLE Mechanics

Reference

  • Specification
  • Rust API Reference
  • 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 integrator
        • mod momentum
        • mod nuts
        • mod sampler
      • mod lattice
      • mod laws
      • mod localkey
      • mod methods
        • mod activation
        • mod archive_search
        • mod bank
        • mod cluster_hopping
        • mod cluster_search
        • mod committor_pop
        • mod csa_cluster
        • mod ffs
        • mod minima_hopping
        • mod nested
        • mod splice
        • mod additive_independence
        • mod amsa
        • mod bayesian_mixing
        • mod bayesian_pilot
        • mod bfwt
        • mod dmc_population
        • mod gle_langevin
        • mod gpmd
        • mod local_polish
        • mod mcmc_sa
        • mod parallel_tempering
        • mod portfolio
        • mod regime
        • mod routing_probe
        • mod sketchmap
        • mod tpe
        • mod tps_shoot
        • mod warm_lbfgs
      • 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
  • Glossary
  • Classical (values only)
  • Pilot and low-discrepancy
  • Polish
  • Advanced drivers
  • Device and ensemble (same kernel)
  • Hamiltonian Monte Carlo (HMC) / quasi-Monte Carlo (QMC) variants (also exposed)
  • Bindings
  • Device backend, ensembles, and noise-aware acceptance
  • Changelog
  • Used By

Development

  • Contributing
  • Best Practices for anneal
  • Code of Conduct

On this page

  • fn archive_search
  • struct Archive
    • catalog
    • floors
    • residual
    • drop
    • reps
    • key_reps
    • key_floor
    • pending_floors
    • pending_residual
    • impl Archive
      • fn new
    • impl Default for Archive
  • struct ArchiveOutcome
    • best
    • best_state
    • screens
    • full
    • returned
    • same_floor
    • floors
    • events
    • artn
    • charged
    • best_at
HaoZeke/anneal 0 0
Edit this page
  1. anneal /
  2. Rust API Reference /
  3. Crate anneal_core /
  4. mod methods /
  5. mod archive_search
View Source Open in ChatGPT Open in Claude

mod archive_search¶

module archive_search¶

Residual archive search: local events, floors, cheap novelty loop. Residual archive search: explore, then spend what the fingerprints owe.

This is not Config::recommended. That preset keeps its measured rates. Large-budget ras records local-topology keys and energy classes on the explore hop. Leftover evaluations go to residual-field holes (new draws that can open a class) and to unsaturated keys on non-incumbent floors, not to another polish of the incumbent key. Small-budget molecular and slab walks stay on their own branch.

Functions

fn archive_search<'g, R: Rng + ?Sized>(cfg: &Config, start: ArrayView1<f64>, ledger: &mut Ledger, relax: Relax<'_>, mut grad: Option<&mut GradFn<'g>>, archive: &mut Archive, rng: &mut R) -> ArchiveOutcome¶

One worker on a shared Archive, until the ledger is empty.

Large-budget: skip-return explore, then residual hops on unsaturated local keys. The caller’s recommended defaults are not written.

Structs and Unions

struct Archive¶

Shared catalogue, floors, residual field, and pending locks.

catalog: Catalog¶

Local-topology events.

floors: FloorBook¶

Energy classes.

residual: ResidualField¶

GMRF residual on the class graph.

drop: DropModel¶

Remaining-drop model.

reps: Vec<Array1<f64>>¶

One representative structure per floor.

key_reps: HashMap<u64, Array1<f64>>¶

First structure that exhibited each local key.

key_floor: HashMap<u64, usize>¶

Energy class on which each local key was first seen.

pending_floors: HashSet<usize>¶

Floor currently being fully quenched.

pending_residual: bool¶

Whether a residual full quench is in flight.

Implementations

impl Archive¶

Functions

fn new() -> Self¶

Empty shared state.

Traits implemented

impl Default for Archive¶
struct ArchiveOutcome¶

What one archive run produced.

best: f64¶

Lowest quenched energy.

best_state: Option<Array1<f64>>¶

Structure attaining it.

screens: usize¶

Screen passes paid.

full: usize¶

Full quenches paid.

returned: usize¶

Screens discarded as returning to the incumbent attractor.

same_floor: usize¶

Screens discarded as a saturated floor.

floors: usize¶

Distinct energy classes at the end.

events: usize¶

Distinct local-topology events at the end.

artn: usize¶

ARTn / stall-symmetry escapes attempted.

charged: usize¶

Charged evaluations spent (copied from the ledger).

best_at: usize¶

Ledger spend when best last improved.

Previous
mod activation
Next
mod bank

2026--present, anneal developers

Made with Sphinx and Shibuya theme.