R/class_printer.R

In schalkdaniel/compboost: Efficient Component-Wise Boosting Implementation

# Helper functions:
# -----------------

glueLoss = function(name, definition = NULL, additional_desc = "") {
  if (is.null(definition)) {
    definition = "No function specified, probably you are using a custom loss."
  } else {
    definition = paste0("L(y,x) = ", definition)
  }

  sout = sprintf("%s: %s\n\n%s", name, definition, additional_desc)
  #ignore_me = glue::glue("

    #{name} Loss:

      #{definition}

      #{additional_desc}

    #")

  cat(sout)
  return(invisible(paste0(name, "Printer")))
}

# ---------------------------------------------------------------------------- #
# Response:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_ResponseRegr")
ignore_me = setMethod("show", "Rcpp_ResponseRegr", function(object) {

  cat("\n")
  cat("Regression response of target \"", object$getTargetName(), "\"", sep = "")
  cat("\n\n")

  return("ResponseRegrPrinter")
})

setClass("Rcpp_ResponseBinaryClassif")
ignore_me = setMethod("show", "Rcpp_ResponseBinaryClassif", function(object) {

  cat("\n")
  cat("Binary classification response of target \"", object$getTargetName(), "\" and threshold ", object$getThreshold(), sep = "")
  cat("\n\n")

  return("ResponseBinaryClassifPrinter")
})


# ---------------------------------------------------------------------------- #
# Data:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_InMemoryData")
ignore_me = setMethod("show", "Rcpp_InMemoryData", function(object) {

  cat("\n")

  if (object$getIdentifier() == "") {
    # data.type = "target"
    cat("Empty data object which can be used as target data.")
  } else {
    # data.type = "source"
    cat("Source Data: In memory class of feature ", object$getIdentifier(), ".")
    cat("\n             Note that using this class as target will override data specified before.")
  }

  cat("\n\n")

  return("InMemoryDataPrinter")
})

# ---------------------------------------------------------------------------- #
# Factories:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_BaselearnerPolynomial")
ignore_me = setMethod("show", "Rcpp_BaselearnerPolynomial", function(object) {
  cat("\n")
  object$summarizeFactory()
  cat("\n\n")

  return("BaselearnerPolynomialPrinter")
})

setClass("Rcpp_BaselearnerPSpline")
ignore_me = setMethod("show", "Rcpp_BaselearnerPSpline", function(object) {
  cat("\n")
  object$summarizeFactory()
  cat("\n\n")

  return("BaselearnerPSplinePrinter")
})

setClass("Rcpp_BaselearnerCustom")
ignore_me = setMethod("show", "Rcpp_BaselearnerCustom", function(object) {
  cat("\n")
  object$summarizeFactory()
  cat("\n\n")

  return("BaselearnerCustomPrinter")
})

setClass("Rcpp_BaselearnerCustomCpp")
ignore_me = setMethod("show", "Rcpp_BaselearnerCustomCpp", function(object) {
  cat("\n")
  object$summarizeFactory()
  cat("\n\n")

  return("BaselearnerCustomCppPrinter")
})

# ---------------------------------------------------------------------------- #
# BlearnerFacotryList:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_BlearnerFactoryList")
ignore_me = setMethod("show", "Rcpp_BlearnerFactoryList", function(object) {
  cat("\n")
  object$printRegisteredFactories()
  cat("\n\n")

  # For testing:
  return(invisible("BlearnerFactoryListPrinter"))
})


# ---------------------------------------------------------------------------- #
# Loss:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_LossQuadratic")
ignore_me = setMethod("show", "Rcpp_LossQuadratic", function(object) {
  glueLoss("LossQuadratic", "0.5 * (y - f(x))^2")
})

setClass("Rcpp_LossAbsolute")
ignore_me = setMethod("show", "Rcpp_LossAbsolute", function(object) {
  glueLoss("LossAbsolute", "|y - f(x)|")
})

