roboptim::OptimizationLogger< T > Class Template Reference

Log the optimization process (values, Jacobians, time taken etc.). More...

#include <roboptim/core/optimization-logger.hh>

Public Types
typedef T	solver_t
typedef solver_t::problem_t	problem_t
typedef solver_t::problem_t::value_type	value_type
typedef solver_t::problem_t::size_type	size_type
typedef solver_t::problem_t::vector_t	vector_t
typedef solver_t::solverState_t	solverState_t
typedef solver_t::callback_t	callback_t
typedef solver_t::problem_t::function_t::traits_t	traits_t
typedef solver_t::problem_t::function_t	function_t
typedef function_t::matrix_t	jacobian_t
typedef function_t::const_argument_ref	const_argument_ref
typedef GenericDifferentiableFunction< traits_t >	differentiableFunction_t

Public Member Functions
	OptimizationLogger (solver_t &solver, const boost::filesystem::path &path, bool selfRegister=true)
	Constructor.
virtual	~OptimizationLogger ()
	Destructor.
void	append (const std::string &text)
	Append extra information to the log file.
callback_t	callback ()
	Return the callback function.
const boost::filesystem::path &	logPath () const
	Return the path of the log directory.

Protected Member Functions
void	perIterationCallback (const problem_t &pb, const solverState_t &state)
virtual void	perIterationCallbackUnsafe (const typename solver_t::problem_t &pb, const typename solver_t::solverState_t &state)
const boost::filesystem::path &	path () const
	Return the path of the log directory.
boost::filesystem::path &	path ()
	Return the path of the log directory.
const solver_t &	solver () const
	Return the solver associated with the logger.
solver_t &	solver ()
	Return the solver associated with the logger.
unsigned	callbackCallId () const
	Return the callback iteration index.

Detailed Description

template<typename T>
class roboptim::OptimizationLogger< T >

Log the optimization process (values, Jacobians, time taken etc.).

Template Parameters

T	solver type.

Member Typedef Documentation

callback_t

template<typename T>

typedef solver_t::callback_t roboptim::OptimizationLogger< T >::callback_t

const_argument_ref

template<typename T>

typedef function_t::const_argument_ref roboptim::OptimizationLogger< T >::const_argument_ref

differentiableFunction_t

template<typename T>

typedef GenericDifferentiableFunction<traits_t> roboptim::OptimizationLogger< T >::differentiableFunction_t

function_t

template<typename T>

typedef solver_t::problem_t::function_t roboptim::OptimizationLogger< T >::function_t

jacobian_t

template<typename T>

typedef function_t::matrix_t roboptim::OptimizationLogger< T >::jacobian_t

problem_t

template<typename T>

typedef solver_t::problem_t roboptim::OptimizationLogger< T >::problem_t

size_type

template<typename T>

typedef solver_t::problem_t::size_type roboptim::OptimizationLogger< T >::size_type

solver_t

template<typename T>

typedef T roboptim::OptimizationLogger< T >::solver_t

solverState_t

template<typename T>

typedef solver_t::solverState_t roboptim::OptimizationLogger< T >::solverState_t

traits_t

template<typename T>

typedef solver_t::problem_t::function_t::traits_t roboptim::OptimizationLogger< T >::traits_t

value_type

template<typename T>

typedef solver_t::problem_t::value_type roboptim::OptimizationLogger< T >::value_type

vector_t

template<typename T>

typedef solver_t::problem_t::vector_t roboptim::OptimizationLogger< T >::vector_t

Constructor & Destructor Documentation

OptimizationLogger()

template<typename T>

roboptim::OptimizationLogger< T >::OptimizationLogger ( solver_t & solver, const boost::filesystem::path & path, bool selfRegister = true )

explicit

Constructor.

Parameters

solver	solver that will be logged.
path	path to the log directory.
selfRegister	whether the logger will register itself as a callback with the solver. Set this to false if you use it with a multiplexer.

References roboptim::iendl(), path(), ROBOPTIM_CORE_VERSION, and solver().

~OptimizationLogger()

template<typename T>

roboptim::OptimizationLogger< T >::~OptimizationLogger ( )

virtual

Destructor.

CSV files are written in this destructor.

References roboptim::iendl().

Member Function Documentation

append()

template<typename T>

void roboptim::OptimizationLogger< T >::append

(

const std::string &

text

)

Append extra information to the log file.

Parameters

text	text to append.

References roboptim::iendl().

callback()

template<typename T>

OptimizationLogger< T >::callback_t roboptim::OptimizationLogger< T >::callback

(

)

Return the callback function.

This can be used with a callback multiplexer.

Returns

callback function.

References perIterationCallback().

callbackCallId()

template<typename T>

unsigned roboptim::OptimizationLogger< T >::callbackCallId ( ) const

protected

Return the callback iteration index.

Returns

callback iteration index.

logPath()

template<typename T>

const boost::filesystem::path & roboptim::OptimizationLogger< T >::logPath

(

)

const

Return the path of the log directory.

Note

Seeing that the non-const version of path () needs to be protected, we need to rename this function to make it public, since overload resolution takes place before accessibility checks.

Returns

path of the log directory.

path() [1/2]

template<typename T>

boost::filesystem::path & roboptim::OptimizationLogger< T >::path ( )

protected

Return the path of the log directory.

This method is protected since streams would need to be updated, and files that were already written moved to the new location.

Returns

path of the log directory.

path() [2/2]

template<typename T>

const boost::filesystem::path & roboptim::OptimizationLogger< T >::path ( ) const

protected

Return the path of the log directory.

Note

This function should not be made public since the non-const version is protected.

Returns

path of the log directory.

Referenced by OptimizationLogger().

perIterationCallback()

template<typename T>

void roboptim::OptimizationLogger< T >::perIterationCallback ( const problem_t & pb, const solverState_t & state )

protected

References perIterationCallbackUnsafe().

Referenced by callback().

perIterationCallbackUnsafe()

template<typename T>

void roboptim::OptimizationLogger< T >::perIterationCallbackUnsafe ( const typename solver_t::problem_t & pb, const typename solver_t::solverState_t & state )

protectedvirtual

References roboptim::decindent(), roboptim::iendl(), and roboptim::incindent().

Referenced by perIterationCallback().

solver() [1/2]

template<typename T>

OptimizationLogger< T >::solver_t & roboptim::OptimizationLogger< T >::solver ( )

protected

Return the solver associated with the logger.

Returns

solver associated with the logger.

solver() [2/2]

template<typename T>

const OptimizationLogger< T >::solver_t & roboptim::OptimizationLogger< T >::solver ( ) const

protected

Return the solver associated with the logger.

Returns

solver associated with the logger.

Referenced by OptimizationLogger().