Struct sliding_extrema::SlidingExtrema

pub struct SlidingExtrema<T: Clone, F: ExtremumFunction<T>> { /* private fields */ }

T is the datatype of the items in the queue. F is a function that compares two items and returns the extreme value. I.e, if you’re implementing a ‘max’-function, F should be a function returning the largest of two values.

Implementations

impl<T: Clone, F: ExtremumFunction<T>> SlidingExtrema<T, F>

pub fn new(extremum: F) -> SlidingExtrema<T, F>

Create a new empty queue with the given comparator. Note that using this function, the comparator can be stateful.

impl<T: Clone> SlidingExtrema<T, CustomExtremum<T>>

pub fn new_dynamic( extremum: fn(_: &T, _: &T) -> T ) -> SlidingExtrema<T, CustomExtremum<T>>

Create a new empty queue with the given comparator-function. This allows the function to be varied at runtime, without making the implementing closure/function type be a part of the SlidingExtrema-type instantiation. Note, the comparator must be stateless. Typically, finding the min/max between two functions doesn’t require any state. But if it does, use the ‘new’ function and implement the trait ‘ExtremumFunction’.

impl<T: Clone, F: ExtremumFunction<T>> SlidingExtrema<T, F>

pub fn len(&self) -> usize

Return the number of elements in the queue

pub fn get_extrema(&self) -> Option<T>

Get the current extreme value of all the items in the queue. Performance is amortized O(1)

pub fn push(&mut self, value: T)

Add a value to the queue. Performance is amortized O(1)

pub fn pop(&mut self) -> Option<T>

Remove a value from the queue. Performance is amortized O(1)

Trait Implementations

impl<T: Clone + Debug, F: ExtremumFunction<T>> Debug for SlidingExtrema<T, F>

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

Formats the value using the given formatter.