setClass("Rcpp_LossQuantile")
ignore_me = setMethod("show", "Rcpp_LossQuantile", function(object) {
  glueLoss("LossQuantile", "h|y - f(x)|", paste0(
  "h = 2q        if  y - f(x) > 0\n",
  "  h = 2(1 - q)  otherwise\n\n",
  "  with quantile q = ", object$getQuantile(), "\n"))
})

setClass("Rcpp_LossHuber")
ignore_me = setMethod("show", "Rcpp_LossHuber", function(object) {
  glueLoss("LossHuber", "if (y - f(x) < d) { 0.5(y - f(x))^2 } else { d|y - f(x)| - 0.5d^2 }", paste0(
  "  with delta d = ", object$getDelta(), "\n"))
})

setClass("Rcpp_LossBinomial")
ignore_me = setMethod("show", "Rcpp_LossBinomial", function(object) {
  glueLoss("LossBinomial", "log(1 + exp(-2yf(x))")
})

setClass("Rcpp_LossCustom")
ignore_me = setMethod("show", "Rcpp_LossCustom", function(object) {
  glueLoss("LossCustom")
})

setClass("Rcpp_LossCustomCpp")
ignore_me = setMethod("show", "Rcpp_LossCustomCpp", function(object) {
  glueLoss("LossCustomCpp")
})

# ---------------------------------------------------------------------------- #
# Logger:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_LoggerIteration")
ignore_me = setMethod("show", "Rcpp_LoggerIteration", function(object) {
  cat("\n")
  object$summarizeLogger()
  cat("\n\n")

  return("LoggerIterationPrinter")
})

setClass("Rcpp_LoggerInbagRisk")
ignore_me = setMethod("show", "Rcpp_LoggerInbagRisk", function(object) {
  cat("\n")
  object$summarizeLogger()
  cat("\n\n")

  return("LoggerInbagRiskPrinter")
})

setClass("Rcpp_LoggerOobRisk")
ignore_me = setMethod("show", "Rcpp_LoggerOobRisk", function(object) {
  cat("\n")
  object$summarizeLogger()
  cat("\n\n")

  return("LoggerOobRiskPrinter")
})

setClass("Rcpp_LoggerTime")
ignore_me = setMethod("show", "Rcpp_LoggerTime", function(object) {
  cat("\n")
  object$summarizeLogger()
  cat("\n\n")

  return("LoggerTimePrinter")
})

# ---------------------------------------------------------------------------- #
# Loggerlist:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_LoggerList")
ignore_me = setMethod("show", "Rcpp_LoggerList", function(object) {
  cat("\n")
  if (object$getNumberOfRegisteredLogger() == 0) {
    cat("No registered logger!")
  } else {
    object$printRegisteredLogger()
  }
  cat("\n\n")

  return("LoggerListPrinter")
})

# ---------------------------------------------------------------------------- #
# Optimizer:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_OptimizerCoordinateDescent")
ignore_me = setMethod("show", "Rcpp_OptimizerCoordinateDescent", function(object) {
  cat("\n")
  cat("Coordinate Descent optimizer\n")
  cat("\n\n")

  return(invisible("OptimizerCoordinateDescentPrinter"))
})

setClass("Rcpp_OptimizerCoordinateDescentLineSearch")
ignore_me = setMethod("show", "Rcpp_OptimizerCoordinateDescentLineSearch", function(object) {
  cat("\n")
  cat("Cordinate Descent optimizer with line search\n")
  cat("\n\n")

  return(invisible("OptimizerCoordinateDescentLineSearchPrinter"))
})


# ---------------------------------------------------------------------------- #
# Compboost:
# ---------------------------------------------------------------------------- #

setClass("Rcpp_Compboost_internal")
ignore_me = setMethod("show", "Rcpp_Compboost_internal", function(object) {
  cat("\n")
  object$summarizeCompboost()
  cat("\n\n")

  return(invisible("CompboostInternalPrinter"))
})