Skip to main content

Detector

Struct Detector 

Source
pub struct Detector {
    pub recall: f64,
    pub false_positive_rate: f64,
}
Expand description

A detector’s prevalence-independent behaviour.

Fields§

§recall: f64

Fraction of genuinely bad merges it flags. Carries across populations.

§false_positive_rate: f64

Fraction of genuinely good merges it flags anyway. Carries across populations, and is the number that decides everything at low prevalence.

Implementations§

Source§

impl Detector

Source

pub fn from_reported( precision: f64, recall: f64, prevalence: f64, ) -> Result<Self, String>

Recovers the prevalence-independent behaviour from a paper’s reported precision and recall at that paper’s corpus prevalence.

§Errors

Inputs outside 0.0..=1.0, a zero precision or recall (nothing to recover), or a corpus prevalence of 1.0 (no negatives to have produced the reported false positives).

Source

pub fn precision_at(&self, prevalence: f64) -> f64

Precision this detector reaches at prevalence.

Returns 0.0 when it would flag nothing at all, which is the honest reading: a detector that never fires has no precision to speak of.

Source

pub fn false_alarms_per_hit(&self, prevalence: f64) -> Option<f64>

False alarms per true alarm at prevalence — the number an on-call human actually experiences. None when it never fires on a true positive, so the ratio is undefined rather than infinite.

Trait Implementations§

Source§

impl Clone for Detector

Source§

fn clone(&self) -> Detector

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 Detector

Source§

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

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

impl PartialEq for Detector

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Detector

Source§

impl StructuralPartialEq for Detector

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