IterativeSolverIterator< T > 模板类 参考

详细描述

template<class T>
class shogun::IterativeSolverIterator< T >

template class that is used as an iterator for an iterative linear solver. In the iteration of solving phase, each solver initializes the iteration with a maximum number of iteration limit, and relative/ absolute tolerence. They then call begin with the residual vector and continue until its end returns true, i.e. either it has converged or iteration count reached maximum limit.

在文件 IterativeSolverIterator.h 第 44 行定义.

Public 成员函数
	IterativeSolverIterator (const VectorXt &b, index_t max_iteration_limit=1000, float64_t relative_tolerence=1E-5, float64_t absolute_tolerence=1E-5)
void	begin (const VectorXt &residual)
const bool	end (const VectorXt &residual)
const IterInfo	get_iter_info () const
const bool	succeeded (const VectorXt &residual)
void	operator++ ()

构造及析构函数说明

IterativeSolverIterator	(	const VectorXt &	b,
		index_t	max_iteration_limit = 1000,
		float64_t	relative_tolerence = 1E-5,
		float64_t	absolute_tolerence = 1E-5
	)

constructor

tolerence of the solver is absolute_tolerence + relative_tolerence * ||b||

参数

b	the vector of the linear system Ax=b
max_iteration_limit	maximum iteration limit
relative_tolerence	relative tolerence of the iterative method
absolute_tolerence	absolute tolerence of the iterative method

在文件 IterativeSolverIterator.h 第 60 行定义.

成员函数说明

void begin

(

const VectorXt &

residual

)

assign operator from an IterInfo

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

const bool end

(

const VectorXt &

residual

)

返回

true if converged or maximum iteration limit crossed

在文件 IterativeSolverIterator.h 第 80 行定义.

const IterInfo get_iter_info

(

)

const

返回

current iteration info

在文件 IterativeSolverIterator.h 第 89 行定义.

void operator++

(

)

increment operator

在文件 IterativeSolverIterator.h 第 104 行定义.

const bool succeeded

(

const VectorXt &

residual

)

返回

success status

在文件 IterativeSolverIterator.h 第 95 行定义.

---

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

• IterativeSolverIterator.h