pub struct JointRietveldLayout { /* private fields */ }Expand description
Stable shared/local parameter packing for a joint objective.
Implementations§
Source§impl JointRietveldLayout
impl JointRietveldLayout
Sourcepub fn new(
histograms: &[JointRietveldHistogram],
) -> Result<Self, JointRietveldError>
pub fn new( histograms: &[JointRietveldHistogram], ) -> Result<Self, JointRietveldError>
Build one physical parameter set across two or more histograms.
Lattice, coordinates, occupancies, and atomic displacement parameters are shared by stable phase/site identity. Instrument, background, sample-physics, and phase-scale parameters are histogram-local.
§Errors
Returns JointRietveldError for invalid histogram identity, input,
selection, or incompatible shared structural state.
Sourcepub const fn parameters(&self) -> &ParameterSet
pub const fn parameters(&self) -> &ParameterSet
Borrow the stable joint physical parameter set.
Sourcepub fn histogram_ids(&self) -> &[RecordId]
pub fn histogram_ids(&self) -> &[RecordId]
Borrow stable histogram identities in packing order.
Sourcepub fn apply_values(
&self,
histograms: &[JointRietveldHistogram],
values: &[f64],
) -> Result<Vec<JointRietveldHistogram>, JointRietveldError>
pub fn apply_values( &self, histograms: &[JointRietveldHistogram], values: &[f64], ) -> Result<Vec<JointRietveldHistogram>, JointRietveldError>
Install joint physical values into every histogram request.
§Errors
Returns JointRietveldError for a stale histogram contract or an
invalid joint/local value.
Trait Implementations§
Source§impl Clone for JointRietveldLayout
impl Clone for JointRietveldLayout
Source§fn clone(&self) -> JointRietveldLayout
fn clone(&self) -> JointRietveldLayout
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 JointRietveldLayout
impl Debug for JointRietveldLayout
Source§impl PartialEq for JointRietveldLayout
impl PartialEq for JointRietveldLayout
impl StructuralPartialEq for JointRietveldLayout
Auto Trait Implementations§
impl Freeze for JointRietveldLayout
impl RefUnwindSafe for JointRietveldLayout
impl Send for JointRietveldLayout
impl Sync for JointRietveldLayout
impl Unpin for JointRietveldLayout
impl UnsafeUnpin for JointRietveldLayout
impl UnwindSafe for JointRietveldLayout
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.