Skip to main content

PreparedStructuralSpectrum

Struct PreparedStructuralSpectrum 

Source
pub struct PreparedStructuralSpectrum { /* private fields */ }
Expand description

Reusable native fixed-wavelength spectrum for one structural phase.

Implementations§

Source§

impl PreparedStructuralSpectrum

Source

pub fn new( definition: &StructuralPhaseDefinition, wavelengths_angstrom: Vec<f64>, relative_intensities: &[f64], execution: ExecutionPolicy, ) -> Result<Self, StructuralSpectrumError>

Prepare every wavelength component from one base structural phase.

Relative intensities are normalized to unit sum and multiply the base phase scale. All prepared components share the policy’s persistent pool.

§Errors

Returns StructuralSpectrumError for invalid component arrays or an invalid structural phase.

Source

pub fn component_count(&self) -> usize

Return the number of prepared wavelength components.

Source

pub fn normalized_weights(&self) -> &[f64]

Return normalized component weights in input order.

Source

pub fn structural_parameter_count(&self) -> usize

Return the structural parameter count shared by all components.

Source

pub fn calculate( &self, input: &PreparedStructuralSpectrumInputView<'_>, ) -> Result<StructuralPatternResult, StructuralSpectrumError>

Calculate and combine all fixed wavelength components.

§Errors

Returns StructuralSpectrumError for invalid dynamic inputs or a failed component calculation.

Source

pub fn linearize( &self, input: &PreparedStructuralSpectrumInputView<'_>, ) -> Result<StructuralPatternDenseResult, StructuralSpectrumError>

Calculate and combine dense structural linearizations.

§Errors

Returns StructuralSpectrumError for invalid inputs or incompatible component layouts.

Source

pub fn jvp( &self, input: &PreparedStructuralSpectrumInputView<'_>, tangent: &[f64], ) -> Result<StructuralPatternJvpResult, StructuralSpectrumError>

Calculate and combine structural forward derivative products.

§Errors

Returns StructuralSpectrumError for invalid inputs or tangent shape.

Source

pub fn vjp( &self, input: &PreparedStructuralSpectrumInputView<'_>, sample_weights: &[f64], ) -> Result<StructuralPatternVjpResult, StructuralSpectrumError>

Calculate and combine structural transpose products.

§Errors

Returns StructuralSpectrumError for invalid inputs or sample weights.

Trait Implementations§

Source§

impl Clone for PreparedStructuralSpectrum

Source§

fn clone(&self) -> PreparedStructuralSpectrum

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

Auto Trait Implementations§

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<U> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.