Skip to main content

LossFunctionEvaluation

Struct LossFunctionEvaluation 

Source
pub struct LossFunctionEvaluation {
    pub value: f64,
    pub lindhard_evaluations: u64,
    pub unconverged_cells: u64,
    pub unconverged_error: f64,
    pub largest_interval_rules: u64,
}
Expand description

One evaluation of the full Penn loss function Im[-1/ε(q, ω)] (FullPenn::loss_function_evaluation): the value, the work of its adaptive ω_p integral, and whether every cell of that integral met its tolerance.

The bisection of each knot interval of the ω_p integral has a budget of rule applications (#298; the rule and the budget are documented on the weighted quadrature in quadrature.rs and in the module docs). A cell that did not meet its tolerance (budget spent, maximum depth reached, or midpoint no longer representable) keeps its estimate, is counted in unconverged_cells, and contributes its error estimate to unconverged_error; Self::converged is then false.

Fields§

§value: f64

Im[-1/ε(q, ω)] (dimensionless), as FullPenn::loss_function.

§lindhard_evaluations: u64

Evaluations of the Lindhard continuum loss function in the ω_p integral: the work, a deterministic count.

§unconverged_cells: u64

Cells of the ω_p integral accepted without meeting their tolerance.

§unconverged_error: f64

The sum of the error estimates of those cells, in the units of value (zero when the integral converged).

§largest_interval_rules: u64

The most rule applications (of 5 evaluations each) that the bisection of any one knot interval used, at most OMEGA_P_INTERVAL_BUDGET.

Implementations§

Source§

impl LossFunctionEvaluation

Source

pub fn converged(&self) -> bool

Whether every cell of the ω_p integral met its tolerance.

Trait Implementations§

Source§

impl Clone for LossFunctionEvaluation

Source§

fn clone(&self) -> LossFunctionEvaluation

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for LossFunctionEvaluation

Source§

impl Debug for LossFunctionEvaluation

Source§

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

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

impl PartialEq for LossFunctionEvaluation

Source§

fn eq(&self, other: &LossFunctionEvaluation) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LossFunctionEvaluation

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V