LoggerTime: Logger class to log the elapsed time

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

Description

This class just logs the elapsed time. This should be very handy if one wants to run the algorithm for just 2 hours and see how far he comes within that time. There are three time units available for logging:

• minutes

• seconds

• microseconds

Format

S4 object.

Usage

LoggerTime$new(use_as_stopper, max_time, time_unit)

Arguments

use_as_stopper [logical(1)]

Boolean to indicate if the logger should also be used as stopper.

max_time [integer(1)]

If the logger is used as stopper this argument contains the maximal time which are available to train the model.

time_unit [character(1)]

Character to specify the time unit. Possible choices are minutes, seconds or microseconds

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/classlogger_1_1_time_logger.html.

Fields

This class doesn't contain public fields.

Methods

summarizeLogger()

Summarize the logger object.

Examples

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

# Summarize logger:
log.time$summarizeLogger()

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