optimizer_base< CONF > Struct Template Reference

Abstract optimizer base class. More...

#include <optimizer_base.h>

Inherited by optimizer_ptr< CONF > [virtual].

Public Member Functions
	BBM_IMPORT_CONFIG (CONF)
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 CONF>
requires concepts::config<CONF>
struct bbm::optimizer_base< CONF >

Abstract optimizer base class.

Forward declaration.

Constructor & Destructor Documentation

~optimizer_base()

virtual ~optimizer_base ( void  )

inlinevirtual

empty virtual base destructor

Member Function Documentation

BBM_IMPORT_CONFIG()

BBM_IMPORT_CONFIG

(

CONF

)

is_converged()

virtual Mask is_converged ( void  )

pure virtual

Check if the optimizer has converged.

Implemented in optimizer< OPT >, and optimizer_ptr< CONF >.

reset()

virtual void reset ( void  )

pure virtual

Reset the internal state of the optimizer.

Implemented in optimizer< OPT >, and optimizer_ptr< CONF >.

step()

virtual Value step ( void  )

pure virtual

Perform one optimization step towards minimizing the loss.

Returns

the loss before taking an optimzation step

Implemented in optimizer< OPT >, and optimizer_ptr< CONF >.

---

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

• include/bbm/optimizer_base.h