Struct SphereResidual 

pub struct SphereResidual {
    k0: f64,
    radii: Vec<f64>,
    degrees: Vec<MieResidual>,
}

What sphere saves for its pullback: the Mie residual of each degree.

Fields

k0: f64

radii: Vec<f64>

degrees: Vec<MieResidual>

Implementations

impl SphereResidual

pub(crate) fn lmax(&self) -> usize

pub fn state_size(lmax: usize, boundaries: usize) -> Result<usize>

Byte count of saved derivative state for this degree and layer count.

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

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

impl SphereResidual

pub fn boundaries(&self) -> usize

The number of recorded layer boundaries.

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

The shape of the T-matrix: 2 lmax (lmax + 2) modes, as sw::modes lists them.

pub fn pushforward( &self, k0: f64, radii: &[f64], materials: &[Material], ) -> Result<DMatrix<Complex>>

The T-matrix tangent along changes of k0, the radii and the materials. Material entries store changes of epsilon, mu and kappa. Each degree is differentiated once and its block is repeated over the azimuthal orders.

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

Gradients of k0, the radii and the materials from cotangent, the gradient of a real loss with respect to the T-matrix.

The pullback runs on the calling thread and adds the degrees in order, so the Rayon pool does not change it.

Trait Implementations

impl Clone for SphereResidual

fn clone(&self) -> SphereResidual

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SphereResidual

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

Formats the value using the given formatter.

impl SavedState for SphereResidual

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.