MomentumCorrection类 参考

详细描述

This is a base class for momentum correction methods.

The interfact will be used in DescendUpdaterWithCorrection::update_variable().

An example of descend based correction is NesterovMomentumCorrection

在文件 MomentumCorrection.h 第 46 行定义.

类 MomentumCorrection 继承关系图:

Public 成员函数
	MomentumCorrection ()
virtual	~MomentumCorrection ()
virtual bool	is_initialized ()
virtual void	initialize_previous_direction (index_t len)
virtual DescendPair	get_corrected_descend_direction (float64_t negative_descend_direction, index_t idx)=0
virtual void	update_context (CMinimizerContext *context)
virtual void	load_from_context (CMinimizerContext *context)
virtual float64_t	get_previous_descend_direction (index_t idx)
virtual float64_t	get_length_previous_descend_direction ()
virtual void	set_correction_weight (float64_t weight)

Protected 属性
SGVector< float64_t >	m_previous_descend_direction
float64_t	m_weight

构造及析构函数说明

MomentumCorrection

(

)

在文件 MomentumCorrection.h 第 51 行定义.

virtual ~MomentumCorrection ( )

virtual

在文件 MomentumCorrection.h 第 58 行定义.

成员函数说明

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)

实现了 DescendCorrection.

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

virtual float64_t get_length_previous_descend_direction ( )

virtual

Get the length of the previous descend direction (velocity)

返回

the length of the previous descend direction

在文件 MomentumCorrection.h 第 143 行定义.

virtual float64_t get_previous_descend_direction ( index_t  idx )

virtual

Get the previous descend direction (velocity) given the index

参数

idx	index of the previous descend direction

返回

the previous descend direction

在文件 MomentumCorrection.h 第 132 行定义.

virtual void initialize_previous_direction ( index_t  len )

virtual

Initialize m_previous_descend_direction?

返回

len the length of m_previous_descend_direction to be initialized

被 AdaptMomentumCorrection 重载.

在文件 MomentumCorrection.h 第 73 行定义.

virtual bool is_initialized ( )

virtual

Is the m_previous_descend_direction initialized?

返回

whether m_previous_descend_direction is initialized

被 AdaptMomentumCorrection 重载.

在文件 MomentumCorrection.h 第 64 行定义.

virtual void load_from_context ( CMinimizerContext *  context )

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

实现了 DescendCorrection.

被 AdaptMomentumCorrection 重载.

在文件 MomentumCorrection.h 第 116 行定义.

virtual void set_correction_weight ( float64_t  weight )

virtualinherited

Set the weight used in descend correction

param weight the weight

被 AdaptMomentumCorrection 重载.

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

virtual void update_context ( CMinimizerContext *  context )

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

实现了 DescendCorrection.

被 AdaptMomentumCorrection 重载.

在文件 MomentumCorrection.h 第 98 行定义.

类成员变量说明

SGVector<float64_t> m_previous_descend_direction

protected

used in momentum methods

在文件 MomentumCorrection.h 第 149 行定义.

float64_t m_weight

protectedinherited

weight of correction

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

---

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

• MomentumCorrection.h