Enum TimeSeriesError 

#[non_exhaustive]
pub enum TimeSeriesError {
    ValueNotFinite {
        index: usize,
    },
    TooFewObservations {
        needed: usize,
        got: usize,
    },
    OptionOutOfRange {
        option: &'static str,
        got: f64,
        min: f64,
        max: f64,
    },
    NoVariation,
    DegenerateRegression,
}

Why a time-series statistic was refused: crate::correlation::acf, crate::correlation::pacf, crate::testing::adf_test and crate::testing::kpss_test.

The data is checked before the options, and the options before any computation: a refusal of an option never hides a refusal of the data, and TimeSeriesError::NoVariation / TimeSeriesError::DegenerateRegression only follow options that were in range.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ValueNotFinite

The series holds a NaN or an infinity.

Fields

index: usize

Position of the first such value.

TooFewObservations

Fewer observations than the statistic is defined for.

Fields

needed: usize

The fewest it takes.

got: usize

How many were given.

OptionOutOfRange

An option outside its domain, which depends on the number of observations: min and max are both inclusive.

Fields

option: &'static str

The option’s name, spelled as the wire formats spell it (max_lag, max_lags, lags).

got: f64

The value given (a count as a float).

min: f64

Inclusive lower bound.

max: f64

Inclusive upper bound.

NoVariation

The series does not vary (about its level, or its trend, for the KPSS test) beyond the rounding of its own size, so the statistic divides by zero.

DegenerateRegression

The ADF test regression is singular, or fits the differences exactly (a deterministic series), so the t-ratio is undefined.

Implementations

impl TimeSeriesError

pub fn out_of( option: &'static str, got: f64, domain: &RangeInclusive<usize>, ) -> Self

option set to got, outside domain – the refusal a caller that reads the option itself (negative, or past what a count holds) gives against a domain such as crate::correlation::acf_max_lag_domain.

Trait Implementations

impl Clone for TimeSeriesError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TimeSeriesError

impl Debug for TimeSeriesError

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

Formats the value using the given formatter.

impl Display for TimeSeriesError

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

Formats the value using the given formatter.

impl Error for TimeSeriesError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for TimeSeriesError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TimeSeriesError