@krzysztofsztompka/garch
    Preparing search index...

    Type Alias GarchFit

    A fitted model: its parameters, likelihood and criteria, variance path, the optima reached, and inference when asked.

    type GarchFit = {
        aic: number;
        backcast: number;
        bic: number;
        conditionalVariance: Float64Array;
        converged: boolean;
        extendedBy: number;
        inference: Inference | null;
        lastExogenous: number | null;
        lastResidual: number;
        logLikelihood: number;
        mean: MeanModel;
        model: GarchModel;
        modes: readonly GarchMode[];
        nuBound: "lower" | "upper" | null;
        parameterCount: number;
        params: GarchParams;
        persistence: number;
        varianceTarget: number | null;
    }
    Index
    aic: number

    −2·ln L + 2k, as arch reports it.

    backcast: number

    The pre-sample variance the recursion started from — its log for EGARCH.

    bic: number

    −2·ln L + k·ln n, as arch reports it.

    conditionalVariance: Float64Array

    s_t for every observation, in the returns' units squared.

    converged: boolean
    extendedBy: number

    Returns appended by extendFit since the parameters were estimated: 0 for a fit from fitGarch. Above 0, the parameters, inference and modes are the estimate's; the variance path, lastResidual, the log-likelihood and the criteria cover the whole series.

    inference: Inference | null
    lastExogenous: number | null

    GARCH-X: x_T, the last exogenous value — what s_{T+1} takes. null without one.

    lastResidual: number

    e_T, the last residual.

    logLikelihood: number
    mean: MeanModel
    model: GarchModel
    modes: readonly GarchMode[]

    Every distinct optimum the starts reached, best first — modes[0] is the fit. More than one means the likelihood is multimodal on this series.

    nuBound: "lower" | "upper" | null

    For t innovations: the ν the likelihood wanted lies beyond a bound, and the fit is the constrained optimum with ν held there. null when ν is interior, and for normal innovations.

    parameterCount: number

    The free parameters the criteria count: μ (constant mean), ω (unless targeted), α, β, γ (gjr, egarch), ν (t, unless held on a bound), λ (skewed t).

    params: GarchParams
    persistence: number
    varianceTarget: number | null

    Under variance targeting, the unconditional variance ω was tied to: the returns' variance about their sample mean (about 0 for a zero mean). null when ω was estimated.