---

TOLS Class Reference

#include <TOLS.h>

List of all members.

Public Methods
	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 *)

---

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 10/2001

---

Member Function Documentation

double TOLS::getCTol (  )  const [inline]

Returns: Tolerance used for constraint feasibility convergence test

double TOLS::getFTol (  )  const [inline]

Returns: Tolerance used in function convergence test

double TOLS::getGTol (  )  const [inline]

Returns: Tolerance used in gradient convergence test

double TOLS::getLSTol (  )  const [inline]

Returns: Linesearch tolerance

int TOLS::getMaxBacktrackIter (  )  const [inline]

Returns: Maximum number of backtrack iterations allowed

int TOLS::getMaxFeval (  )  const [inline]

Returns: Maximum number of function evaluations allowed

int TOLS::getMaxIter (  )  const [inline]

Returns: Maximum number of iterations allowed

double TOLS::getMaxStep (  )  const [inline]

Returns: Maximum allowable steplength

double TOLS::getMinStep (  )  const [inline]

Returns: Minimum allowable steplength

double TOLS::getStepTol (  )  const [inline]

Returns: Tolerance used for step convergence test

double TOLS::getTRSize (  )  const [inline]

Returns: Trust-region radius

void TOLS::printTol (  ostream * tolout )

Print the current tolerances to file ofstream

void TOLS::printTol (  )

Print the current tolerances being used

---

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

• TOLS.h
• TOLS.C

---

Copyright Information
GNU Lesser General Public License

Contact:

Juan Meza meza@ca.sandia.gov



Documentation generated by