Struct PhasesResidual 

pub struct PhasesResidual {
    pub(super) points: Vec<[f64; 3]>,
    pub(super) vectors: Vec<[Complex; 3]>,
}

What phases saves for its pullback: the points and the wavevectors, without the phases of every point and mode.

Fields

points: Vec<[f64; 3]>

vectors: Vec<[Complex; 3]>

Implementations

impl PhasesResidual

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

Number of displacements and wavevectors.

pub fn validate_tangents( &self, points: &[[f64; 3]], vectors: &[[Complex; 3]], ) -> Result<()>

Validate point and wavevector tangents for the recorded operation.

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

Differentiate each phase in one input direction without constructing a Jacobian.

pub fn pullback<S: Storage<Complex, Dyn, Dyn> + Sync>( &self, cotangent: &Matrix<Complex, Dyn, Dyn, S>, ) -> Result<PhasesGradient>

Recompute each phase once and add its terms to the point and wavevector gradients.

The longer axis is split into at most 32 blocks, fixed by the shape, that run in parallel; each block sums its own rows (or columns) in index order and a partial gradient of the shorter axis, and the partials are added in block order. The result is deterministic and the scratch is at most 32 gradients of the shorter axis.

impl PhasesResidual

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

Byte count for phases at points sample points and modes plane waves.

Trait Implementations

impl Debug for PhasesResidual

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

Formats the value using the given formatter.

impl SavedState for PhasesResidual

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.