Skip to main content

AtomFunctionalReport

Struct AtomFunctionalReport 

Source
pub struct AtomFunctionalReport {
    pub peak_contrast: Option<AtomFunctionalEstimate>,
    pub average_value: Option<AtomFunctionalEstimate>,
    pub decoder_variation_norm: Option<AtomFunctionalEstimate>,
}
Expand description

Descriptive penalty-debiased POINT summaries of one fitted atom’s decoder curve (#1097, narrowed under #1115). Each field is a scalar functional of the atom’s inner smooth g_k(t), reported as a plug-in value and a one-step penalty-debiased value (the regularization bias relative to the conditional target is removed through the atom fit’s penalized Hessian). No standard error and no confidence interval are reported — by design (see below).

§Why these carry NO coverage claim (#1115)

Conditional on the fitted latent coordinates and assignment â, each functional is an ordinary linear functional of the penalized-WLS coefficients β with a well-defined conditional population value, and one-step debiasing validly removes the penalty bias for that conditional target. The point estimates are therefore meaningful. A standard error, however, would only be honest if and â were fixed/known. They are not: they are generated regressors estimated from the very activations that also form the response Z, so Z enters both the design (via t̂(Z), â(Z)) and the response. An influence-function SE built from the β-only Hessian and row scores carries no ∂t̂/∂Z / ∂â/∂Z channel — exactly the generated-regressor correction the marginal-slope family (#461 Stage 2) is defined by — so it omits a first-order variance term and is generally anti-conservative. Rather than ship an SE/CI that silently under-covers, this report exposes only the debiased point summaries; a coverage-valid interval would require either freezing the dictionary on a held-out split or propagating the generated-regressor Jacobian, neither of which the fixed inner-fit snapshot supports.

Fields§

§peak_contrast: Option<AtomFunctionalEstimate>

g(t_peak) − g(t_mode): the peak-vs-baseline contrast of the fitted decoder, penalty-debiased through the inner-fit Hessian. Point summary only (no coverage claim — see the type doc).

§average_value: Option<AtomFunctionalEstimate>

E_data[g(t_i)]: the data-averaged decoder value over the atom’s active rows, penalty-debiased. Point summary only.

§decoder_variation_norm: Option<AtomFunctionalEstimate>

E_data[∂g/∂t] along the atom’s leading latent axis: how much the fitted decoder curve varies across the data distribution, conditional on the fit. A descriptive variation measure of the fitted curve, NOT a population “marginal slope” (the latent coordinate is itself a fitted, generated regressor). Point summary only.

Despite the historical _norm suffix this is the signed mass-weighted mean derivative E_data[∂g/∂t] over the single leading axis, not a magnitude — it can be negative, and a value near 0 means the average slope cancels (a symmetric bump), not that the curve is flat. Use AtomSmoothSignificance::log_e_nonconstant for an honest non-constancy test; this field only describes the average local slope.

Trait Implementations§

Source§

impl Clone for AtomFunctionalReport

Source§

fn clone(&self) -> AtomFunctionalReport

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 Debug for AtomFunctionalReport

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> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

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

Source§

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V