optimizer< OPT > Class Template Reference

OPTIMIZER implementation of a optimization algorithm. More...

#include <optimizer.h>

Inherits optimizer_base< get_config< OPT > >, and OPT.

Public Member Functions
	BBM_IMPORT_CONFIG (OPT)
	optimizer (const OPT &opt)
	Directly construct from a OPTimization algorithm.
virtual Value	step (void) override final
	Virtual passthrough of the 'step' method.
virtual void	reset (void) override final
	Virtual passthrough of the 'reset' method.
virtual Mask	is_converged (void) override final
	Virtual passthrough of the 'is_converged' method.
Public Member Functions inherited from optimizer_base< get_config< OPT > >
	BBM_IMPORT_CONFIG (get_config< OPT >)
virtual	~optimizer_base (void)
	empty virtual base destructor
virtual Value	step (void)=0
	Perform one optimization step towards minimizing the loss.
virtual void	reset (void)=0
	Reset the internal state of the optimizer.
virtual Mask	is_converged (void)=0
	Check if the optimizer has converged.

Detailed Description

template<typename OPT>
requires concepts::optimization_algorithm<OPT>
class bbm::optimizer< OPT >

OPTIMIZER implementation of a optimization algorithm.

Template Parameters

OPT	= the optimization algorithm

Constructor & Destructor Documentation

optimizer()

optimizer ( const OPT &  opt )

inline

Directly construct from a OPTimization algorithm.

Member Function Documentation

BBM_IMPORT_CONFIG()

BBM_IMPORT_CONFIG

(

OPT

)

is_converged()

virtual Mask is_converged ( void  )

inlinefinaloverridevirtual

Virtual passthrough of the 'is_converged' method.

Implements optimizer_base< get_config< OPT > >.

reset()

virtual void reset ( void  )

inlinefinaloverridevirtual

Virtual passthrough of the 'reset' method.

Implements optimizer_base< get_config< OPT > >.

step()

virtual Value step ( void  )

inlinefinaloverridevirtual

Virtual passthrough of the 'step' method.

Returns

the current loss

Implements optimizer_base< get_config< OPT > >.

---

The documentation for this class was generated from the following file:

• include/bbm/optimizer.h