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(logger_id, use_as_stopper, max_time, time_unit)

Arguments

logger_id [character(1)]

Unique identifier of the logger.

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

Fields

This class doesn't contain public fields.

Methods

summarizeLogger()

Summarize the logger object.

Examples

# Define logger: log_time = LoggerTime$new("time_minutes", FALSE, 20, "minutes") # Summarize logger: log_time$summarizeLogger()
#> Time logger: #> - Tracked time unit: minutes