Struct InteractionResidual 

pub struct InteractionResidual {
    factor: InteractionFactor,
    value: DMatrix<Complex>,
}

What interaction saves for its pullback: the factorization of I - T C and the interacting T-matrix X.

Fields

factor: InteractionFactor

value: DMatrix<Complex>

Implementations

impl InteractionResidual

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

Bytes needed to save local blocks, coupling, LU and interacting T-matrix.

pub(crate) fn state_size_uniform( block_size: usize, particles: usize, ) -> Result<usize>

State size for equally sized particle blocks, without a temporary size list.

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

pub(crate) fn read_state(reader: &mut Reader<'_>) -> Result<Self>

impl InteractionResidual

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

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

The interacting T-matrix X.

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

The shape of the interacting T-matrix.

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

Directional derivative of the interacting T-matrix with respect to dense T and C. Reuses the forward LU for one tangent solve.

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

Like pushforward, with one tangent per local block. Solves (I - T C) dX = dT (I + C X) + T dC X without expanding dT.

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

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

The pullback solves one adjoint system with the forward LU. It has no Rayon reduction; the LU solve and the matrix products run in faer with the worker count of linalg.

pub fn pullback_blocks( &self, cotangent: &DMatrix<Complex>, ) -> Result<InteractionGradient<Vec<DMatrix<Complex>>>>

Like pullback, with one gradient per diagonal block of a block-diagonal T, or a single one for a dense T.

fn pullback_with<T>( &self, cotangent: &DMatrix<Complex>, local_gradient: impl FnOnce(&LocalMatrix, &DMatrix<Complex>, &DMatrix<Complex>) -> T, ) -> Result<InteractionGradient<T>>

Trait Implementations

impl Clone for InteractionResidual

fn clone(&self) -> InteractionResidual

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InteractionResidual

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

Formats the value using the given formatter.

impl SavedState for InteractionResidual

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.