pub struct RefinementLimits { /* private fields */ }Expand description
Hard upper bounds independent of convergence criteria.
Implementations§
Source§impl RefinementLimits
impl RefinementLimits
Sourcepub fn new(
max_iterations: usize,
max_evaluations: usize,
max_runtime_seconds: Option<f64>,
max_consecutive_rejections: usize,
) -> Result<Self, RuntimeError>
pub fn new( max_iterations: usize, max_evaluations: usize, max_runtime_seconds: Option<f64>, max_consecutive_rejections: usize, ) -> Result<Self, RuntimeError>
Validate strictly positive counters and optional positive finite time.
§Errors
Returns RuntimeError::InvalidLimits for zero counters or invalid time.
Sourcepub const fn max_iterations(self) -> usize
pub const fn max_iterations(self) -> usize
Return the attempted-iteration ceiling.
Sourcepub const fn max_evaluations(self) -> usize
pub const fn max_evaluations(self) -> usize
Return the model-evaluation ceiling.
Sourcepub const fn max_runtime_seconds(self) -> Option<f64>
pub const fn max_runtime_seconds(self) -> Option<f64>
Return the optional elapsed-time ceiling.
Sourcepub const fn max_consecutive_rejections(self) -> usize
pub const fn max_consecutive_rejections(self) -> usize
Return the consecutive-rejection ceiling.
Trait Implementations§
Source§impl Clone for RefinementLimits
impl Clone for RefinementLimits
Source§fn clone(&self) -> RefinementLimits
fn clone(&self) -> RefinementLimits
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 moreimpl Copy for RefinementLimits
Source§impl Debug for RefinementLimits
impl Debug for RefinementLimits
Source§impl Default for RefinementLimits
impl Default for RefinementLimits
Source§impl PartialEq for RefinementLimits
impl PartialEq for RefinementLimits
impl StructuralPartialEq for RefinementLimits
Auto Trait Implementations§
impl Freeze for RefinementLimits
impl RefUnwindSafe for RefinementLimits
impl Send for RefinementLimits
impl Sync for RefinementLimits
impl Unpin for RefinementLimits
impl UnsafeUnpin for RefinementLimits
impl UnwindSafe for RefinementLimits
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
impl<T> Scalar 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.