pub struct HybridMonteCarlo<State, Rng, I, const D: usize>where
    State: LatticeState<D> + Clone + ?Sized,
    LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>,
    I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D>,
    Rng: Rng,{ /* private fields */ }
Expand description

Hybrid Monte Carlo algorithm (HCM for short).

The idea of HCM is to generate a random set on conjugate momenta to the link matrices. This conjugated momenta is also refed as the “Electric” field or e_field with distribution N(0, 1 / beta). And to solve the equation of motion. The new state is accepted with probability Exp( -H_old + H_new) where the Hamiltonian has an extra term Tr(E_i ^ 2). The advantage is that the simulation can be done in a symplectic way i.e. it conserved the Hamiltonian. Which means that the method has a high acceptance rate.

Example

See the the level module documentation.

Implementations§

source§

impl<State, Rng, I, const D: usize> HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D>, Rng: Rng,

source

pub const fn rng(&self) -> &Rng

Get a ref to the rng.

source

pub const fn integrator(&self) -> &I

Get the integrator.

source

pub fn integrator_mut(&mut self) -> &mut I

Get a mut ref to the integrator.

source

pub const fn delta_t(&self) -> Real

Get delta_t.

source

pub const fn number_of_steps(&self) -> usize

Get the number of steps.

source

pub const fn new( delta_t: Real, number_of_steps: usize, integrator: I, rng: Rng ) -> Self

gives the following parameter for the HCM :

  • delta_t is the step size per integration of the equation of motion
  • number_of_steps is the number of time
  • integrator is the methods to solve the equation of motion
  • rng, a random number generator
source

pub fn rng_mut(&mut self) -> &mut Rng

Get a mutable reference to the rng.

source

pub fn rng_owned(self) -> Rng

Get the last probably of acceptance of the random change.

Trait Implementations§

source§

impl<State, Rng, I, const D: usize> AsMut<Rng> for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D>, Rng: Rng,

source§

fn as_mut(&mut self) -> &mut Rng

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl<State, Rng, I, const D: usize> AsRef<Rng> for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D>, Rng: Rng,

source§

fn as_ref(&self) -> &Rng

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl<State, Rng, I, const D: usize> Clone for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized + Clone, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D> + Clone, Rng: Rng + Clone,

source§

fn clone(&self) -> HybridMonteCarlo<State, Rng, I, D>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<State, Rng, I, const D: usize> Debug for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized + Debug, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D> + Debug, Rng: Rng + Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de, State, Rng, I, const D: usize> Deserialize<'de> for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized + Deserialize<'de>, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D> + Deserialize<'de>, Rng: Rng + Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<State, Rng, I, const D: usize> MonteCarlo<State, D> for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D>, Rng: Rng,

§

type Error = MultiIntegrationError<<I as SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D>>::Error>

Error returned while getting the next element.
source§

fn next_element(&mut self, state: State) -> Result<State, Self::Error>

Do one Monte Carlo simulation step. Read more
source§

impl<State, Rng, I, const D: usize> PartialEq<HybridMonteCarlo<State, Rng, I, D>> for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized + PartialEq, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D> + PartialEq, Rng: Rng + PartialEq,

source§

fn eq(&self, other: &HybridMonteCarlo<State, Rng, I, D>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<State, Rng, I, const D: usize> Serialize for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized + Serialize, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D> + Serialize, Rng: Rng + Serialize,

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<State, Rng, I, const D: usize> StructuralPartialEq for HybridMonteCarlo<State, Rng, I, D>where State: LatticeState<D> + Clone + ?Sized, LatticeStateEFSyncDefault<State, D>: SimulationStateSynchronous<D>, I: SymplecticIntegrator<LatticeStateEFSyncDefault<State, D>, SimulationStateLeap<LatticeStateEFSyncDefault<State, D>, D>, D>, Rng: Rng,

Auto Trait Implementations§

§

impl<State, Rng, I, const D: usize> RefUnwindSafe for HybridMonteCarlo<State, Rng, I, D>where I: RefUnwindSafe, Rng: RefUnwindSafe, State: RefUnwindSafe,

§

impl<State, Rng, I, const D: usize> Send for HybridMonteCarlo<State, Rng, I, D>where I: Send, Rng: Send, State: Send,

§

impl<State, Rng, I, const D: usize> Sync for HybridMonteCarlo<State, Rng, I, D>where I: Sync, Rng: Sync, State: Sync,

§

impl<State, Rng, I, const D: usize> Unpin for HybridMonteCarlo<State, Rng, I, D>where I: Unpin, Rng: Unpin, State: Unpin,

§

impl<State, Rng, I, const D: usize> UnwindSafe for HybridMonteCarlo<State, Rng, I, D>where I: UnwindSafe, Rng: UnwindSafe, State: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

source§

impl<T> Scalar for Twhere T: 'static + Clone + PartialEq<T> + Debug,