Skip to main content

Wolff

Struct Wolff 

Source
pub struct Wolff { /* private fields */ }
Expand description

Wolff single-cluster sampler.

Precomputes a per-site neighbour table from the geometry so the flood-fill can enumerate neighbours in O(degree) without re-deriving lattice indices.

Implementations§

Source§

impl Wolff

Source

pub fn new(cfg: WolffConfig) -> Self

Build a sampler from a validated configuration.

Source

pub fn square( rows: usize, cols: usize, coupling: f64, periodic: bool, ) -> SeqResult<Self>

Convenience constructor for a square lattice.

Source

pub fn from_graph(adjacency: Vec<Vec<usize>>, coupling: f64) -> SeqResult<Self>

Convenience constructor for a general graph.

Source

pub fn n_sites(&self) -> usize

Number of sites in the lattice / graph.

Source

pub fn last_cluster_size(&self) -> usize

Size of the cluster flipped on the most recent Wolff::step.

Source

pub fn bond_probability(&self, beta: f64) -> f64

Bond / addition probability p = 1 − exp(−2 β J). See super::swendsen_wang::SwendsenWang::bond_probability for the clamping rationale.

Source

pub fn step( &mut self, spins: &mut [i8], beta: f64, rng: &mut LcgRng, ) -> SeqResult<()>

Perform one Wolff single-cluster update in place.

Seeds at a uniformly random site, grows the aligned cluster by stack flood-fill (each aligned neighbour joins with probability p = 1 − exp(−2 β J)), then flips the whole cluster.

§Errors

SeqError::ShapeMismatch on a site-count mismatch, SeqError::InvalidParameter for non-finite beta or non-±1 spins.

Source

pub fn magnetization(&self, spins: &[i8]) -> SeqResult<f64>

Mean magnetisation (1/N) Σ s_i ∈ [−1, +1].

§Errors

SeqError::ShapeMismatch on a site-count mismatch.

Source

pub fn energy(&self, spins: &[i8]) -> SeqResult<f64>

Total Ising energy E = −J Σ_(i,j) s_i s_j over the geometry’s edges (no external field). Each undirected edge is counted once.

§Errors

SeqError::ShapeMismatch on a site-count mismatch.

Trait Implementations§

Source§

impl Clone for Wolff

Source§

fn clone(&self) -> Wolff

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Wolff

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Wolff

§

impl RefUnwindSafe for Wolff

§

impl Send for Wolff

§

impl Sync for Wolff

§

impl Unpin for Wolff

§

impl UnsafeUnpin for Wolff

§

impl UnwindSafe for Wolff

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.