Improve documentation
[talweg.git] / pkg / R / F_Zero.R
... / ...
CommitLineData
1#' Zero Forecaster
2#'
3#' Flat prediction: always forecast a serie of zeros.
4#' This serie is then adjusted using the ".pjump" function (see \code{Forecaster} class).
5#'
6#' @docType class
7#' @format R6 class, inherits Forecaster
8#' @alias F_Zero
9#'
10ZeroForecaster = R6::R6Class("ZeroForecaster",
11 inherit = Forecaster,
12
13 public = list(
14 predictShape = function(data, today, memory, horizon, ...)
15 rep(0, horizon)
16 )
17)