R/AlgorithmStorage.R

In ja-thomas/hyperbandr:

#' @title R6 class to create algorithmStorage objects
#' @format \code{\link{R6Class}} object
#'
#' @description
#' An \code{\link[R6]{R6Class}} to save the results from each algorithm object, automatically created 
#' when a new algorithm object is created.
#' 
#' @field config [\code{string}]\cr
#' An algorithm configuration
#' @field budget [\code{string}]\cr
#' The current budget
#' @field model [\code{string}]\cr
#' A model
#' @field performance [\code{string}]\cr
#' A performance function
#'
#' @section Methods:
#' \code{$attachLines(newline)} rbind a new rows \code{newline} to the data.matrix of the algorithmStorage object \cr
#'
#' @return Algorithm object
#' @export


algorithmStorage = R6Class("AlgorithmStorage",
  public = list(
    data.matrix = NULL,
    col.names = NULL,
    row.names = NULL,
    # initialize the algorithmStorage object
    initialize = function(config, budget, model, performance, problem) {
      self$data.matrix = data.frame(config, budget, performance(model, problem))
      self$col.names = c(names(config), "current_budget", "y")
      self$row.names = 1:length(dim(self$data.matrix)[[1]])
      colnames(self$data.matrix) = self$col.names
      rownames(self$data.matrix) = self$row.names
    },
    # method to rbind a new line to the data.matrix
    attachLine = function(newline) {
      self$data.matrix = rbind(self$data.matrix, newline)
      rownames(self$data.matrix) = 1:dim(self$data.matrix)[[1]]  
      #colnames(self$data.matrix) = self$col.names
    }
  )
)