Struct hotsax::anomaly::Anomaly

pub struct Anomaly<'a, N: Float> { /* fields omitted */ }

Provides easy access to the HOT SAX and brute force algorithms, by using the builder pattern. The only necessary algorithmic parameter is the size of the discord itself. The rest have default values, namely:

• sax_word_length = 3
• alpha = 3
• use_brute_force = false

Methods

impl<'a, N: Float> Anomaly<'a, N>

pub fn with(data: &'a Vec<N>, discord_size: usize) -> Self

Sets up the data and the discord size to be used.

By default it uses:

• sax_word_length: 3
• alpha: 3
• algo: Algorithm::HOTSAX
• dim_reduce: 0 (disabled)

pub fn use_algo(&mut self, algo: Algorithm) -> &mut Self

Determines the exact algorithm to use.

pub fn sax_word_length(&mut self, n: usize) -> &mut Self

Sets the length of the SAX words to use.

pub fn use_slice(&mut self, range: impl RangeBounds<usize>) -> &mut Self

Specifies to only use a slice of the dataset.

pub fn dim_reduce(&mut self, new_len: usize) -> &mut Self

Applies PAA to the data. This is only useful if run with the bruteforce algorithm in mind.

pub fn alpha(&mut self, n: usize) -> &mut Self

Sets the alphabet size to be used. The only valid values should be in the range 3..=7.

Panics

• When n is set to an invalid value.

pub fn find_largest_discord(&self) -> Option<(f64, usize)>

Finds the largest discord. If one couldn't be found, this function returns a None instead.

pub fn find_n_largest_discords(&self, discord_amnt: usize) -> Vec<(f64, usize)>

Finds the top n largest discords. The vector returned can have less than n elements if less than n discords could be found.

pub fn find_discords_min_dist(&self, min_dist: f64) -> Vec<(f64, usize)>

Finds all discords with a measured distance above min_dist.