Skip to main content

RotationMatrix

Struct RotationMatrix 

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

Deterministically generated orthogonal matrix for vector preconditioning.

The inner storage is Arc<[f64]> so Clone is O(1) — callers can pass copies between tasks without reallocating the dim * dim buffer.

Implementations§

Source§

impl RotationMatrix

Source

pub fn from_config(config: &CodecConfig) -> Self

Build a rotation matrix for the given CodecConfig.

Source

pub fn build(seed: u64, dimension: u32) -> Self

Build a rotation matrix for the (seed, dimension) pair.

§Panics

Panics if dimension == 0. In the normal flow, dimensions reach this function only via a validated CodecConfig, so this cannot be triggered by safe public APIs of the crate.

Source

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

Borrow the row-major dim * dim matrix buffer.

Source

pub const fn dimension(&self) -> u32

The row/column count of the square matrix.

Source

pub const fn seed(&self) -> u64

The seed that generated this matrix.

Source

pub fn apply_into( &self, input: &[f32], output: &mut [f32], ) -> Result<(), CodecError>

Rotate input into output: output = matrix @ input.

§Errors

Returns CodecError::LengthMismatch if either slice length differs from Self::dimension.

Source

pub fn apply_inverse_into( &self, input: &[f32], output: &mut [f32], ) -> Result<(), CodecError>

Apply the inverse rotation: output = matrix^T @ input.

Valid because the matrix is orthogonal.

§Errors

Returns CodecError::LengthMismatch if either slice length differs from Self::dimension.

Source

pub fn verify_orthogonality(&self, tol: f64) -> bool

Return true if matrix @ matrix^T equals the identity within tol on every entry.

This is O(n^3); reserve for tests and low-frequency sanity checks.

Trait Implementations§

Source§

impl Clone for RotationMatrix

Source§

fn clone(&self) -> RotationMatrix

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RotationMatrix

Source§

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

Formats the value using the given formatter. 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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V