Skip to main content

OverlapRefuter

Struct OverlapRefuter 

Source
pub struct OverlapRefuter {
    pub eps: f64,
    pub min_ess_fraction: f64,
    pub glm_options: GlmOptions,
}
Expand description

Overlap / positivity assessment.

No silent propensity rebuild: when problem.original.overlap_report is Some (the original estimate came from a propensity-based estimator), that report is reused verbatim. When it is None (the linear-adjustment path, which deliberately skips propensity via OverlapPolicy::ExplicitOverride), this refuter fits its own diagnostic-only logistic propensity model on the adjustment covariates — explicitly, and only to populate the diagnostics this check needs. That fit never feeds back into the original point estimate.

Fields§

§eps: f64

Minimum acceptable margin from the propensity boundary: pass requires propensities in [eps, 1 - eps].

§min_ess_fraction: f64

Minimum acceptable fraction of effective sample size retained (ess / n).

§glm_options: GlmOptions

GLM options used only for the diagnostic-only fit (linear-adjustment path).

Implementations§

Source§

impl OverlapRefuter

Source

pub fn new() -> Self

Defaults: eps = 0.05, min_ess_fraction = 0.5.

Source

pub fn refute( &self, problem: &RefutationProblem<'_>, ) -> Result<RefutationReport, ValidationError>

Run the overlap / positivity refuter.

Complete separation / non-converged diagnostic GLM fits are treated as overlap failures (extreme propensities), not as hard errors.

§Errors

Data failures while building a diagnostic-only propensity fit.

Source

pub fn refute_with_propensity( &self, problem: &RefutationProblem<'_>, propensity: &mut PropensityWorkspace, ) -> Result<RefutationReport, ValidationError>

Like Self::refute, reusing a warmed propensity workspace for diagnostic fits.

§Errors

Data failures while building a diagnostic-only propensity fit.

Trait Implementations§

Source§

impl Clone for OverlapRefuter

Source§

fn clone(&self) -> OverlapRefuter

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 OverlapRefuter

Source§

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

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

impl Default for OverlapRefuter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> Validator<RefutationProblem<'a>> for OverlapRefuter

Source§

type Prepared = PreparedRefutation<'a>

Prepared artifact produced by Self::prepare.
Source§

type Report = RefutationReport

Report produced by Self::validate.
Source§

fn prepare( &self, artifact: &RefutationProblem<'a>, _ctx: &ExecutionContext, ) -> Result<Self::Prepared, ValidationError>

Compile artifact into a reusable prepared form. Read more
Source§

fn validate( &self, prepared: &mut Self::Prepared, _workspace: &mut EstimationWorkspace, _ctx: &ExecutionContext, ) -> Result<Self::Report, ValidationError>

Run the check on a prepared artifact. 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> ForeignBufferOwner for T
where T: Send + Sync + Debug + 'static,

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