Struct ProfileEstimationOptions

Source

pub struct ProfileEstimationOptions {
    pub mode: ProfileEstimationMode,
    pub align_lattice: bool,
    pub minimum_relative_rwp_improvement: f64,
    pub minimum_absolute_rwp_improvement: f64,
    pub maximum_absolute_correlation: f64,
    pub lebail: LeBailOptions,
}

Expand description

Deterministic controls for staged effective-profile estimation.

Fields§

§mode: ProfileEstimationMode

Requested model-selection behavior.

§align_lattice: bool

Align a bounded dynamic phase cell before fitting widths.

§minimum_relative_rwp_improvement: f64

Minimum fractional Rwp decrease required by an automatic complexity increase.

§minimum_absolute_rwp_improvement: f64

Minimum absolute Rwp decrease required by an automatic complexity increase.

§maximum_absolute_correlation: f64

Largest permitted absolute covariance correlation for an automatic candidate.

§lebail: LeBailOptions

Underlying independent-intensity extraction and profile-solver controls.

Implementations§

Source §

impl ProfileEstimationOptions

Source

pub fn new( mode: ProfileEstimationMode, align_lattice: bool, minimum_relative_rwp_improvement: f64, minimum_absolute_rwp_improvement: f64, maximum_absolute_correlation: f64, lebail: LeBailOptions, ) -> Result<Self, ProfileEstimationError>

Construct and validate explicit estimation controls.

§Errors

Returns ProfileEstimationError::InvalidOptions for invalid thresholds.

Source

pub fn scripting_defaults( execution: ExecutionPolicy, ) -> Result<Self, ProfileEstimationError>

Conservative scripting defaults with an explicit native execution policy.

Automatic candidates must lower Rwp by at least 0.2% relative and 1e-5 absolute, and keep every pairwise absolute covariance correlation at or below 0.98.

§Errors

Returns ProfileEstimationError if the underlying controls are invalid.

Trait Implementations§

Source §

impl Clone for ProfileEstimationOptions

Source §

fn clone(&self) -> ProfileEstimationOptions

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 ProfileEstimationOptions

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for ProfileEstimationOptions

Source §

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

Auto Trait Implementations§

§

impl UnsafeUnpin for ProfileEstimationOptions

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 §