X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FF_Zero.R;h=56bb4a5d4579a845453544d3099f4b66fb68ab2e;hb=4e821712ee4349b08a0ab3f6bcb35a00342ddef4;hp=247ab049def79dd8dd6b35f2e406be99704ecec6;hpb=469529710f56c790ae932b45d13fed2e34bcabf2;p=talweg.git diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R index 247ab04..56bb4a5 100644 --- a/pkg/R/F_Zero.R +++ b/pkg/R/F_Zero.R @@ -1,20 +1,19 @@ -#' @include Forecaster.R +#' Zero Forecaster #' -#' @title Zero Forecaster +#' Flat prediction: always forecast a serie of zeros. +#' This serie is then adjusted using the ".pjump" function (see \code{Forecaster} class). #' -#' @description Return 0 (and then adjust). Inherits \code{\link{Forecaster}} -ZeroForecaster = setRefClass( - Class = "ZeroForecaster", - contains = "Forecaster", +#' @usage # ZeroForecaster$new(pjump) +#' +#' @docType class +#' @format R6 class, inherits Forecaster +#' @aliases F_Zero +#' +ZeroForecaster = R6::R6Class("ZeroForecaster", + inherit = Forecaster, - methods = list( - initialize = function(...) - { - callSuper(...) - }, - predictShape = function(today, memory, horizon, ...) - { - rep(0., horizon) - } + public = list( + predictShape = function(data, today, memory, horizon, ...) + rep(0, horizon) ) )