MieResidual

Struct MieResidual 

Source
pub struct MieResidual {
    sizes: Vec<f64>,
    materials: Vec<Material>,
    interfaces: Vec<Interface>,
    inverse: Matrix2,
    value: Matrix2,
}
Expand description

What mie saves for its pullback: the interface matrices and radial functions of one degree l, so the pullback evaluates no Bessel functions.

Fields§

§sizes: Vec<f64>§materials: Vec<Material>§interfaces: Vec<Interface>§inverse: Matrix2§value: Matrix2

Implementations§

Source§

impl MieResidual

Source

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

Exact byte count of the saved Mie state for boundaries layers. The layout contains one count, the sizes, three material parameters, 62 complex entries per interface, and two coefficient matrices.

Source

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

Source

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

Source§

impl MieResidual

Source

pub fn boundaries(&self) -> usize

The number of recorded layer boundaries.

Source

pub const fn value(&self) -> &Matrix2

The Mie coefficient matrix, which the pullback reads.

Source

pub fn pushforward( &self, sizes: &[f64], materials: &[Material], ) -> Result<Matrix2>

The coefficient tangent along changes of the sizes and materials. Each materials entry stores changes of epsilon, mu and kappa, including the embedding medium. One combined direction travels through the cached interfaces; no Bessel functions or parameter Jacobians are evaluated.

Source

pub fn pullback(&self, cotangent: &Matrix2) -> Result<MieGradient>

Gradients of the size parameters and the materials from cotangent, the gradient of a real loss with respect to the coefficient matrix.

The pullback runs on the calling thread and adds the boundaries in order, from the outermost in.

Trait Implementations§

Source§

impl Clone for MieResidual

Source§

fn clone(&self) -> MieResidual

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MieResidual

Source§

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

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

impl SavedState for MieResidual

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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,