class HCL_MatTR_d : public HCL_Base

HCL_MatTR_d implements an algorithm for solving the trust region subproblem in the case in which the operator is represented by a symmetric matrix

Inheritance:

Public Methods

	HCL_MatTR_d ( char * fname = NULL ) Usual constructor; optionally takes the name of a file from which to read algorithmic parameters
virtual Table&	Parameters () const The method Parameters returns the parameter table of the algorithm
void	SetScaling ( HCL_SymMatOp_d * S ) SetScaling defines a new inner product in terms of a symmetric, positive definite operator S: <x,y> = (x,Sy)
void	UnSetScaling () UnSetScaling returns the inner product to the default.
int	Solve ( HCL_SymMatOp_d & B, const HCL_RnVector_d & g, HCL_RnVector_d & p ) The method Solve attempts to compute an approximate solution of the trust region subproblem defined by the inputs of the method
virtual ostream&	Write ( ostream & str ) const Prints description of the object

Inherited from HCL_Base:

Public Methods

void IncCount() const

void DecCount() const

int Count() const

double Delta

Initial trust region radius (1.0).

double Tol

Tolerance for the step length. The iteration is halted when the step is within this relative tolerance of the boundary (1.0e-2).

double Tol2

Secondary stopping tolerance (0.0).

int MaxItn

Maximum number of iterations (20).

int DispFlag

Display Flag (0). This flag controls how much detail about the progress of the iteration is sent to the screen. Possible values are 0 (no display), 1 (summary statement at the end), 2 (summary statement every DispFreq iterations), 3 (output of algorithmic parameters at every iterations---used for debugging purposes).

int DispPrecision

Display precision; controls how many digits are sent to the screen (6).

int DispFreq

Display frequency; controls how often details of iteration are displayed on screen (MaxItn/5)

double MinStep

minimum step length, that is, minimum Delta (1.0e-6).

double MaxStep

maximum step length, that is, maximum Delta (1.0e6).

int UseLastLam

Boolean flag; start current run with multiplier from previous run (0)

int TermCode

Termination code. Possible values are BOUNDARY_SOLUTION 101 INTERIOR_SOLUTION 102 FAILED 103

double Multiplier

Lagrange multiplier.

double Reduction

Reduction in the quadratic model.

double StepLength

Length of step taken.

HCL_MatTR_d( char * fname = NULL )

Usual constructor; optionally takes the name of a file from which to read algorithmic parameters. If such a file is provided, it must be a plain text file with entries of the form

ParameterName = value

or

MatTR::ParameterName = value

The second form allows the same file to contain parameters for more than one algorithm to be given in the same file. For example, one can entries such as

UMin::DispFlag = 2 MatTR::DispFlag = 1

which set the display flags for the minimization algorithm and the trust region solver to different values.

virtual Table& Parameters() const

The method Parameters returns the parameter table of the algorithm. Algorithmic parameters can be accessed via Parameters().GetValue( "name",val ) and changed via Parameters().PutValue( "name",val ).

void SetScaling( HCL_SymMatOp_d * S )

SetScaling defines a new inner product in terms of a symmetric, positive definite operator S: <x,y> = (x,Sy). This method is included for future use; at present, scaling is not implemented.

void UnSetScaling()

UnSetScaling returns the inner product to the default.

int Solve( HCL_SymMatOp_d & B, const HCL_RnVector_d & g, HCL_RnVector_d & p )

The method Solve attempts to compute an approximate solution of the trust region subproblem defined by the inputs of the method. Note that the trust region radius Delta must defined through the Parameters method.

virtual ostream& Write( ostream & str ) const

Prints description of the object

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de