LoggerList: Logger list class to collect all loggers

In compboost: C++ Implementation of Component-Wise Boosting

Description

This class is meant to define all logger which should be used to track the progress of the algorithm.

Format

S4 object.

Usage

LoggerList$new()

Details

This class is a wrapper around the pure C++ implementation. To see the functionality of the C++ class visit https://schalkdaniel.github.io/compboost/cpp_man/html/classloggerlist_1_1_logger_list.html.

Fields

This class doesn't contain public fields.

Methods

clearRegisteredLogger()

Removes all registered logger from the list. The used logger are not deleted, just removed from the map.

getNamesOfRegisteredLogger()

Returns the registered logger names as character vector.

getNumberOfRegisteredLogger()

Returns the number of registered logger as integer.

printRegisteredLogger()

Prints all registered logger.

registerLogger(logger.id, logger)

Includes a new logger into the logger list with the logger.id as key.

Examples

# Define logger:
log.iters = LoggerIteration$new(TRUE, 100)
log.time = LoggerTime$new(FALSE, 20, "minutes")

# Create logger list:
logger.list = LoggerList$new()

# Register new loggeR:
logger.list$registerLogger("iteration", log.iters)
logger.list$registerLogger("time", log.time)

# Print registered logger:
logger.list$printRegisteredLogger()

# Important: The keys has to be unique:
logger.list$registerLogger("iteration", log.iters)

# Still just two logger:
logger.list$printRegisteredLogger()

# Remove all logger:
logger.list$clearRegisteredLogger()

# Get number of registered logger:
logger.list$getNumberOfRegisteredLogger()

compboost documentation built on May 2, 2019, 6:40 a.m.