LayerStackResidual

Struct LayerStackResidual 

Source
pub struct LayerStackResidual {
    ks: Vec<[Complex; 2]>,
    q: Vec<[f64; 2]>,
    thickness: Vec<f64>,
    channels: Vec<Channel>,
    fixed_q: bool,
}
Expand description

What layer_stack saves for its pullback: the solves of every transverse wavevector, each on its own, without a dense matrix over all of them.

The pullback adds the medium and thickness gradients of all wavevectors in chunks of consecutive wavevectors fixed by their count, and the chunk sums in chunk order (numerics::parallel::try_fold_ordered), so the thread count does not change them. Each q gradient belongs to one wavevector, which writes it in place.

Fields§

§ks: Vec<[Complex; 2]>§q: Vec<[f64; 2]>§thickness: Vec<f64>§channels: Vec<Channel>§fixed_q: bool

Implementations§

Source§

impl LayerStackResidual

Source

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

Fixed state byte count for the media and independent transverse channels.

Source§

impl LayerStackResidual

Source

pub fn medium_count(&self) -> usize

Number of media, including the exterior half-spaces.

Source

pub fn channel_count(&self) -> usize

Number of independent transverse channels.

Source

pub fn pushforward( &self, ks: &[[Complex; 2]], zs: &[Complex], q: &[[f64; 2]], thickness: &[f64], ) -> Result<Vec<Blocks>>

Propagate one parameter direction through the independent two-polarization channels, reusing every saved interface and internal-field factorization.

Source

pub fn pullback(&self, cotangent: Vec<Blocks>) -> Result<LayerStackGradient>

Reuse every two-polarization solve; accumulate shared medium and thickness derivatives.

Trait Implementations§

Source§

impl Debug for LayerStackResidual

Source§

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

Formats the value using the given formatter. Read more
Source§

impl SavedState for LayerStackResidual

Source§

fn save_state(&self) -> Result<Vec<u8>>

Copy the saved numerical state into its fixed byte layout.
Source§

fn from_state(bytes: &[u8]) -> Result<Self>

Restore numerical state from bytes produced by this extension.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,