Skip to main content

BlockWorkingSet

Enum BlockWorkingSet 

Source
pub enum BlockWorkingSet {
    Diagonal {
        working_response: Array1<f64>,
        working_weights: Array1<f64>,
    },
    ExactNewton {
        gradient: Array1<f64>,
        hessian: SymmetricMatrix,
    },
}
Expand description

Working quantities supplied by a custom family for one block.

§Observed vs expected information (see response.md Section 3)

For the outer REML/LAML criterion, the Hessian used in log|H| and trace terms must be the observed (actual) Hessian at the mode, not the expected Fisher.

  • ExactNewton: provides -nabla^2 log L directly, which is the observed Hessian by construction. This is always correct.

  • Diagonal: provides IRLS working weights W such that the per-block Hessian is X’WX. For canonical links (logit-Binomial, log-Poisson), W_obs = W_Fisher. For supported non-canonical diagonal links, W must be the observed weight W_obs = W_Fisher - (y-mu)*B so the outer REML uses the exact Laplace Hessian. The matching CustomFamily::diagonalworking_weights_directional_derivative callback must differentiate the same observed W surface; silently using Fisher weights or zero dW would change the criterion into a PQL-type surrogate.

Variants§

§

Diagonal

Standard IRLS/GLM-style diagonal working set for eta-space updates.

Fields

§working_response: Array1<f64>

IRLS pseudo-response for this block’s linear predictor.

§working_weights: Array1<f64>

IRLS working weights for this block (non-negative, length n).

For the inner solver, Fisher or observed weights both find the same mode. For the outer REML/LAML log|H| term, observed weights are the correct Laplace choice (see response.md Section 3). Canonical-link families need no correction since observed = Fisher.

§

ExactNewton

Exact Newton block update in coefficient space.

gradient is nabla log L wrt block coefficients. hessian is -nabla^2 log L wrt block coefficients (positive semidefinite near optimum).

This is the observed Hessian by construction (actual second derivative of the log-likelihood), which is the correct quantity for the outer REML Laplace approximation.

Fields

§gradient: Array1<f64>

Implementations§

Source§

impl BlockWorkingSet

Source

pub fn diagonal_checked( working_response: Array1<f64>, working_weights: Array1<f64>, ) -> Result<Self, String>

Construct a Diagonal working set with the length invariant (working_response.len() == working_weights.len()) enforced at the type boundary. Use this from any new code path that produces a diagonal IRLS block; the legacy struct-literal form is preserved for existing call sites pending a full migration.

Trait Implementations§

Source§

impl Clone for BlockWorkingSet

Source§

fn clone(&self) -> BlockWorkingSet

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 BlockWorkingSet

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