Skip to main content

ExternalOptimOptions

gam_solve::estimate

Struct ExternalOptimOptions 

Source 
pub struct ExternalOptimOptions {
Show 18 fields
    pub family: LikelihoodSpec,
    pub latent_cloglog: Option<LatentCLogLogState>,
    pub mixture_link: Option<MixtureLinkSpec>,
    pub optimize_mixture: bool,
    pub sas_link: Option<SasLinkSpec>,
    pub optimize_sas: bool,
    pub compute_inference: bool,
    pub skip_rho_posterior_inference: bool,
    pub max_iter: usize,
    pub tol: f64,
    pub nullspace_dims: Vec<usize>,
    pub linear_constraints: Option<LinearInequalityConstraints>,
    pub firth_bias_reduction: Option<bool>,
    pub penalty_shrinkage_floor: Option<f64>,
    pub rho_prior: RhoPrior,
    pub kronecker_penalty_system: Option<KroneckerPenaltySystem>,
    pub kronecker_factored: Option<KroneckerFactoredBasis>,
    pub persist_warm_start_disk: bool,

}

Fields§

§family: LikelihoodSpec§latent_cloglog: Option<LatentCLogLogState>§mixture_link: Option<MixtureLinkSpec>§optimize_mixture: bool§sas_link: Option<SasLinkSpec>§optimize_sas: bool§compute_inference: bool§skip_rho_posterior_inference: bool

Internal lifecycle knob for fits whose result will be immediately superseded. Keeps ordinary inference work but skips the live-objective rho posterior certificate/escalation until the returned model is known.

§max_iter: usize§tol: f64§nullspace_dims: Vec<usize>§linear_constraints: Option<LinearInequalityConstraints>§firth_bias_reduction: Option<bool>

Optional explicit Firth override for external fitting families that support Jeffreys/Firth bias reduction.

  • Some(true): force Firth on
  • Some(false): force Firth off
  • None: use family default behavior
§penalty_shrinkage_floor: Option<f64>

Relative shrinkage floor for penalized block eigenvalues. See FitOptions::penalty_shrinkage_floor for details.

§rho_prior: RhoPrior

Fixed prior on smoothing parameters for explicit joint HMC sampling flows. Standard fitting stays on the REML/Laplace path.

§kronecker_penalty_system: Option<KroneckerPenaltySystem>

Kronecker-factored penalty system for tensor-product smooth terms.

§kronecker_factored: Option<KroneckerFactoredBasis>

Full Kronecker factored basis for P-IRLS factored reparameterization.

§persist_warm_start_disk: bool

Engage the cross-process ON-DISK persistent warm-start layer for this fit. Default false: only the in-memory warm start runs, so throwaway / replicate / CI-coverage loops pay no disk I/O (#1082). A caller that wants cross-process resume threads true down from FitConfig::persist_warm_start_disk; the standard RemlState constructor then calls enable_persistent_warm_start_disk().

Trait Implementations§

Source§

impl Clone for ExternalOptimOptions

Source§

fn clone(&self) -> ExternalOptimOptions

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

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