pub struct Machine<H, I, S>{ /* private fields */ }Expand description
A box containing the sample with a given temperature and field.
Implementations§
Source§impl<H, I, S> Machine<H, I, S>
impl<H, I, S> Machine<H, I, S>
Sourcepub fn new(
thermostat: Thermostat<S>,
hamiltonian: H,
integrator: I,
instruments: Vec<Box<dyn Instrument<H, S>>>,
state: State<S>,
) -> Self
pub fn new( thermostat: Thermostat<S>, hamiltonian: H, integrator: I, instruments: Vec<Box<dyn Instrument<H, S>>>, state: State<S>, ) -> Self
Create a new machine with a given temperature, field, hamiltonian,
Sourcepub fn thermostat(&self) -> &Thermostat<S>
pub fn thermostat(&self) -> &Thermostat<S>
Get the current thermostat of the machine.
Sourcepub fn set_thermostat(&mut self, thermostat: Thermostat<S>)
pub fn set_thermostat(&mut self, thermostat: Thermostat<S>)
Set the thermostat of the machine.
Sourcepub fn relax_for<R: Rng>(
&mut self,
rng: &mut R,
steps: usize,
) -> MachineResult<()>
pub fn relax_for<R: Rng>( &mut self, rng: &mut R, steps: usize, ) -> MachineResult<()>
Relax the machine for a given number of steps.
Sourcepub fn measure_for<R: Rng>(
&mut self,
rng: &mut R,
steps: usize,
) -> MachineResult<()>
pub fn measure_for<R: Rng>( &mut self, rng: &mut R, steps: usize, ) -> MachineResult<()>
Measure the machine for a given number of steps.
Auto Trait Implementations§
impl<H, I, S> Freeze for Machine<H, I, S>
impl<H, I, S> !RefUnwindSafe for Machine<H, I, S>
impl<H, I, S> !Send for Machine<H, I, S>
impl<H, I, S> !Sync for Machine<H, I, S>
impl<H, I, S> Unpin for Machine<H, I, S>
impl<H, I, S> !UnwindSafe for Machine<H, I, S>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.