pub struct MCMCTerminator(/* private fields */);Expand description
A Terminator which can be used to monitor the progress of an MCMC algorithm.
This should be paired with a Python object which has an check_for_termination method
that takes the current step and a ganesh.EnsembleStatus object and returns a
PyControlFlow.
Trait Implementations§
Source§impl Clone for MCMCTerminator
impl Clone for MCMCTerminator
Source§fn clone(&self) -> MCMCTerminator
fn clone(&self) -> MCMCTerminator
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<'a, 'py> FromPyObject<'a, 'py> for MCMCTerminator
impl<'a, 'py> FromPyObject<'a, 'py> for MCMCTerminator
Source§impl<A, P, C> Terminator<A, P, EnsembleStatus, MaybeThreadPool, LadduError, C> for MCMCTerminator
impl<A, P, C> Terminator<A, P, EnsembleStatus, MaybeThreadPool, LadduError, C> for MCMCTerminator
Source§fn check_for_termination(
&mut self,
current_step: usize,
_algorithm: &mut A,
_problem: &P,
status: &mut EnsembleStatus,
_args: &MaybeThreadPool,
_config: &C,
) -> ControlFlow<()>
fn check_for_termination( &mut self, current_step: usize, _algorithm: &mut A, _problem: &P, status: &mut EnsembleStatus, _args: &MaybeThreadPool, _config: &C, ) -> ControlFlow<()>
A termination check which is called on each step of an
Algorithm.Auto Trait Implementations§
impl Freeze for MCMCTerminator
impl !RefUnwindSafe for MCMCTerminator
impl Send for MCMCTerminator
impl Sync for MCMCTerminator
impl Unpin for MCMCTerminator
impl UnsafeUnpin for MCMCTerminator
impl !UnwindSafe for MCMCTerminator
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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§fn to_subset_unchecked(&self) -> SS
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.