Struct lattice_qcd_rs::simulation::monte_carlo::McWrapper

pub struct McWrapper<MCD, State, Rng, const D: usize>where
    MCD: MonteCarloDefault<State, D>,
    State: LatticeState<D>,
    Rng: Rng,{ /* private fields */ }

A wrapper used to implement MonteCarlo from a MonteCarloDefault

Example

use lattice_qcd_rs::error::ImplementationError;
use lattice_qcd_rs::simulation::{
    LatticeState, LatticeStateDefault, McWrapper, MetropolisHastingsDiagnostic, MonteCarlo,
};
use rand::SeedableRng;

let rng = rand::rngs::StdRng::seed_from_u64(0); // change with your seed
let mh = MetropolisHastingsDiagnostic::new(1, 0.1_f64)
    .ok_or(ImplementationError::OptionWithUnexpectedNone)?;
let mut wrapper = McWrapper::new(mh, rng);

// Realistically you want more steps than 10

let mut state = LatticeStateDefault::<3>::new_cold(1_f64, 6_f64, 4)?;
for _ in 0..100 {
    state = state.monte_carlo_step(&mut wrapper)?;
    println!(
        "probability of acceptance during last step {}, does it accepted the change ? {}",
        mh.prob_replace_last(),
        mh.has_replace_last()
    );
    // or state.monte_carlo_step(&mut wrapper)?;
    // operation to track the progress or the evolution
}
// operation at the end of the simulation
let (_, rng) = wrapper.deconstruct(); // get the rng back

Implementations

impl<MCD, State, Rng, const D: usize> McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D>, State: LatticeState<D>, Rng: Rng,

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

Get a ref to the rng.

pub const fn new(mcd: MCD, rng: Rng) -> Self

Create the wrapper.

pub fn deconstruct(self) -> (MCD, Rng)

deconstruct the structure to get back the rng if necessary

pub const fn mcd(&self) -> &MCD

Get a reference to the MonteCarloDefault inside the wrapper.

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

Get a mutable reference to the rng

Trait Implementations

impl<MCD, State, Rng, const D: usize> AsMut<Rng> for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D>, State: LatticeState<D>, Rng: Rng,

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

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

impl<MCD, State, Rng, const D: usize> AsRef<Rng> for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D>, State: LatticeState<D>, Rng: Rng,

fn as_ref(&self) -> &Rng

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

impl<MCD, State, Rng, const D: usize> Clone for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Clone, State: LatticeState<D> + Clone, Rng: Rng + Clone,

fn clone(&self) -> McWrapper<MCD, State, Rng, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<MCD, State, Rng, const D: usize> Debug for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Debug, State: LatticeState<D> + Debug, Rng: Rng + Debug,

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

Formats the value using the given formatter.

impl<MCD, State, Rng, const D: usize> Default for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Default, State: LatticeState<D>, Rng: Rng + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, MCD, State, Rng, const D: usize> Deserialize<'de> for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Deserialize<'de>, State: LatticeState<D>, Rng: Rng + Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<MCD, State, Rng, const D: usize> Display for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Display, State: LatticeState<D>, Rng: Rng + Display,

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

Formats the value using the given formatter.

impl<MCD, State, Rng, const D: usize> Hash for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Hash, State: LatticeState<D> + Hash, Rng: Rng + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, State, Rng, const D: usize> MonteCarlo<State, D> for McWrapper<T, State, Rng, D>where T: MonteCarloDefault<State, D>, State: LatticeState<D>, Rng: Rng,

type Error = <T as MonteCarloDefault<State, D>>::Error

Error returned while getting the next element.

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

Do one Monte Carlo simulation step.

impl<MCD, State, Rng, const D: usize> PartialEq<McWrapper<MCD, State, Rng, D>> for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + PartialEq, State: LatticeState<D> + PartialEq, Rng: Rng + PartialEq,

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

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

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.

impl<MCD, State, Rng, const D: usize> Serialize for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Serialize, State: LatticeState<D>, Rng: Rng + Serialize,

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

Serialize this value into the given Serde serializer.

impl<MCD, State, Rng, const D: usize> Eq for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D> + Eq, State: LatticeState<D> + Eq, Rng: Rng + Eq,

impl<MCD, State, Rng, const D: usize> StructuralEq for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D>, State: LatticeState<D>, Rng: Rng,

impl<MCD, State, Rng, const D: usize> StructuralPartialEq for McWrapper<MCD, State, Rng, D>where MCD: MonteCarloDefault<State, D>, State: LatticeState<D>, Rng: Rng,