Struct FlipPool 

pub struct FlipPool { /* private fields */ }

Histogram-like value pool for determining if error map has significant differences.

This is how you can programmatically determine if images count as different.

Implementations

impl FlipPool

pub fn new() -> Self

Creates a new pool with 100 buckets.

pub fn with_buckets(bucket_count: usize) -> Self

Creates a new pool with the given amount of buckets.

pub fn from_image(image: &FlipImageFloat) -> Self

Creates a new pool and initializes the buckets with the values given image.

pub fn histogram(&mut self) -> FlipHistogram<'_>

Accesses the internal histogram of the pool.

pub fn min_value(&self) -> f32

Gets the minimum value stored in the pool.

Returns 0.0 if no values have been added to the pool.

pub fn max_value(&self) -> f32

Gets the maximum value stored in the pool.

Returns 0.0 if no values have been added to the pool.

pub fn mean(&self) -> f32

Gets the mean value stored in the pool.

Returns 0.0 if no values have been added to the pool.

pub fn get_weighted_percentile(&self, percentile: f64) -> f64

Gets the given weighted percentile [0.0, 1.0] from the pool.

I currently do not understand the difference between this and Self::get_percentile with weighted = true, except that this function uses doubles and doesn’t require mutation of internal state.

Returns 0.0 if no values have been added to the pool.

pub fn get_percentile(&mut self, percentile: f32, weighted: bool) -> f32

Get the value of the given percentile [0.0, 1.0] from the pool.

If weighted is true, is almost equivalent to Self::get_weighted_percentile.

Returns 0.0 if no values have been added to the pool.

pub fn update_with_image(&mut self, image: &FlipImageFloat)

Updates the given pool with the contents of the given image.

pub fn clear(&mut self)

Clears the pool.

Trait Implementations

impl Default for FlipPool

fn default() -> Self

Returns the “default value” for a type.

impl Drop for FlipPool

fn drop(&mut self)

Executes the destructor for this type.

impl Send for FlipPool

impl Sync for FlipPool