Skip to main content

QuantileForecaster

Struct QuantileForecaster 

Source
pub struct QuantileForecaster { /* private fields */ }
Expand description

Wraps a ForecastModel with empirical, horizon-aware quantile intervals.

§Example

use chronix_analytics::forecast::{
    HoltWintersModel, QuantileConfig, QuantileForecaster,
};

let config = QuantileConfig::central(0.9, 24);

let mut qf = QuantileForecaster::new(
    || Box::new(HoltWintersModel::new(Some(0.3), Some(0.1), Some(0.1), Some(24), false)),
    config,
);
qf.fit(&timestamps, &values)?;

let forecast = qf.predict(24)?;
let p05 = forecast.level(0.05).expect("requested level");

Implementations§

Source§

impl QuantileForecaster

Source

pub fn new<F>(factory: F, config: QuantileConfig) -> Self
where F: Fn() -> Box<dyn ForecastModel> + Send + Sync + 'static,

Build a forecaster from a model factory.

factory must return a fresh, unfitted model on every call.

Source

pub fn fit( &mut self, timestamps: &[i64], values: &[f64], ) -> Result<(), ForecastError>

Fit the underlying model and calibrate the residual distribution.

§Errors

Returns ForecastError::InvalidInput if the configuration is invalid or the series is too short to produce a single rolling origin, or propagates the underlying model’s fit errors.

Source

pub fn predict(&self, horizon: usize) -> Result<QuantileForecast, ForecastError>

Produce point forecasts plus calibrated quantiles for horizon steps.

Horizons beyond the calibrated range reuse the last calibrated step’s residual distribution, which is the most conservative available estimate rather than a silent extrapolation.

§Errors

Returns ForecastError::NotFitted if fit has not been called, or propagates the underlying model’s prediction errors.

Source

pub fn predict_interval( &self, horizon: usize, level: f64, ) -> Result<ForecastResult, ForecastError>

Rewrite a ForecastResult’s bounds using the calibrated empirical quantiles, keeping the existing API shape.

§Errors

As predict.

Source

pub fn calibration_size(&self, h: usize) -> usize

Number of calibration residuals collected for horizon step h (1-based). Returns 0 for uncalibrated horizons.

Source

pub fn model(&self) -> &dyn ForecastModel

The wrapped model.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more