pub struct FixedEffectsModel;Expand description
Entity fixed-effects (within) estimator.
Removes entity-specific heterogeneity by demeaning each variable by the corresponding entity mean, then applies OLS.
§Example (illustrative)
use scirs2_stats::panel::fixed_effects::FixedEffectsModel;
use scirs2_core::ndarray::{Array1, Array2};
// 3 entities × 4 periods = 12 observations, 2 regressors
let n = 12;
let x = Array2::<f64>::ones((n, 2));
let y = Array1::<f64>::ones(n);
let entity: Vec<usize> = (0..3).flat_map(|e| std::iter::repeat(e).take(4)).collect();
let time: Vec<usize> = (0..4).cycle().take(n).collect();
let result = FixedEffectsModel::fit(&x.view(), &y.view(), &entity, &time, false)
.expect("fit failed");
println!("Coefficients: {:?}", result.coefficients);Implementations§
Source§impl FixedEffectsModel
impl FixedEffectsModel
Sourcepub fn fit<F>(
x: &ArrayView2<'_, F>,
y: &ArrayView1<'_, F>,
entity: &[usize],
time: &[usize],
two_way: bool,
) -> StatsResult<FEResult<F>>where
F: Float + Sum + Debug + Display + NumAssign + One + ScalarOperand + FromPrimitive + Send + Sync + 'static,
pub fn fit<F>(
x: &ArrayView2<'_, F>,
y: &ArrayView1<'_, F>,
entity: &[usize],
time: &[usize],
two_way: bool,
) -> StatsResult<FEResult<F>>where
F: Float + Sum + Debug + Display + NumAssign + One + ScalarOperand + FromPrimitive + Send + Sync + 'static,
Fit a one-way (entity) or two-way (entity + time) fixed-effects model.
§Arguments
x– design matrix (N × K), without intercept or dummiesy– response vector (N)entity– entity IDs, 0-indexed, length Ntime– time period IDs, 0-indexed, length Ntwo_way– iftrue, also absorb time fixed effects
Auto Trait Implementations§
impl Freeze for FixedEffectsModel
impl RefUnwindSafe for FixedEffectsModel
impl Send for FixedEffectsModel
impl Sync for FixedEffectsModel
impl Unpin for FixedEffectsModel
impl UnsafeUnpin for FixedEffectsModel
impl UnwindSafe for FixedEffectsModel
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.