RVLUmin::ChebPolicyData< Scalar > Class Template Reference

policy class for creation of ChebAlg - build method creates ChebAlg with these attributes: More...

#include <chebalg.hh>

List of all members.

Public Member Functions
	ChebPolicyData (atype _gamma=0.04, atype _epsilon=0.01, atype _alpha=1.001, atype _lbd_est=0.0, int _maxcount=0, bool _verbose=false)
	ChebPolicyData (ChebPolicyData< Scalar > const &a)
ostream &	write (ostream &str) const
Public Attributes
int	maxcount
atype	gamma
atype	epsilon
atype	alpha
atype	lbd_est
bool	verbose

---

Detailed Description

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

policy class for creation of ChebAlg - build method creates ChebAlg with these attributes:

rtol = residual threshhold for convergence nrtol = normal residual (LS gradient) tolerance for convergence maxcount = max number of iterations permitted

Default values set to cause immediate return from ChebAlg::run.

Other attributes are arguments of build method.

Conforms to specifications described in TRGNAlg docs.

Usage: use as policy type, i.e. class name as template parameter to TRGNAlg constructor. After construction of TRGNAlg, which IS a ChebPolicy by inheritance, call the assign method on it to set rtol, nrtol, and maxcount, BEFORE calling TRGNAlg::run() - else you will get immediate termination, as intended.

Definition at line 536 of file chebalg.hh.

---

Constructor & Destructor Documentation

template<typename Scalar>

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

Definition at line 549 of file chebalg.hh.

template<typename Scalar>

RVLUmin::ChebPolicyData< Scalar >::ChebPolicyData

(

ChebPolicyData< Scalar > const &

a

)

Definition at line 557 of file chebalg.hh.

---

Member Function Documentation

template<typename Scalar>

ostream& RVLUmin::ChebPolicyData< Scalar >::write

(

ostream &

str

)

const

Definition at line 560 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.

---

Member Data Documentation

template<typename Scalar>

int RVLUmin::ChebPolicyData< Scalar >::maxcount

Definition at line 542 of file chebalg.hh.

Referenced by RVLUmin::ChebPolicy< Scalar >::assign(), and RVLUmin::ChebPolicyData< Scalar >::write().

template<typename Scalar>

atype RVLUmin::ChebPolicyData< Scalar >::gamma

Definition at line 543 of file chebalg.hh.

Referenced by RVLUmin::ChebPolicy< Scalar >::assign(), and RVLUmin::ChebPolicyData< Scalar >::write().

template<typename Scalar>

atype RVLUmin::ChebPolicyData< Scalar >::epsilon

Definition at line 544 of file chebalg.hh.

Referenced by RVLUmin::ChebPolicy< Scalar >::assign(), and RVLUmin::ChebPolicyData< Scalar >::write().

template<typename Scalar>

atype RVLUmin::ChebPolicyData< Scalar >::alpha

Definition at line 545 of file chebalg.hh.

Referenced by RVLUmin::ChebPolicy< Scalar >::assign(), and RVLUmin::ChebPolicyData< Scalar >::write().

template<typename Scalar>

atype RVLUmin::ChebPolicyData< Scalar >::lbd_est

Definition at line 546 of file chebalg.hh.

Referenced by RVLUmin::ChebPolicy< Scalar >::assign(), and RVLUmin::ChebPolicyData< Scalar >::write().

template<typename Scalar>

bool RVLUmin::ChebPolicyData< Scalar >::verbose

Definition at line 547 of file chebalg.hh.

Referenced by RVLUmin::ChebPolicy< Scalar >::assign(), and RVLUmin::ChebPolicyData< Scalar >::write().

---

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

• chebalg.hh

---