Skip to main content

InnerSolutionBuilder

Struct InnerSolutionBuilder 

Source
pub struct InnerSolutionBuilder<'dp> { /* private fields */ }
Expand description

Builder for InnerSolution that provides sensible defaults and auto-computes derived quantities (nullspace_dim).

Implementations§

Source§

impl<'dp> InnerSolutionBuilder<'dp>

Source

pub fn new( log_likelihood: f64, penalty_quadratic: f64, beta: Array1<f64>, n_observations: usize, hessian_op: Arc<dyn HessianOperator>, penalty_coords: Vec<PenaltyCoordinate>, penalty_logdet: PenaltyLogdetDerivs, dispersion: DispersionHandling, ) -> Self

Create a builder with the required core fields.

Source

pub fn deriv_provider(self, p: Box<dyn HessianDerivativeProvider + 'dp>) -> Self

Source

pub fn firth_term(self, term: Option<ExactJeffreysTerm>) -> Self

Install a pre-built Jeffreys/Firth term (Tier-A operator-backed via ExactJeffreysTerm::new, or the Tier-B value-only carrier via ExactJeffreysTerm::value_only).

Source

pub fn hessian_logdet_correction(self, correction: f64) -> Self

Source

pub fn penalty_subspace_trace( self, kernel: Option<Arc<PenaltySubspaceTrace>>, ) -> Self

Install the projected-logdet trace kernel that pairs with the hessian_logdet_correction on a rank-deficient penalty surface. See PenaltySubspaceTrace for the derivation and when it is required for gradient consistency.

Source

pub fn rho_curvature_scale(self, scale: f64) -> Self

Source

pub fn rho_prior(self, prior: RhoPrior) -> Self

Source

pub fn nullspace_dim_override(self, dim: f64) -> Self

Override the auto-computed nullspace dimension.

By default, build() computes nullspace_dim as beta.len() - sum(penalty_coord.rank()). Use this when the caller has a different authoritative value (e.g. from stored per-penalty dims).

Source

pub fn ext_coords(self, coords: Vec<HyperCoord>) -> Self

Source

pub fn ext_coord_pair_fn( self, f: Box<dyn Fn(usize, usize) -> HyperCoordPair + Send + Sync>, ) -> Self

Source

pub fn rho_ext_pair_fn( self, f: Box<dyn Fn(usize, usize) -> HyperCoordPair + Send + Sync>, ) -> Self

Source

pub fn fixed_drift_deriv(self, f: FixedDriftDerivFn) -> Self

Source

pub fn contracted_psi_second_order( self, f: Option<ContractedPsiSecondOrderFn>, ) -> Self

Install the direction-contracted second-order ψ hook (#740). When set, the outer-Hessian operator builder uses it instead of the per-pair base_h2 ψψ assembly. See ContractedPsiSecondOrderFn.

Source

pub fn barrier_config(self, config: Option<BarrierConfig>) -> Self

Source

pub fn kkt_residual(self, residual: Option<ProjectedKktResidual>) -> Self

Source

pub fn active_constraints( self, block: Option<Arc<ActiveLinearConstraintBlock>>, ) -> Self

Stash the active linear-inequality constraint block carried alongside the inner solution. Used by PenaltySubspaceTrace::with_active_constraints at REML/LAML evaluation time to form the constraint-aware kernel K_T = K_S − K_S Aᵀ (A K_S Aᵀ)⁻¹ A K_S.

Source

pub fn build(self) -> InnerSolution<'dp>

Build the InnerSolution, auto-computing nullspace_dim from penalty coordinates.

Auto Trait Implementations§

§

impl<'dp> !RefUnwindSafe for InnerSolutionBuilder<'dp>

§

impl<'dp> !UnwindSafe for InnerSolutionBuilder<'dp>

§

impl<'dp> Freeze for InnerSolutionBuilder<'dp>

§

impl<'dp> Send for InnerSolutionBuilder<'dp>

§

impl<'dp> Sync for InnerSolutionBuilder<'dp>

§

impl<'dp> Unpin for InnerSolutionBuilder<'dp>

§

impl<'dp> UnsafeUnpin for InnerSolutionBuilder<'dp>

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