Struct flintec_lpp::TimeLoad

pub struct TimeLoad {
    pub time: Vec<DateTime<FixedOffset>>,
    pub load: Vec<f64>,
}

The main struct for the load time series.

Fields

time: Vec<DateTime<FixedOffset>>

load: Vec<f64>

Implementations

impl TimeLoad

pub fn new(capacity: usize) -> TimeLoad

Initiate a new TimeLoad instance using the given capacity for the time and load vectors

pub fn from_csv<P>(fin: P) -> TimeLoad where
    P: AsRef<Path>, 

Initiate a TimeLoad from csv setting load to NAN in case of load parsing errors, but panic for datatime errors. Do not check the continuity of the time series and presence of error flags, these are checked separately afterwards

pub fn is_ordered(&self)

pub fn is_ordered_and_continuous(&self)

pub fn fill_missing_with_nan(&self) -> TimeLoad

Fill the datetime gaps with NAN to have continuous datetime. Take a reference to the read TimeLoad and return a new continuous TimeLoad. In fact, build a continuous datetime Vec and then match it with the load Vec? Use the minimum time interval in the data to determine the desired time step for the output.

pub fn replace_bad_datetimes_with_nan(
    &mut self,
    bad_datetimes: Vec<DateTime<FixedOffset>>
)

Replace all values measured at the bad datetimes nan. Need to be given as DateTime for correct and easier comparison.

pub fn replace_bad_time_interval_with_nan(
    &mut self,
    time_init: NaiveTime,
    time_stop: NaiveTime
)

Replace all values measured within the time interval with nan. Given in standard time, fixed offset for the chosen timezone.

pub fn replace_outliers_with_nan(&mut self, min_load: f64, max_load: f64)

Set to NAN all the load values that are out of the expected range.

pub fn replace_errors_with_nan(&mut self, max_value: f64)

Consider all the values > max_value as invalid and replace them with NAN. These high values are used for the errors.

pub fn to_csv<P>(self, fout: P) where
    P: AsRef<Path>, 

Write the datetime and load columns to a csv file at the given path. Use RFC 3339 - ISO 8601 for datetime.

pub fn plot_datetime<P>(&self, fout: P) -> Result<(), Box<dyn Error>> where
    P: AsRef<Path>, 

Plot the load time series to svg.

Trait Implementations

impl Clone for TimeLoad

fn clone(&self) -> TimeLoad

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeLoad

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

Formats the value using the given formatter.

impl Display for TimeLoad

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

Formats the value using the given formatter.