Struct JointRietveldCheckpoint

Source

pub struct JointRietveldCheckpoint {
    pub request: Vec<JointRietveldHistogram>,
    pub histograms: Vec<JointRietveldHistogram>,
    pub constraints: Vec<Constraint>,
    pub parameters: ParameterSet,
    pub objective: f64,
    pub damping: f64,
    pub history: Vec<JointRietveldIterationRecord>,
}

Expand description

Complete accepted state for deterministic joint continuation.

Fields§

§request: Vec<JointRietveldHistogram>

Exact original request contract.

§histograms: Vec<JointRietveldHistogram>

Last accepted joint histogram state.

§constraints: Vec<Constraint>

Ordered constraint graph.

§parameters: ParameterSet

Last accepted joint physical parameters.

§objective: f64

Last accepted joint objective.

§damping: f64

Damping for the next attempted iteration.

§history: Vec<JointRietveldIterationRecord>

Complete accepted history.

Implementations§

Source §

impl JointRietveldCheckpoint

Source

pub fn completed_iterations(&self) -> usize

Return the number of accepted iterations.

Source

pub fn validate_for( &self, request: &[JointRietveldHistogram], constraints: &[Constraint], ) -> Result<(), JointRietveldRefinementError>

Revalidate this checkpoint against an exact request and constraints.

§Errors

Returns JointRietveldRefinementError::InvalidCheckpoint when any accepted-state or continuation invariant is stale.

Trait Implementations§

Source §

impl Clone for JointRietveldCheckpoint

Source §

fn clone(&self) -> JointRietveldCheckpoint

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for JointRietveldCheckpoint

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for JointRietveldCheckpoint

Source §

fn eq(&self, other: &JointRietveldCheckpoint) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for JointRietveldCheckpoint

Auto Trait Implementations§

§

impl UnsafeUnpin for JointRietveldCheckpoint

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

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 more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

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 more

Source §