Skip to main content

FairnessEvidence

sim_lib_numbers_stats

Struct FairnessEvidence

pub struct FairnessEvidence {
    pub reference_selected: u64,
    pub reference_total: u64,
    pub comparison_selected: u64,
    pub comparison_total: u64,
    pub reference_rate: f64,
    pub comparison_rate: f64,
    pub ratio: f64,
    pub threshold: f64,
    pub passes_four_fifths: bool,
}

Expand description

Evidence carried by the disparate-impact fairness Claim.

Fields§

§reference_selected: u64

Number of selected cases in the reference group.

§reference_total: u64

Total cases in the reference group.

§comparison_selected: u64

Number of selected cases in the comparison group.

§comparison_total: u64

Total cases in the comparison group.

§reference_rate: f64

Selection rate for the reference group.

§comparison_rate: f64

Selection rate for the comparison group.

§ratio: f64

Comparison rate divided by reference rate.

§threshold: f64

Four-fifths rule threshold.

§passes_four_fifths: bool

Whether ratio >= threshold.

Implementations§

impl FairnessEvidence

pub fn new( reference_selected: u64, reference_total: u64, comparison_selected: u64, comparison_total: u64, ) -> StatsResult<Self>

Computes evidence for a disparate-impact Claim from validated counts.

pub fn table_value(&self, factory: &dyn Factory) -> Result<Value>

Returns the evidence as a browsable runtime table.

Trait Implementations§

impl Clone for FairnessEvidence

fn clone(&self) -> FairnessEvidence

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

impl Debug for FairnessEvidence

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

Formats the value using the given formatter. Read more

impl PartialEq for FairnessEvidence

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for FairnessEvidence

Auto Trait Implementations§

impl Freeze for FairnessEvidence

impl RefUnwindSafe for FairnessEvidence

impl Send for FairnessEvidence

impl Sync for FairnessEvidence

impl Unpin for FairnessEvidence

impl UnsafeUnpin for FairnessEvidence

impl UnwindSafe for FairnessEvidence

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.