Struct IlluminateResidual 

pub struct IlluminateResidual {
    factor: Arc<InteractionFactor>,
    response: DMatrix<Complex>,
    value: DMatrix<Complex>,
}

What InteractionFactor::record saves for its pullback: the shared factor and the total incident response B + C X and scattered fields of the requested columns.

Fields

factor: Arc<InteractionFactor>

response: DMatrix<Complex>

value: DMatrix<Complex>

Implementations

impl IlluminateResidual

pub fn state_size(local_sizes: &[usize], columns: usize) -> Result<usize>

Bytes needed to save local blocks, coupling, LU, response and scattered fields.

impl IlluminateResidual

pub fn local_shapes(&self) -> impl ExactSizeIterator<Item = (usize, usize)>

Shapes of the recorded local blocks, in particle order.

pub const fn value(&self) -> &DMatrix<Complex>

The scattered coefficients, one column per incident field, which the pullback reads.

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

The shape of the scattered coefficients: channels and incident fields.

pub fn pushforward( &self, local: &[DMatrix<Complex>], coupling: &DMatrix<Complex>, incident: &DMatrix<Complex>, ) -> Result<DMatrix<Complex>>

Directional derivative of the requested scattered columns for tangents of the local blocks, coupling and incident fields. Uses the shared LU once: (I - T C) dX = dT (B + C X) + T (dB + dC X).

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

Gradients of T, C and B from cotangent, the gradient of a real loss with respect to the scattered fields.

With Y = (I - T C)⁻ᴴ G from the shared LU, the gradients are Y (B + C X)ᴴ on each local block, Tᴴ Y Xᴴ and Tᴴ Y. The pullback has no Rayon reduction; the LU solve and the matrix products run in faer with the worker count of linalg.

Trait Implementations

impl Debug for IlluminateResidual

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

Formats the value using the given formatter.

impl SavedState for IlluminateResidual

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.