Skip to main content

FamilyLinearizationState

Struct FamilyLinearizationState 

Source
pub struct FamilyLinearizationState<'a> {
    pub beta: &'a [f64],
    pub family_scalars: Option<Arc<dyn Any + Send + Sync>>,
    pub channel_hessian: Option<Arc<dyn FamilyChannelHessian>>,
    pub probit_frailty_scale: f64,
}
Expand description

β-linearization state passed to BlockEffectiveJacobian::effective_jacobian_at.

At pre-fit initialization, pass beta = &[] / zeros and family_scalars = None. Families that need β-dependent scalars (e.g. survival marginal-slope’s q0, q1, g, c, z) store them in family_scalars as a concrete type behind Arc<dyn Any + Send + Sync> and downcast inside their impl.

Fields§

§beta: &'a [f64]§family_scalars: Option<Arc<dyn Any + Send + Sync>>

Optional family-shared scalars at this β linearization. Downcast via state.family_scalars.as_ref().and_then(|a| a.downcast_ref::<T>()).

§channel_hessian: Option<Arc<dyn FamilyChannelHessian>>

Optional per-subject channel Hessian for multi-output families. When Some, the identifiability canonicalisation step and the Gram builder use the channel-stacked Fisher information instead of the scalar-weight approximation. Single-output families leave this None.

§probit_frailty_scale: f64

Probit frailty scale factor s_f = 1/√(1+σ²).

For survival marginal-slope families the logslope η contribution is s_f · g · z, so any Jacobian callback that depends on g or z must read s_f from here rather than from a captured-at-construction value. When σ = 0 (no frailty) or for non-frailty families, set this to 1.0.

Since σ is always fixed (not jointly optimised with β) in the survival family, s_f is a static scalar for the entire inner fit; ∂s_f/∂σ never appears in the β-Jacobian. The field is nonetheless carried through state so that Jacobian callbacks are not required to capture s_f at spec-construction time — they can read it at evaluation time and thus stay correct across outer-loop σ updates.

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