Struct JointRietveldRefinementOptions

Source

pub struct JointRietveldRefinementOptions {
    pub limits: RefinementLimits,
    pub min_iterations: usize,
    pub objective_tolerance: f64,
    pub parameter_tolerance: f64,
    pub initial_damping: f64,
    pub damping_increase: f64,
    pub damping_decrease: f64,
    pub cg_tolerance: f64,
    pub max_cg_iterations: usize,
    pub max_scaled_parameter_step: f64,
    pub max_backtracks: usize,
}

Expand description

Numerical and bounded-runtime controls for a joint native refinement.

Fields§

§limits: RefinementLimits

Hard iteration/evaluation/time/rejection limits.

§min_iterations: usize

Minimum accepted iterations before objective convergence.

§objective_tolerance: f64

Relative accepted objective-change tolerance.

§parameter_tolerance: f64

Scaled step-norm tolerance.

§initial_damping: f64

Initial positive Levenberg damping in scaled coordinates.

§damping_increase: f64

Multiplier applied after an unsuccessful iteration.

§damping_decrease: f64

Multiplier applied after an accepted iteration.

§cg_tolerance: f64

Relative conjugate-gradient residual tolerance.

§max_cg_iterations: usize

Maximum conjugate-gradient iterations per attempted step.

§max_scaled_parameter_step: f64

Maximum Euclidean scaled step norm.

§max_backtracks: usize

Number of half-step retries after the full trial.

Implementations§

Source §

impl JointRietveldRefinementOptions

Source

pub fn new( limits: RefinementLimits, min_iterations: usize, objective_tolerance: f64, parameter_tolerance: f64, initial_damping: f64, damping_increase: f64, damping_decrease: f64, cg_tolerance: f64, max_cg_iterations: usize, max_scaled_parameter_step: f64, max_backtracks: usize, ) -> Result<Self, JointRietveldRefinementError>

Construct validated joint numerical controls.

§Errors

Returns JointRietveldRefinementError::InvalidOptions for invalid tolerances, damping, iteration, or step controls.

Source

pub fn validate(self) -> Result<(), JointRietveldRefinementError>

Revalidate adapter-decoded joint numerical controls.

§Errors

Returns JointRietveldRefinementError::InvalidOptions for invalid fields.

Trait Implementations§

Source §

impl Clone for JointRietveldRefinementOptions

Source §

fn clone(&self) -> JointRietveldRefinementOptions

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 Copy for JointRietveldRefinementOptions

Source §

impl Debug for JointRietveldRefinementOptions

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for JointRietveldRefinementOptions

Source §

fn eq(&self, other: &JointRietveldRefinementOptions) -> 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 JointRietveldRefinementOptions

Auto Trait Implementations§

§

impl UnwindSafe for JointRietveldRefinementOptions

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 §