Skip to main content

LpeerResult

Struct LpeerResult 

Source
#[non_exhaustive]
pub struct LpeerResult { pub beta: Vec<f64>, pub intercept: f64, pub w_bar: Vec<f64>, pub fitted_values: Vec<f64>, pub sigma2_subject: f64, pub sigma2_resid: f64, pub n_subjects: usize, pub lambda: f64, pub penalty_type: PeerPenalty, pub gcv: Option<f64>, pub lambda_method: LambdaMethod, }
Expand description

Result of the lpeer longitudinal PEER estimator.

Carries the estimated coefficient function β(t), subject-level variance components, and the penalty configuration used — all on the argvals grid.

Both variance components are non-negative (clamped to a positive floor by famm::fit_scalar_mixed_model).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§beta: Vec<f64>

Estimated coefficient function β(t), length m (on the argvals grid).

§intercept: f64

Intercept (= ȳ, the mean of the response vector). Matches peer() convention.

§w_bar: Vec<f64>

Column means of the Simpson-weighted design W[i,j] = data[(i,j)]·w[j], length m. Computed identically to peer() so predict reproduces training fitted_values exactly.

§fitted_values: Vec<f64>

Fitted values ŷ_i (marginal, fixed-effect only), length n.

§sigma2_subject: f64

Between-subject variance σ²_u (≥ 0). Estimated by REML EM inside famm::fit_scalar_mixed_model; clamped to a positive floor.

§sigma2_resid: f64

Residual variance σ²_ε (≥ 0). Estimated by REML EM; clamped to a positive floor.

§n_subjects: usize

Number of unique subjects derived from subject_map.

§lambda: f64

Smoothing parameter λ that was used (from PeerConfig).

§penalty_type: PeerPenalty

Penalty family that was used.

§gcv: Option<f64>

GCV score at the selected λ. Some(score) when LambdaMethod::Gcv ran; None for LambdaMethod::Fixed or LambdaMethod::Reml.

§lambda_method: LambdaMethod

Which λ-selection path ran.

Implementations§

Source§

impl LpeerResult

Source

pub fn predict( &self, new_data: &FdMatrix, argvals: &[f64], ) -> Result<Vec<f64>, FdarError>

Predict scalar responses for new functional observations (marginal prediction).

Applies the fitted coefficient function β(t) to new_data via the same formula as PeerResult::predict: new-subject random effect = 0 (marginal / fixed-effect-only prediction).

Self-consistency: re-passing the training data and argvals reproduces the training fitted_values to within 1e-9.

§Errors

Returns FdarError::InvalidDimension when new_data.ncols() or argvals.len() does not equal the number of training grid points m.

Trait Implementations§

Source§

impl Clone for LpeerResult

Source§

fn clone(&self) -> LpeerResult

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 LpeerResult

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for LpeerResult

Source§

fn eq(&self, other: &LpeerResult) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LpeerResult

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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