Skip to main content

JointPoissonResult

Struct JointPoissonResult 

Source
pub struct JointPoissonResult {
Show 13 fields pub deviance: f64, pub deviance_per_dof: f64, pub n_data: usize, pub n_active: usize, pub n_free: usize, pub gn_iterations: usize, pub polish_iterations: usize, pub gn_converged: bool, pub polish_converged: bool, pub polish_improved: bool, pub params: Vec<f64>, pub covariance: Option<FlatMatrix>, pub uncertainties: Option<Vec<f64>>,
}
Expand description

Outcome of joint_poisson_fit.

Fields§

§deviance: f64

Final deviance D at the fitted parameters.

§deviance_per_dof: f64

D / (n − k). Primary GOF statistic per memo 35 §P1.2.

§n_data: usize

Number of data bins on the configured grid (n). This is the total bin count; when a fit-energy-range mask is in effect, the count of bins that actually contributed to the cost function is reported separately as Self::n_active.

§n_active: usize

Number of active data bins — equal to n_data when no mask is set, or the count of true entries in the objective’s active_mask otherwise. The deviance / dof ratio uses (n_active − n_free) so reduced deviance is unbiased when a fit-energy-range mask is in effect (SAMMY EMIN/EMAX semantics, #514).

§n_free: usize

Number of free parameters (k).

§gn_iterations: usize

Iterations performed in the damped-Fisher stage.

§polish_iterations: usize

Iterations performed by the Nelder-Mead polish stage (0 if disabled).

§gn_converged: bool

true when the stage-1 (damped Fisher) optimizer met its tol_d and tol_param criteria before hitting max_iter.

§polish_converged: bool

true when the Nelder-Mead polish met xatol and fatol before max_iter (always false if enable_polish == false).

§polish_improved: bool

true when the polish step lowered the deviance below the stage-1 best value. Useful diagnostic — if polish improved D materially, stage 1 likely stalled.

§params: Vec<f64>

Final parameter values (all parameters, including fixed).

§covariance: Option<FlatMatrix>

Inverse Fisher covariance of free parameters (n_free × n_free), computed at the final θ. None if the Fisher matrix was singular or compute_covariance == false.

§uncertainties: Option<Vec<f64>>

√diag(covariance) for each free parameter, in free-index order.

Trait Implementations§

Source§

impl Clone for JointPoissonResult

Source§

fn clone(&self) -> JointPoissonResult

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 JointPoissonResult

Source§

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

Formats the value using the given formatter. Read more

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
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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more