RotationResidual

Struct RotationResidual 

Source
pub struct RotationResidual {
    rows: Vec<i32>,
    columns: Vec<i32>,
    entries: Vec<(usize, usize)>,
    spherical: Option<Spherical>,
    value: DMatrix<Complex>,
}
Expand description

What sw_rotation and cw_rotation save for their pullback: the rotation matrix, its coupled entries and, for spherical bases, the angular blocks.

The pullback adds the entries in order on the calling thread, so its result does not depend on the thread count.

Fields§

§rows: Vec<i32>§columns: Vec<i32>§entries: Vec<(usize, usize)>

The coupled entries; all others vanish.

§spherical: Option<Spherical>§value: DMatrix<Complex>

Implementations§

Source§

impl RotationResidual

Source

pub fn sw_state_size( destination: &[(usize, Mode)], source: &[(usize, Mode)], ) -> Result<usize>

Saved-state size from spherical mode labels, without evaluating a rotation.

Source

pub fn cw_state_size( destination: &[(usize, Mode)], source: &[(usize, Mode)], ) -> Result<usize>

Saved-state size from cylindrical mode labels, without evaluating a rotation.

Source

pub const fn value(&self) -> &DMatrix<Complex>

The rotation from the source to the destination multipole coefficients, which the pullback reads.

Source

pub fn shape(&self) -> (usize, usize)

The shape of the rotation: destination and source mode counts.

Source

pub fn pushforward(&self, angles: [f64; 3]) -> Result<DMatrix<Complex>>

Contract the Euler-angle derivatives with one real direction. Cylindrical theta remains a fixed zero constraint and contributes no derivative.

Source

fn theta_derivative(&self, i: usize, j: usize) -> Complex

The shared ladder rule used by the JVP and VJP.

Source

pub fn pullback(&self, cotangent: &DMatrix<Complex>) -> Result<[f64; 3]>

Euler-angle cotangents. Cylindrical theta is a fixed zero constraint.

Trait Implementations§

Source§

impl Debug for RotationResidual

Source§

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

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

impl SavedState for RotationResidual

Source§

fn save_state(&self) -> Result<Vec<u8>>

Copy the saved numerical state into its fixed byte layout.
Source§

fn from_state(state: &[u8]) -> Result<Self>

Restore numerical state from bytes produced by this extension.

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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
§

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

§

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

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

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,