Logger class to log the current iteration

Logger class to log the current iteration

Format

S4 object.

Usage

LoggerIterationWrapper$new(logger_id, use_as_stopper, max_iterations)

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_iterations [integer(1)]

If the logger is used as stopper this argument defines the maximal iterations.

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_iteration_logger.html.

Fields

This class doesn't contain public fields.

Methods

summarizeLogger()

Summarize the logger object.

Examples

# Define logger:
log_iters = LoggerIteration$new("iterations", FALSE, 100)

# Summarize logger:
log_iters$summarizeLogger()
#> Iteration logger:
#> 	- Maximal iterations: 100
#> 	- Use logger as stopper: 0