DetrendAlgorithm

hrv_algos::analysis::dfa

Trait DetrendAlgorithm 

Source 
pub trait DetrendAlgorithm {
    // Required method
    fn detrend(&self, data: &[f64]) -> Result<Vec<f64>>;
}
Expand description

A trait representing a detrending algorithm for time series data.

Implementors of this trait should provide a method to remove trends from the given data.

§Example

use hrv_algos::analysis::dfa::DetrendAlgorithm;
use anyhow::Result;

struct MyDetrendAlgorithm;

impl DetrendAlgorithm for MyDetrendAlgorithm {
    fn detrend(&self, data: &[f64]) -> Result<Vec<f64>> {
        // Implementation goes here
        Ok(data.to_vec())
    }
}

Required Methods§

Source

fn detrend(&self, data: &[f64]) -> Result<Vec<f64>>

Removes trends from the provided data and returns the detrended data.

§Parameters
  • data: A slice of f64 values representing the time series data to be detrended.
§Returns

A Result containing a vector of f64 values representing the detrended data on success, or an error on failure.

Implementors§