Struct windowed_stats::experimental::series::TimeMatrix

pub struct TimeMatrix<F, P>
where
    F: BufferStrategy<F::Aggregation, P> + Statistic,
    P: Interpolation<FillSample<F> = F::Sample>,
{ /* private fields */ }

One or more statistical round-robin time series.

A time matrix is a round-robin multi-resolution time series that samples and interpolates timed data, computes statistical aggregations for elapsed sampling intervals, and buffers those aggregations. The sample data, statistic, and interpolation of series in a time matrix must be the same, but the sampling intervals can and should differ.

Implementations

impl<F, P> TimeMatrix<F, P>

where F: BufferStrategy<F::Aggregation, P> + Statistic, P: Interpolation<FillSample<F> = F::Sample>,

pub fn new( profile: impl Into<SamplingProfile>, interpolation: P::State<F>, ) -> Self

where F: Default,

Constructs a time matrix with the given sampling profile and interpolation.

Statistics are default initialized.

pub fn with_statistic( profile: impl Into<SamplingProfile>, interpolation: P::State<F>, statistic: F, ) -> Self

Constructs a time matrix with the given statistic.

pub fn fold_and_get_buffers( &mut self, sample: TimedSample<F::Sample>, ) -> Result<SerializedBuffer, FoldError>

where FoldError: From<F::Error>,

Folds the given sample and interpolations and gets the aggregation buffers.

To fold a sample without serializing buffers, use Sampler::fold.

impl<F, R, P, A> TimeMatrix<PostAggregation<F, R>, P>

where PostAggregation<F, R>: BufferStrategy<A, P>, F: Default + Statistic, R: Clone + Fn(F::Aggregation) -> A, P: InterpolationFor<PostAggregation<F, R>>, A: Clone,

pub fn with_transform( profile: impl Into<SamplingProfile>, interpolation: P::State<PostAggregation<F, R>>, transform: R, ) -> Self

where R: Clone,

Constructs a time matrix with the default statistic and given transform for post-aggregation.

Trait Implementations

impl<F, P> Clone for TimeMatrix<F, P>

where F: BufferStrategy<F::Aggregation, P> + Statistic + Clone, P: Interpolation<FillSample<F> = F::Sample>, <F as BufferStrategy<Aggregation<F>, P>>::Buffer: Clone, P::State<F>: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F, P> Debug for TimeMatrix<F, P>

where F: BufferStrategy<F::Aggregation, P> + Statistic + Debug, P: Interpolation<FillSample<F> = F::Sample>, F::Sample: Debug, F::Aggregation: Debug, <F as BufferStrategy<Aggregation<F>, P>>::Buffer: Debug, P::State<F>: Debug,

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

Formats the value using the given formatter.

impl<F, P> Default for TimeMatrix<F, P>

where F: BufferStrategy<F::Aggregation, P> + Default + Statistic, P: Interpolation<FillSample<F> = F::Sample>, P::State<F>: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<F, P> Interpolator for TimeMatrix<F, P>

where FoldError: From<F::Error>, F: BufferStrategy<F::Aggregation, P> + Statistic, P: Interpolation<FillSample<F> = F::Sample>,

type Error = FoldError

fn interpolate(&mut self, timestamp: Timestamp) -> Result<(), Self::Error>

Interpolates samples to the given timestamp.

fn interpolate_and_get_buffers( &mut self, timestamp: Timestamp, ) -> Result<SerializedBuffer, Self::Error>

Interpolates samples to the given timestamp and gets the serialized aggregation buffers.

impl<F, P> Sampler<TimedSample<<F as Statistic>::Sample>> for TimeMatrix<F, P>

where FoldError: From<F::Error>, F: BufferStrategy<F::Aggregation, P> + Statistic, P: Interpolation<FillSample<F> = F::Sample>,

type Error = FoldError

The type of error that can occur when folding samples into the sampler.

fn fold(&mut self, timed: TimedSample<F::Sample>) -> Result<(), Self::Error>

impl<F, P> RoundRobinSampler<<F as Statistic>::Sample> for TimeMatrix<F, P>

where FoldError: From<F::Error>, F: BufferStrategy<F::Aggregation, P> + Statistic, P: Interpolation<FillSample<F> = F::Sample>,