Struct OperatorResidual 

pub struct OperatorResidual {
    waves: WaveSet,
    points: Vec<[f64; 3]>,
}

What operator saves for its pullback: the wave set and the points, without the matrix.

Fields

waves: WaveSet

points: Vec<[f64; 3]>

Implementations

impl OperatorResidual

pub fn state_size( modes: usize, positions: usize, points: usize, cylindrical: bool, ) -> Result<usize>

Saved-state byte count determined solely by the input dimensions and wave family, without evaluating a field operator.

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

Flattened operator shape (three times samples, modes).

pub fn position_count(&self) -> usize

Number of expansion centres in the input basis.

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

Operator tangent in one direction of sample points, expansion centres and wavenumbers, evaluated directly into the output’s column-major storage.

pub fn pushforward_axial( &self, points: &[[f64; 3]], positions: &[[f64; 3]], ks: [Complex; 2], kz: &[f64], ) -> Result<DMatrix<Complex>>

Self::pushforward with an axial-wavenumber tangent per cylindrical mode.

fn pushforward_impl<const N: usize>( &self, tangent: GeometryTangent<'_>, ) -> Result<DMatrix<Complex>>

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

Point, position and wavenumber gradients from cotangent, the gradient of a real loss with respect to the matrix; the coefficient gradient is empty.

Each point gradient comes from its own sample only. The position and wavenumber gradients add as in FieldResidual::pullback, so the thread count does not change them.

pub fn pullback_axial( &self, cotangent: &DMatrix<Complex>, ) -> Result<(FieldGradient, Vec<f64>)>

Self::pullback plus a real axial-wavenumber gradient for each mode of a cylindrical basis; the axial gradients add their chunk sums the same way.

fn pullback_impl<const N: usize>( &self, cotangent: &DMatrix<Complex>, ) -> Result<(FieldGradient, Vec<f64>)>

Trait Implementations

impl Debug for OperatorResidual

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

Formats the value using the given formatter.

impl SavedState for OperatorResidual

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.