DescendCorrection类 参考

详细描述

This is a base class for descend based correction method.

The interfact will be used in DescendUpdaterWithCorrection::update_variable() An example of descend based correction is NesterovMomentumCorrection

在文件 DescendCorrection.h 第 57 行定义.

类 DescendCorrection 继承关系图:

Public 成员函数
	DescendCorrection ()
virtual	~DescendCorrection ()
virtual void	set_correction_weight (float64_t weight)
virtual DescendPair	get_corrected_descend_direction (float64_t negative_descend_direction, index_t idx)=0
virtual void	update_context (CMinimizerContext *context)=0
virtual void	load_from_context (CMinimizerContext *context)=0

Protected 属性
float64_t	m_weight

构造及析构函数说明

DescendCorrection

(

)

在文件 DescendCorrection.h 第 62 行定义.

virtual ~DescendCorrection ( )

virtual

在文件 DescendCorrection.h 第 68 行定义.

成员函数说明

virtual DescendPair get_corrected_descend_direction ( float64_t  negative_descend_direction, index_t  idx  )

pure virtual

Get corrected descend direction

参数

negative_descend_direction	the negative descend direction
idx	the index of the direction

返回

DescendPair (corrected descend direction and the change to correct descend direction)

在 AdaptMomentumCorrection, NesterovMomentumCorrection, MomentumCorrection , 以及 StandardMomentumCorrection 内被实现.

virtual void load_from_context ( CMinimizerContext *  context )

pure virtual

Load the given context object to restore mutable variables

This method will be called by DescendUpdaterWithCorrection::load_from_context(CMinimizerContext* context)

参数

context

a context object

在 AdaptMomentumCorrection , 以及 MomentumCorrection 内被实现.

virtual void set_correction_weight ( float64_t  weight )

virtual

Set the weight used in descend correction

param weight the weight

被 AdaptMomentumCorrection 重载.

在文件 DescendCorrection.h 第 74 行定义.

virtual void update_context ( CMinimizerContext *  context )

pure virtual

Update a context object to store mutable variables used in descend update

This method will be called by DescendUpdaterWithCorrection::update_context()

参数

context

a context object

在 AdaptMomentumCorrection , 以及 MomentumCorrection 内被实现.

类成员变量说明

float64_t m_weight

protected

weight of correction

在文件 DescendCorrection.h 第 110 行定义.

---

该类的文档由以下文件生成:

• DescendCorrection.h