Skip to main content

RietveldStructuralLayout

Struct RietveldStructuralLayout 

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

Ordered physical parameters and exact transforms to/from engine layouts.

Implementations§

Source§

impl RietveldStructuralLayout

Source

pub fn new( phases: &[RietveldPhase], selection: RietveldStructuralSelection, lattice_bounds: &[Option<LatticeBounds>], ) -> Result<Self, RietveldParameterError>

Build stable keys, bounds, scaling, and analytical engine transforms.

lattice_bounds must have one entry per phase. A selected lattice requires bounds; an unselected lattice ignores a missing entry.

§Errors

Returns RietveldParameterError for shape, lattice, identity, or parameter-domain failures.

Source

pub const fn parameters(&self) -> &ParameterSet

Borrow ordered physical parameter specifications.

Source

pub fn coordinate_models(&self) -> &[Vec<SiteCoordinateModel>]

Borrow symmetry-allowed site models in phase/site order.

Source

pub fn apply_values( &self, phases: &[RietveldPhase], values: &[f64], ) -> Result<Vec<RietveldPhase>, RietveldParameterError>

Install physical parameter values into cloned phase definitions.

§Errors

Returns RietveldParameterError for stale phase identities, a wrong value count, invalid lattice/site values, or a rejected phase domain.

Source

pub fn apply_value_change( &self, phases: &[RietveldPhase], current_values: &[f64], values: &[f64], ) -> Result<Vec<RietveldPhase>, RietveldParameterError>

Install a change between two absolute physical parameter states.

Special-position coordinates are local tangent coordinates, so only their difference is applied to the current phase. All other selected values are installed absolutely.

§Errors

Returns RietveldParameterError for stale phase identities, wrong value counts, invalid values, or a rejected phase domain.

Source

pub fn native_tangents( &self, direction: &[f64], ) -> Result<Vec<Vec<f64>>, RietveldParameterError>

Expand one physical parameter direction into native per-phase tangents.

§Errors

Returns RietveldParameterError::DirectionLengthMismatch for a wrong global direction length.

Source

pub fn project_native_gradients( &self, gradients: &[&[f64]], ) -> Result<Vec<f64>, RietveldParameterError>

Project native per-phase reverse products into physical parameter order.

§Errors

Returns RietveldParameterError for phase or native-gradient shape mismatches.

Source

pub fn project_native_jacobians( &self, jacobians: &[(&[f64], usize)], sample_count: usize, ) -> Result<Vec<f64>, RietveldParameterError>

Project parameter-major native phase Jacobians into physical parameter order.

§Errors

Returns RietveldParameterError for phase, native-row, sample, or allocation shape mismatches.

Trait Implementations§

Source§

impl Clone for RietveldStructuralLayout

Source§

fn clone(&self) -> RietveldStructuralLayout

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 RietveldStructuralLayout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RietveldStructuralLayout

Source§

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.