Struct time_func::TimeFunc

pub struct TimeFunc(pub Vec<(DateTime<Utc>, f64)>);

A vector of data points that we can use to analyse time series data. Each data point is valid from the previous timestamp until its current timestamp. If it is the first point of data then it is only valid for a total time of 0.

                .B
          |    /\    |
          |   /  \   |
          |  /    \  |
          | /      \ |
         A./        \.C
__________|__________|_________
Invalid   |  Valid   |  Invalid
_______________________________
          .     .    .
          A     B    C

Tuple Fields

0: Vec<(DateTime<Utc>, f64)>

Implementations

impl TimeFunc

pub fn new() -> Self

Creates an empty TimeFunc

pub fn get_moving_average(&self, time: DateTime<Utc>, duration: Duration) -> f64

Gets the average of the function from time, to time - duration This function isn’t perfects acurate as it uses the closest available indeces, and does not interpolate

pub fn get_integral_interpolated(
    &self,
    time: DateTime<Utc>,
    duration: Duration
) -> f64

Gets the average of the function from time, to time - duration This function interpolates the function and uses exact positions

pub fn get_average_interpolated(
    &self,
    time: DateTime<Utc>,
    duration: Duration
) -> f64

Gets the linear interpolated average of the function

pub fn get_rms(&self, duration: Duration, time: DateTime<Utc>) -> f64

Get’s the normalized RMS Does not use interpolation as of yet

pub fn get_rms_timefunc(&self, duration: Duration) -> Self

pub fn get_inflation(&self, duration: Duration, time: DateTime<Utc>) -> f64

pub fn get_inflation_interpolated(
    &self,
    duration: Duration,
    time: DateTime<Utc>
) -> f64

pub fn get_inflation_timefunc(&self, duration: Duration) -> Self

pub fn get_inflation_interpolated_timefunc(&self, duration: Duration) -> Self

pub fn get_index(&self, time: &DateTime<Utc>) -> Result<usize, usize>

pub fn get_index_safe(&self, time: &DateTime<Utc>) -> usize

pub fn get_index_above(&self, time: &DateTime<Utc>) -> usize

pub fn get_index_below(&self, time: &DateTime<Utc>) -> usize

pub fn get_fractional_index(
    &self,
    time: &DateTime<Utc>
) -> Result<f64, Box<dyn Error>>

Returns the fractional index of a specific time

pub fn get_value(&self, time: DateTime<Utc>) -> f64

pub fn get_value_interpolated(&self, time: &DateTime<Utc>) -> f64

pub fn push(&mut self, point: (DateTime<Utc>, f64)) -> Result<(), Box<dyn Error>>

pub fn verify(&self) -> Result<(), Box<dyn Error>>

Verifies that the timefunc is valid. Checks to ensure the list is sorted and deduped.

pub fn dedup(&mut self)

Executed dedup Assumes vec is sorted.

pub fn is_deduped(&self) -> bool

Verifies that the function is deduped Assumes vec is sorted is sorted.

pub fn repair(&mut self)

Fixes the TimeFunc by sorting it.

pub fn draw(&self, title: String) -> Result<(), Box<dyn Error>>

Trait Implementations

impl Clone for TimeFunc

fn clone(&self) -> TimeFunc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeFunc

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

Formats the value using the given formatter.

impl Default for TimeFunc

fn default() -> TimeFunc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeFunc

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

Deserialize this value from the given Serde deserializer.

impl Div<TimeFunc> for TimeFunc

type Output = TimeFunc

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<Vec<(DateTime<Utc>, f64), Global>> for TimeFunc

fn from(input: Vec<(DateTime<Utc>, f64)>) -> Self

Converts to this type from the input type.

impl Mul<TimeFunc> for TimeFunc

type Output = TimeFunc

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Serialize for TimeFunc

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

Serialize this value into the given Serde serializer.