RVLUmin::ChebPolicy< Scalar > Class Template Reference

#include <chebalg.hh>

List of all members.

Public Member Functions
ChebAlg< Scalar > *	build (Vector< Scalar > &x, LinearOp< Scalar > const &A, Vector< Scalar > const &d, atype &rnorm, atype &nrnorm, ostream &str) const
	build method - see TRGNAlg specs
void	assign (atype _rtol, atype _nrtol, atype _gamma, atype _epsilon, atype _alpha, atype _lbd_est, int _maxcount, bool _verbose)
	post-construction initialization
void	assign (Table const &t)
	parameter table overload
void	assign (ChebPolicyData< Scalar > const &s)
	data struct overload
	ChebPolicy (atype _gamma=0.04, atype _epsilon=0.01, atype _alpha=1.001, atype _lbd_est=0.0, int _maxcount=0, bool _verbose=true)
	main constructor - acts as default.
	ChebPolicy (ChebPolicy< Scalar > const &p)

---

Detailed Description

template<typename Scalar>
class RVLUmin::ChebPolicy< Scalar >

Definition at line 577 of file chebalg.hh.

---

Constructor & Destructor Documentation

template<typename Scalar>

RVLUmin::ChebPolicy< Scalar >::ChebPolicy	(	atype	_gamma = 0.04,
		atype	_epsilon = 0.01,
		atype	_alpha = 1.001,
		atype	_lbd_est = 0.0,
		int	_maxcount = 0,
		bool	_verbose = true
	)

main constructor - acts as default.

Default values of parameters set to result in immediate return, no iteration. Note that policy design requires that default construction must be valid, and all run-time instance data be initiated post-construction, in this case by the assign function, to be called by drivers of user classes (subclassed from this and with this as template param).

Definition at line 650 of file chebalg.hh.

template<typename Scalar>

RVLUmin::ChebPolicy< Scalar >::ChebPolicy

(

ChebPolicy< Scalar > const &

p

)

Definition at line 658 of file chebalg.hh.

---

Member Function Documentation

template<typename Scalar>

ChebAlg<Scalar>* RVLUmin::ChebPolicy< Scalar >::build	(	Vector< Scalar > &	x,
		LinearOp< Scalar > const &	A,
		Vector< Scalar > const &	d,
		atype &	rnorm,
		atype &	nrnorm,
		ostream &	str
	)			const

build method - see TRGNAlg specs

Parameters:

	x	- solution vector, initialize to zero on input, estimated solution on output
	opeval	- Operator evaluation, from which get linear op (getDeriv) and RHS (getValue), to set up Gauss-Newton problem
	rnorm	- reference to residual norm scalar, norm of RHS on input, of residual on output
	nrnorm	- reference to normal residual norm scalar, norm of normal residual (least squares gradient) on input, updated to estimated solution on output
	Delta	- trust radius (const) passed by value
	str	verbose output stream

Definition at line 601 of file chebalg.hh.

template<typename Scalar>

void RVLUmin::ChebPolicy< Scalar >::assign	(	atype	_rtol,
		atype	_nrtol,
		atype	_gamma,
		atype	_epsilon,
		atype	_alpha,
		atype	_lbd_est,
		int	_maxcount,
		bool	_verbose
	)

post-construction initialization

Parameters:

	_rtol	- residual norm stopping threshhold
	_nrtol	- normal residual (LS gradient) norm stopping threshhold
	_maxcount	- max number of permitted iterations

Definition at line 618 of file chebalg.hh.

template<typename Scalar>

void RVLUmin::ChebPolicy< Scalar >::assign

(

Table const &

t

)

parameter table overload

Definition at line 623 of file chebalg.hh.

template<typename Scalar>

void RVLUmin::ChebPolicy< Scalar >::assign

(

ChebPolicyData< Scalar > const &

s

)

data struct overload

Definition at line 633 of file chebalg.hh.

References RVLUmin::ChebPolicyData< Scalar >::alpha, RVLUmin::ChebPolicyData< Scalar >::epsilon, RVLUmin::ChebPolicyData< Scalar >::gamma, RVLUmin::ChebPolicyData< Scalar >::lbd_est, RVLUmin::ChebPolicyData< Scalar >::maxcount, and RVLUmin::ChebPolicyData< Scalar >::verbose.

---

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

• chebalg.hh

---