Log functions {optimbase}

Optimbase Log functions

Description

optimbase.logstartup initializes logging if verbose logging is enabled (via the verbose element of the optimization object). If the logging has already been initialized, it generates an error and stops the optimization.

If verbose logging is enabled, optimbase.log prints the given message in the console. If verbose logging is disabled, it does nothing. If the logfile element of the optimization object has been set, it writes the message into the file instead of writing to the console.

optimbase.stoplog prints the given stopping rule message if verbose termination is enabled (via the verbosetermination element of the optimization object). If verbose termination is disabled, it does nothing.

optimbase.logshutdown turns verbose logging off.

Usage

  optimbase.logstartup(this = NULL)
  optimbase.log(this = NULL, msg = NULL)
  optimbase.stoplog(this = NULL, msg = NULL)
  optimbase.logshutdown(this = NULL)

Arguments

this

The optimization object.

msg

The message to print.

Value

All functions return the unchanged optimization object.

Author(s)

Author of Scilab optimbase module: Michael Baudin (INRIA - Digiteo)

Author of R adaptation: Sebastien Bihorel ([e-mail])