pub struct CompositeBackground { /* private fields */ }Expand description
Ordered additive composition of analytical models.
Implementations§
Source§impl CompositeBackground
impl CompositeBackground
Sourcepub fn new(
background_id: impl Into<String>,
components: Vec<BackgroundModel>,
) -> Result<Self, BackgroundError>
pub fn new( background_id: impl Into<String>, components: Vec<BackgroundModel>, ) -> Result<Self, BackgroundError>
Construct a non-empty composition with unique immediate component IDs.
§Errors
Returns BackgroundError for an invalid ID, empty components, or
duplicate component IDs.
Sourcepub fn components(&self) -> &[BackgroundModel]
pub fn components(&self) -> &[BackgroundModel]
Borrow ordered components.
Trait Implementations§
Source§impl Clone for CompositeBackground
impl Clone for CompositeBackground
Source§fn clone(&self) -> CompositeBackground
fn clone(&self) -> CompositeBackground
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 CompositeBackground
impl Debug for CompositeBackground
Source§impl DifferentiableBackground for CompositeBackground
impl DifferentiableBackground for CompositeBackground
Source§fn background_id(&self) -> &str
fn background_id(&self) -> &str
Stable model identifier.
Source§fn parameter_names(&self) -> Vec<String>
fn parameter_names(&self) -> Vec<String>
Stable parameter names in coefficient order.
Source§fn coefficients(&self) -> Vec<f64>
fn coefficients(&self) -> Vec<f64>
Current physical coefficients in derivative-column order.
Source§fn parameter_bounds(&self) -> Vec<ParameterBounds>
fn parameter_bounds(&self) -> Vec<ParameterBounds>
Physical parameter bounds in coefficient order.
Source§fn basis(&self, x_deg: &[f64]) -> Result<BackgroundBasis, BackgroundError>
fn basis(&self, x_deg: &[f64]) -> Result<BackgroundBasis, BackgroundError>
Evaluate sample-by-parameter analytical derivatives. Read more
Source§fn calculate(&self, x_deg: &[f64]) -> Result<Vec<f64>, BackgroundError>
fn calculate(&self, x_deg: &[f64]) -> Result<Vec<f64>, BackgroundError>
Evaluate the background on an ordered finite grid. Read more
Source§fn replace_coefficients(
&self,
coefficients: &[f64],
) -> Result<Self, BackgroundError>
fn replace_coefficients( &self, coefficients: &[f64], ) -> Result<Self, BackgroundError>
Return the same model with replacement coefficients. Read more
Source§fn basis_is_invariant(&self) -> bool
fn basis_is_invariant(&self) -> bool
Return whether the analytical basis is coefficient-invariant.
Source§impl PartialEq for CompositeBackground
impl PartialEq for CompositeBackground
impl StructuralPartialEq for CompositeBackground
Auto Trait Implementations§
impl Freeze for CompositeBackground
impl RefUnwindSafe for CompositeBackground
impl Send for CompositeBackground
impl Sync for CompositeBackground
impl Unpin for CompositeBackground
impl UnsafeUnpin for CompositeBackground
impl UnwindSafe for CompositeBackground
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.