Struct InvariantTestReport

Source

pub struct InvariantTestReport {
    pub name: String,
    pub category: InvariantCategory,
    pub samples: usize,
    pub failures: usize,
    pub failure_rate: f64,
    pub probability_bound: Option<f64>,
    pub verified: bool,
    pub sample_errors: Vec<GeometricError>,
    pub confidence_interval: Option<(f64, f64)>,
    pub confidence_level: Option<f64>,
}

Expand description

Result of running an invariant test suite

Fields§

§name: String

Name of the invariant

§category: InvariantCategory

Category (impossible, rare, emergent)

§samples: usize

Number of samples tested

§failures: usize

Number of failures

§failure_rate: f64

Observed failure rate (failures / samples)

§probability_bound: Option<f64>

Probability bound (for rare invariants)

§verified: bool

Whether the invariant was verified

§sample_errors: Vec<GeometricError>

Sample of failure errors (if any)

§confidence_interval: Option<(f64, f64)>

Confidence interval for the failure rate estimate (lower, upper)

Computed using Hoeffding-based bounds from amari-flynn. Only populated for Rare invariants verified with Monte Carlo.

§confidence_level: Option<f64>

Confidence level of the statistical verification (0.0 to 1.0)

Computed from the Hoeffding bound given sample count and epsilon.

Implementations§

Source §

impl InvariantTestReport

Source

pub fn is_violated(&self) -> bool

Check if the invariant was violated

Trait Implementations§

Source §

impl Clone for InvariantTestReport

Source §

fn clone(&self) -> InvariantTestReport

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl Debug for InvariantTestReport

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for InvariantTestReport

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Serialize for InvariantTestReport

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl UnwindSafe for InvariantTestReport

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