pub struct CalibrationParameterSpec {
pub lower_bound: f64,
pub upper_bound: f64,
pub finite_difference_step: f64,
pub scale: f64,
pub prior_center: Option<f64>,
pub regularization_strength: f64,
}Expand description
Bounds, differencing scale, optimization scale, and optional quadratic prior.
Fields§
§lower_bound: f64Inclusive lower bound in the parameter’s documented physical unit.
upper_bound: f64Inclusive upper bound in the parameter’s documented physical unit.
finite_difference_step: f64Positive finite-difference displacement in the physical unit.
scale: f64Positive scale mapping an absolute value to a dimensionless optimizer variable.
prior_center: Option<f64>Optional absolute center of a quadratic prior, in the physical unit.
regularization_strength: f64Non-negative coefficient of the dimensionless quadratic prior.
Implementations§
Source§impl CalibrationParameterSpec
impl CalibrationParameterSpec
Sourcepub fn new(lower_bound: f64, upper_bound: f64, scale: f64) -> Self
pub fn new(lower_bound: f64, upper_bound: f64, scale: f64) -> Self
Creates a bounded parameter specification with scale-aware default differencing.
Sourcepub fn finite_difference_step(self, step: f64) -> Self
pub fn finite_difference_step(self, step: f64) -> Self
Replaces the positive physical finite-difference displacement.
Trait Implementations§
Source§impl Clone for CalibrationParameterSpec
impl Clone for CalibrationParameterSpec
Source§fn clone(&self) -> CalibrationParameterSpec
fn clone(&self) -> CalibrationParameterSpec
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 CalibrationParameterSpec
impl Debug for CalibrationParameterSpec
Source§impl<'de> Deserialize<'de> for CalibrationParameterSpec
impl<'de> Deserialize<'de> for CalibrationParameterSpec
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl PartialEq for CalibrationParameterSpec
impl PartialEq for CalibrationParameterSpec
Source§fn eq(&self, other: &CalibrationParameterSpec) -> bool
fn eq(&self, other: &CalibrationParameterSpec) -> bool
Tests for
self and other values to be equal, and is used by ==.Source§impl Serialize for CalibrationParameterSpec
impl Serialize for CalibrationParameterSpec
impl StructuralPartialEq for CalibrationParameterSpec
Auto Trait Implementations§
impl Freeze for CalibrationParameterSpec
impl RefUnwindSafe for CalibrationParameterSpec
impl Send for CalibrationParameterSpec
impl Sync for CalibrationParameterSpec
impl Unpin for CalibrationParameterSpec
impl UnsafeUnpin for CalibrationParameterSpec
impl UnwindSafe for CalibrationParameterSpec
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 more