Struct SumResidual 

pub struct SumResidual {
    waves: Vec<Family>,
    wavenumbers: Vec<Complex>,
    lattices: Vec<BlochLattice>,
    shifts: Vec<[f64; 3]>,
    etas: Vec<Complex>,
    parts: Vec<SumPart>,
    size: usize,
}

What sum_array saves for a batch of lattice sums: the original inputs. Every input holds one shared value or one value per output.

Fields

waves: Vec<Family>

wavenumbers: Vec<Complex>

lattices: Vec<BlochLattice>

shifts: Vec<[f64; 3]>

etas: Vec<Complex>

parts: Vec<SumPart>

size: usize

Implementations

impl SumResidual

pub fn new( waves: Vec<Family>, wavenumbers: Vec<Complex>, lattices: Vec<BlochLattice>, shifts: Vec<[f64; 3]>, etas: Vec<Complex>, parts: Vec<SumPart>, ) -> Result<Self>

Retain a batch’s inputs without evaluating any lattice sums.

pub fn values(&self) -> Result<Vec<Complex>>

Evaluate the recorded inputs once per output.

pub fn pushforward(&self, tangents: &[SumTangent]) -> Result<Vec<Complex>>

Contract each sum’s analytic local derivatives with one input direction. tangents contains one shared direction or one direction per output.

fn element( &self, i: usize, ) -> (Family, Complex, &BlochLattice, [f64; 3], Complex, SumPart)

The inputs of output i.

pub fn pullback(&self, cotangent: &[Complex]) -> Result<Vec<SumGradient>>

One gradient per output, from cotangent, the gradient of a real loss with respect to the sums.

Trait Implementations

impl Debug for SumResidual

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

Formats the value using the given formatter.