LoggerIteration: Logger class to log the current iteration

Description Format Usage Arguments Details Fields Methods Examples

Description

This class seems to be useless, but it gives more control about the algorithm and doesn't violate the idea of object programming here. Additionally, it is quite convenient to have this class instead of tracking the iteration at any stage of the fitting within the compboost object as another vector.

Format

S4 object.

Usage

1
LoggerIterationWrapper$new(use_as_stopper, max_iterations)

Arguments

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

1
2
3
4
5
# Define logger:
log.iters = LoggerIteration$new(FALSE, 100)

# Summarize logger:
log.iters$summarizeLogger()

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