Struct CylindricalChannelsResidual 

pub struct CylindricalChannelsResidual {
    basis: Basis,
    ks: [Complex; 2],
    q: Vec<[f64; 2]>,
    polarizations: Vec<u8>,
    period: f64,
    fixed_q: bool,
}

What cylindrical_channels saves for its pullback: its inputs alone.

The pullback recomputes each channel with its derivatives with respect to the position, the wavenumber, kx and the period.

The pullback adds the per-column position, wavenumber and period gradients as SphericalChannelsResidual adds its shared gradients, so the thread count does not change them. Each kx gradient belongs to one column, which writes it in place.

Fields

basis: Basis

ks: [Complex; 2]

q: Vec<[f64; 2]>

polarizations: Vec<u8>

period: f64

fixed_q: bool

Implementations

impl CylindricalChannelsResidual

pub fn state_size( multipoles: usize, positions: usize, channels: usize, ) -> Result<usize>

Bytes of saved derivative state for the fixed basis and channel counts.

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

The shape of the channel matrix: four rows per cylindrical mode, one column per plane mode.

pub fn validate_tangent( &self, positions: &[[f64; 3]], ks: [Complex; 2], q: &[[f64; 2]], measure: f64, ) -> Result<()>

Check finite input tangents and their position and plane counts.

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

Directional derivative of the channel matrix. The axial q[j][0] is a fixed label, and q[j][1] is held fixed as well when fixed_q was requested.

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

Gradients of the positions, the two medium wavenumbers, the kx components and the period, for a cotangent of the channel matrix’s shape. The axial kz = q[j][0] is a fixed label with a zero gradient, and measure holds the period gradient. The traversal is shared with SphericalChannelsResidual::pullback.

Trait Implementations

impl Clone for CylindricalChannelsResidual

fn clone(&self) -> CylindricalChannelsResidual

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CylindricalChannelsResidual

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

Formats the value using the given formatter.

impl SavedState for CylindricalChannelsResidual

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.