Struct PermutationResidual 

pub struct PermutationResidual {
    pub(super) vectors: Vec<[Complex; 3]>,
    pub(super) polarizations: Vec<u8>,
    pub(super) turns: usize,
    pub(super) helicity: bool,
}

What permutation saves for its pullback: the wavevectors, the polarizations, the number of turns and the polarization convention.

The pullback writes each mode’s gradient on its own, so its result does not depend on the thread count.

Fields

vectors: Vec<[Complex; 3]>

polarizations: Vec<u8>

turns: usize

helicity: bool

Implementations

impl PermutationResidual

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

Output polarizations and input plane modes: the shape (2, modes) of the coefficients.

pub fn validate_tangents(&self, vectors: &[[Complex; 3]]) -> Result<()>

Validate a wavevector tangent for the recorded operation.

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

Contract the polarization coefficient jets with one wavevector direction.

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

Wavevector gradients for a cotangent of the coefficients’ shape. Direction derivatives at an axial polarization gauge are undefined.

impl PermutationResidual

pub fn state_size(modes: usize) -> Result<usize>

Byte count for a permutation of modes plane waves.

Trait Implementations

impl Debug for PermutationResidual

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

Formats the value using the given formatter.

impl SavedState for PermutationResidual

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

Copy the saved numerical state into its fixed byte layout.

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

Restore numerical state from bytes produced by this extension.