intermediate: R6, too slow
[talweg.git] / pkg / R / Data.R
index 27aa082..d970f7b 100644 (file)
 #' @importFrom R6 R6Class
 #'
 #' @export
-Data = R6Class("Data",
+Data = R6::R6Class("Data",
        private = list(
-               .data = "list"
+               .data = list()
        ),
        public = list(
-               initialize = function(...)
-                       initialize(self, private, ...)
-               ,
                getSize = function()
-                       getSize(private)
+                       getSizeData(private)
                ,
                getStdHorizon = function()
-                       getStdHorizon(private)
+                       getStdHorizonData(private)
                ,
                append = function(new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
-                       append(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
+                       appendData(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
                ,
                getTime = function(index)
-                       getTime(self, private, index)
+                       getTimeData(self, private, index)
                ,
                getCenteredSerie = function(index)
-                       getCenteredSerie(self, private, index)
+                       getCenteredSerieData(self, private, index)
                ,
                getLevel = function(index)
-                       getLevel(self, private, index)
+                       getLevelData(self, private, index)
                ,
                getSerie = function(index)
-                       getSerie(self, private, index)
+                       getSerieData(self, private, index)
                ,
                getExo = function(index)
-                       getExo(self, private, index)
+                       getExoData(self, private, index)
                ,
                getExoHat = function(index)
-                       getExoHat(self, private, index)
+                       getExoHatData(self, private, index)
        )
 )
 
-##TODO: @param... @inheritParams...
-
-#' Initialize empty Data object
-initialize = function(o, private, ...)
-{
-       private$.data <<- if (hasArg("data")) list(...)$data else list()
-       invisible(o)
-}
-
 #' Number of series in the dataset
-getSize = function(private)
+#'
+#' @param private List of private members in current object
+getSizeData = function(private)
        length(private$.data)
 
 #' 'Standard' horizon, from t+1 to midnight
-getStdHorizon = function(private)
+#'
+#' @inheritParams getSizeData
+getStdHorizonData = function(private)
        24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1
 
 #' Acquire a new vector of lists (time, centered_serie, level, exo, exo_hat)
-append = function(private, new_time, new_centered_serie, new_level, new_exo_hat, new_exo)
+#'
+#' @inheritParams getSizeData
+#' @param new_time Time
+#' @param new_centered_serie Centered serie
+#' @param new_level Level
+#' @param new_exo Exogneous variables
+#' @param new_exo_hat Predicted exogenous variables
+appendData = function(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
 {
-       private$.data[[length(private$.data)+1]] <<- list("time"=new_time,
+       private$.data[[length(private$.data)+1]] <- list("time"=new_time,
                "centered_serie"=new_centered_serie,"level"=new_level,"exo"=new_exo,"exo_hat"=new_exo_hat)
 }
 
 #' Time values at specified index
-getTime = function(o, private, index)
+#'
+#' @inheritParams getSizeData
+#' @param index Return value at this index
+getTimeData = function(o, private, index)
 {
        index = dateIndexToInteger(index, o)
        private$.data[[index]]$time
 }
 
 #' Centered serie values at specified index
-getCenteredSerie = function(o, private, index)
+#'
+#' @inheritParams getTimeData
+getCenteredSerieData = function(o, private, index)
 {
        index = dateIndexToInteger(index, o)
-       private$.data[[index]]$serie
+       private$.data[[index]]$centered_serie
 }
 
 #' Level of the serie at specified index
-getCenteredSerie = function(o, private, index)
+#'
+#' @inheritParams getTimeData
+getLevelData = function(o, private, index)
 {
        index = dateIndexToInteger(index, o)
        private$.data[[index]]$level
 }
 
 #' Serie values (centered+level) at specified index
-getCenteredSerie = function(o, private, index)
+#'
+#' @inheritParams getTimeData
+getSerieData = function(o, private, index)
 {
        index = dateIndexToInteger(index, o)
-       private$.data[[index]]$serie + data[[index]]$level
+       private$.data[[index]]$centered_serie + data[[index]]$level
 }
 
 #' Exogenous measures at specified index
-getCenteredSerie = function(o, private, index)
+#'
+#' @inheritParams getTimeData
+getExoData = function(o, private, index)
 {
        index = dateIndexToInteger(index, o)
        private$.data[[index]]$exo
 }
 
 #' Exogeous predictions at specified index
-getCenteredSerie = function(o, private, index)
+#'
+#' @inheritParams getTimeData
+getExoHatData = function(o, private, index)
 {
        index = dateIndexToInteger(index, o)
        private$.data[[index]]$exo_hat