OPTPP::TOLS Class Reference

#include <TOLS.h>

List of all members.

Public Member Functions

 TOLS ()
 Default Constructor.
 TOLS (TOLS &t)
 Copy Constructor.
virtual ~TOLS ()
 Destructor.
void operator= (TOLS &t)
 Assignment Operator.
void setDefaultTol ()
 Set all default tolerances.
void setMaxStep (double x)
 Set maximum allowable steplength.
void setMinStep (double x)
 Set minimum allowable steplength.
void setStepTol (double x)
 Set tolerance used for step convergence test.
void setFTol (double x)
 Set tolerance used in function convergence test.
void setCTol (double x)
 Set tolerance used for constraint feasibility test.
void setGTol (double x)
 Set tolerance used in gradient convergence test.
void setLSTol (double x)
 Set linesearch tolerance.
void setTRSize (double x)
 Set trust-region radius.
void setMaxIter (int k)
 Set maximum number of iterations.
void setMaxBacktrackIter (int k)
 Set maximum backtrack iterations.
void setMaxFeval (int k)
 Set maximum allowable function evaluations.
double getMaxStep () const
double getMinStep () const
double getStepTol () const
double getFTol () const
double getCTol () const
double getGTol () const
double getLSTol () const
double getTRSize () const
int getMaxIter () const
int getMaxBacktrackIter () const
int getMaxFeval () const
void printTol ()
void printTol (ostream *)

Private Attributes

double mcheps
 Machine epsilon.
double max_step
 Maximum step allowed in computestep.
double min_step
 Minimum step allowed in computestep.
double step_tol
 Step tolerance used for convergence test.
double fcn_tol
 Function tolerance used for convergence test.
double con_tol
 Constraint tolerance used for convergence test.
double grad_tol
 Gradient tolerance used for convergence test.
double linesearch_tol
 Line search tolerance.
double tr_size
 Initial trust region size.
int max_iter
 Maximum number of iterations allowed.
int max_backiter
 Maximum number of backtracks allowed in lnsrch.
int max_feval
 Maximum number of function evaluations allowed.


Detailed Description

TOLS is the Base Class for Tolerances which will be used in the optimization methods.

Author:
J. C. Meza, Sandia National Laboratories, meza@ca.sandia.gov
Note:
Modified by P.J. Williams, pwillia@sandia.gov
Date:
Last modified 02/2006


Constructor & Destructor Documentation

OPTPP::TOLS::TOLS (  )  [inline]

Default Constructor.

OPTPP::TOLS::TOLS ( TOLS t  )  [inline]

Copy Constructor.

virtual OPTPP::TOLS::~TOLS (  )  [inline, virtual]

Destructor.


Member Function Documentation

double OPTPP::TOLS::getCTol (  )  const [inline]

Returns:
Tolerance used for constraint feasibility convergence test

double OPTPP::TOLS::getFTol (  )  const [inline]

Returns:
Tolerance used in function convergence test

double OPTPP::TOLS::getGTol (  )  const [inline]

Returns:
Tolerance used in gradient convergence test

double OPTPP::TOLS::getLSTol (  )  const [inline]

Returns:
Linesearch tolerance

int OPTPP::TOLS::getMaxBacktrackIter (  )  const [inline]

Returns:
Maximum number of backtrack iterations allowed

int OPTPP::TOLS::getMaxFeval (  )  const [inline]

Returns:
Maximum number of function evaluations allowed

int OPTPP::TOLS::getMaxIter (  )  const [inline]

Returns:
Maximum number of iterations allowed

double OPTPP::TOLS::getMaxStep (  )  const [inline]

Returns:
Maximum allowable steplength

double OPTPP::TOLS::getMinStep (  )  const [inline]

Returns:
Minimum allowable steplength

double OPTPP::TOLS::getStepTol (  )  const [inline]

Returns:
Tolerance used for step convergence test

double OPTPP::TOLS::getTRSize (  )  const [inline]

Returns:
Trust-region radius

void OPTPP::TOLS::operator= ( TOLS t  )  [inline]

Assignment Operator.

void OPTPP::TOLS::printTol ( ostream *   ) 

Print the current tolerances to file ofstream

void OPTPP::TOLS::printTol (  ) 

Print the current tolerances being used

void OPTPP::TOLS::setCTol ( double  x  ) 

Set tolerance used for constraint feasibility test.

void OPTPP::TOLS::setDefaultTol (  ) 

Set all default tolerances.

void OPTPP::TOLS::setFTol ( double  x  ) 

Set tolerance used in function convergence test.

void OPTPP::TOLS::setGTol ( double  x  ) 

Set tolerance used in gradient convergence test.

void OPTPP::TOLS::setLSTol ( double  x  ) 

Set linesearch tolerance.

void OPTPP::TOLS::setMaxBacktrackIter ( int  k  ) 

Set maximum backtrack iterations.

void OPTPP::TOLS::setMaxFeval ( int  k  ) 

Set maximum allowable function evaluations.

void OPTPP::TOLS::setMaxIter ( int  k  ) 

Set maximum number of iterations.

void OPTPP::TOLS::setMaxStep ( double  x  ) 

Set maximum allowable steplength.

void OPTPP::TOLS::setMinStep ( double  x  ) 

Set minimum allowable steplength.

void OPTPP::TOLS::setStepTol ( double  x  ) 

Set tolerance used for step convergence test.

void OPTPP::TOLS::setTRSize ( double  x  ) 

Set trust-region radius.


Member Data Documentation

double OPTPP::TOLS::con_tol [private]

Constraint tolerance used for convergence test.

double OPTPP::TOLS::fcn_tol [private]

Function tolerance used for convergence test.

double OPTPP::TOLS::grad_tol [private]

Gradient tolerance used for convergence test.

double OPTPP::TOLS::linesearch_tol [private]

Line search tolerance.

int OPTPP::TOLS::max_backiter [private]

Maximum number of backtracks allowed in lnsrch.

int OPTPP::TOLS::max_feval [private]

Maximum number of function evaluations allowed.

int OPTPP::TOLS::max_iter [private]

Maximum number of iterations allowed.

double OPTPP::TOLS::max_step [private]

Maximum step allowed in computestep.

double OPTPP::TOLS::mcheps [private]

Machine epsilon.

double OPTPP::TOLS::min_step [private]

Minimum step allowed in computestep.

double OPTPP::TOLS::step_tol [private]

Step tolerance used for convergence test.

double OPTPP::TOLS::tr_size [private]

Initial trust region size.


The documentation for this class was generated from the following files:
Bug Reports    OPT++ Developers    Copyright Information    GNU Lesser General Public License
Documentation, generated by , last revised August 30, 2006.