Struct ToSwResidual 

pub struct ToSwResidual {
    destination: Basis,
    source: Basis,
    ks: [Complex; 2],
    helicity: bool,
}

What to_sw_matrix saves for its pullback: the bases, the wavenumbers and the polarization convention. The pullback recomputes the derivatives of every entry.

The pullback adds the per-column gradients in chunks of consecutive columns fixed by the column count, and the chunk sums in chunk order (numerics::parallel::try_fold_ordered), so the thread count does not change them.

Fields

destination: Basis

source: Basis

ks: [Complex; 2]

helicity: bool

Implementations

impl ToSwResidual

pub fn state_size( destination_modes: usize, destination_positions: usize, source_modes: usize, source_positions: usize, ) -> Result<usize>

Saved-state size from the spherical destination and cylindrical source shapes.

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

Spherical output and cylindrical input mode counts.

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

Directional derivative of the displaced conversion, with fixed axial labels.

pub fn pullback( &self, cotangent: &DMatrix<Complex>, ) -> Result<ExpansionGradient>

Position and complex wavenumber gradients. Axial mode labels stay fixed.

Trait Implementations

impl Debug for ToSwResidual

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

Formats the value using the given formatter.

impl SavedState for ToSwResidual

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.