pub struct RietveldStage { /* private fields */ }Expand description
One caller-visible active parameter set and acceptance policy.
Implementations§
Source§impl RietveldStage
impl RietveldStage
Sourcepub fn new(
name: impl Into<String>,
selection: RietveldParameterSelection,
rationale: Vec<String>,
) -> Result<Self, RietveldRecipeError>
pub fn new( name: impl Into<String>, selection: RietveldParameterSelection, rationale: Vec<String>, ) -> Result<Self, RietveldRecipeError>
Construct one stage with the default converged-or-stagnated policy.
§Errors
Returns RietveldRecipeError for an invalid name or rationale.
Sourcepub fn with_options(
self,
options: RietveldRefinementOptions,
covariance: RietveldCovarianceOptions,
) -> Self
pub fn with_options( self, options: RietveldRefinementOptions, covariance: RietveldCovarianceOptions, ) -> Self
Attach stage-specific numerical and covariance controls.
Sourcepub fn with_accepted_terminations(
self,
accepted: Vec<TerminationReason>,
) -> Result<Self, RietveldRecipeError>
pub fn with_accepted_terminations( self, accepted: Vec<TerminationReason>, ) -> Result<Self, RietveldRecipeError>
Replace the accepted normal termination categories.
§Errors
Returns RietveldRecipeError::InvalidAcceptedTerminations for an
empty or duplicate policy.
Sourcepub const fn selection(&self) -> &RietveldParameterSelection
pub const fn selection(&self) -> &RietveldParameterSelection
Borrow the cumulative active selection.
Sourcepub const fn options(&self) -> Option<&RietveldRefinementOptions>
pub const fn options(&self) -> Option<&RietveldRefinementOptions>
Borrow stage-specific solver controls, when supplied.
Sourcepub const fn covariance(&self) -> Option<RietveldCovarianceOptions>
pub const fn covariance(&self) -> Option<RietveldCovarianceOptions>
Return stage-specific covariance controls, when supplied.
Sourcepub fn accepted_terminations(&self) -> &[TerminationReason]
pub fn accepted_terminations(&self) -> &[TerminationReason]
Borrow normal termination categories accepted for state promotion.
Trait Implementations§
Source§impl Clone for RietveldStage
impl Clone for RietveldStage
Source§fn clone(&self) -> RietveldStage
fn clone(&self) -> RietveldStage
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 Debug for RietveldStage
impl Debug for RietveldStage
Source§impl PartialEq for RietveldStage
impl PartialEq for RietveldStage
impl StructuralPartialEq for RietveldStage
Auto Trait Implementations§
impl !RefUnwindSafe for RietveldStage
impl !UnwindSafe for RietveldStage
impl Freeze for RietveldStage
impl Send for RietveldStage
impl Sync for RietveldStage
impl Unpin for RietveldStage
impl UnsafeUnpin for RietveldStage
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.