Struct ExpansionResidual 

pub struct ExpansionResidual {
    destination: Basis,
    source: Basis,
    ks: [Complex; 2],
    radial: Radial,
    helicity: bool,
    blocks: Vec<Block>,
}

What expansion saves for its pullback: the bases, the wavenumbers, the radial kind and every block with its translation plan. The pullback recomputes the derivative tables per block.

The pullback evaluates blocks in parallel and adds their gradients in block order, so its result does not depend on the thread count.

Fields

destination: Basis

source: Basis

ks: [Complex; 2]

radial: Radial

helicity: bool

blocks: Vec<Block>

Implementations

impl ExpansionResidual

fn prepare( destination: Basis, source: Basis, ks: [Complex; 2], helicity: bool, radial: Radial, ) -> Result<Self>

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

Fixed saved-state bytes for the two basis shapes.

pub(crate) fn write_state(&self, writer: &mut Writer)

Append state for a containing residual without allocating an intermediate buffer.

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

Destination and source mode counts: the shape of the expansion matrix.

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

Directional derivative in the positions and the two medium wavenumbers.

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

Position and wavenumber gradients from cotangent, the gradient of a real loss with respect to the matrix.

Trait Implementations

impl Clone for ExpansionResidual

fn clone(&self) -> ExpansionResidual

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExpansionResidual

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

Formats the value using the given formatter.

impl SavedState for ExpansionResidual

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.