Struct TrResidual 

pub struct TrResidual {
    matrices: [StoredBlock; 2],
    incident: DMatrix<Complex>,
    ports: TrPorts,
    forward: TrForward,
    fixed_q: bool,
}

What tr saves for its pullback: copies of the transmission and reflection blocks of the illumination direction, the incident fields, the ports and the forward results.

Fields

matrices: [StoredBlock; 2]

incident: DMatrix<Complex>

ports: TrPorts

forward: TrForward

fixed_q: bool

Implementations

impl TrResidual

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

Byte length for mode count, illumination columns and distinct port groups.

impl TrResidual

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

Transmittance and reflectance: the rows, with one column per illumination. The pullback reads them.

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

Rows (transmittance, reflectance) and independent illuminations.

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

Numbers of modes, independent illumination columns and diffraction groups.

pub fn pushforward( &self, matrices: &Blocks, incident: &DMatrix<Complex>, ks: [[Complex; 2]; 2], zs: [Complex; 2], q: &[[f64; 2]], ) -> Result<DMatrix<f64>>

Propagate matrix, illumination and port-geometry directions together. Local one-direction jets include the real power pairing and lossy-port interference.

pub fn pullback(&self, cotangent: &DMatrix<f64>) -> Result<TrGradient>

Pull back the cotangents of the transmittance and reflectance.

Trait Implementations

impl Debug for TrResidual

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

Formats the value using the given formatter.

impl SavedState for TrResidual

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.