ConstLearningRate Class Reference

Detailed Description

This implements the const learning rate class for a descent-based minimizer.

This class gives a const learning rate during descent update.

Definition at line 45 of file ConstLearningRate.h.

Inheritance diagram for ConstLearningRate:

Public Member Functions
	ConstLearningRate ()
virtual	~ConstLearningRate ()
virtual void	set_const_learning_rate (float64_t learning_rate)
virtual float64_t	get_learning_rate (int32_t iter_counter)
virtual void	update_context (CMinimizerContext *context)
virtual void	load_from_context (CMinimizerContext *context)

Protected Attributes
float64_t	m_const_learning_rate

Constructor & Destructor Documentation

ConstLearningRate

(

)

Constructor

Definition at line 49 of file ConstLearningRate.h.

virtual ~ConstLearningRate ( )

virtual

Destructor

Definition at line 52 of file ConstLearningRate.h.

Member Function Documentation

virtual float64_t get_learning_rate ( int32_t  iter_counter )

virtual

Get the learning rate for descent direction Note that the learning rate usually is positive

Parameters

iter_counter

the number of iterations

Returns

the learning rate (A.K.A step size/length)

Implements LearningRate.

Definition at line 72 of file ConstLearningRate.h.

virtual void load_from_context ( CMinimizerContext *  context )

virtual

Return a context object which stores mutable variables Usually it is used in serialization.

Returns

a context object

Implements LearningRate.

Definition at line 92 of file ConstLearningRate.h.

virtual void set_const_learning_rate ( float64_t  learning_rate )

virtual

Set the const learning rate

Parameters

learning_rate

learning_rate must be positive and usually is not greater than 1.0

Definition at line 58 of file ConstLearningRate.h.

virtual void update_context ( CMinimizerContext *  context )

virtual

Update a context object to store mutable variables

Parameters

context

a context object

Implements LearningRate.

Definition at line 82 of file ConstLearningRate.h.

Member Data Documentation

float64_t m_const_learning_rate

protected

const_learning_rate

Definition at line 100 of file ConstLearningRate.h.

---

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

• ConstLearningRate.h