Struct PeriodicToCwResidual 

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

What periodic_to_cw_matrix saves for its pullback: the bases, the wavenumbers, the period and the polarization convention.

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]

period: f64

helicity: bool

Implementations

impl PeriodicToCwResidual

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

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

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

Cylindrical output and spherical input mode counts.

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

Directional derivative of the positions, medium, independent output axial wavenumbers and period.

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

Recompute the local derivatives of every entry instead of keeping a Jacobian.

Trait Implementations

impl Debug for PeriodicToCwResidual

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

Formats the value using the given formatter.

impl SavedState for PeriodicToCwResidual

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.