Struct PropagationResidual 

pub struct PropagationResidual {
    vectors: Vec<[Complex; 3]>,
    distance: [f64; 3],
    phases: Vec<[Complex; 2]>,
}

What propagation saves for its pullback: the wavevectors, the displacement and the diagonal phases.

Fields

vectors: Vec<[Complex; 3]>

distance: [f64; 3]

phases: Vec<[Complex; 2]>

Upward and downward transmission phase of every mode.

Implementations

impl PropagationResidual

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

Byte length for n upgoing wavevectors and their two saved phases.

impl PropagationResidual

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

The shape (n, n) of each scattering block, with n modes in each direction.

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

Propagate a wavevector and displacement direction through the saved phases.

pub fn pullback(&self, cotangent: &Blocks) -> Result<PropagationGradient>

Wavevector and displacement gradients from the cotangents of the four blocks.

Trait Implementations

impl Debug for PropagationResidual

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

Formats the value using the given formatter.

impl SavedState for PropagationResidual

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.