update documention, fix package to compete with 'method Bruno'

[talweg.git] / pkg / R / F_Zero.R

diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R
index fdfee83..21e6e00 100644 (file)
--- a/pkg/R/F_Zero.R
+++ b/pkg/R/F_Zero.R
@@ -1,13 +1,18 @@
-#' @include Forecaster.R
-#'
 #' Zero Forecaster
 #'
-#' Return 0 (and then adjust). Inherits \code{\link{Forecaster}}
+#' Flat prediction: always forecast a serie of zeros (adjusted by 'pjump' function).
+#'
+#' @usage # ZeroForecaster$new(pjump)
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Zero
+#'
 ZeroForecaster = R6::R6Class("ZeroForecaster",
        inherit = Forecaster,
 
        public = list(
-               predictShape = function(today, memory, horizon, ...)
-                       rep(0., horizon)
+               predictShape = function(data, today, memory, predict_from, horizon, ...)
+                       rep(0, (horizon-predict_from+1))
        )
 )