Playa::DefaultOptConvergenceTest Class Reference

Inheritance diagram for Playa::DefaultOptConvergenceTest:

List of all members.

Public Member Functions
	DefaultOptConvergenceTest (const ParameterList &params)
OptStatus	test (const OptState &state) const
void	print (std::ostream &os) const
Private Attributes
int	minIters_
int	maxIters_
int	requiredPasses_
double	objTol_
double	gradTol_
double	stepTol_
double	xTyp_
double	fTyp_

---

Detailed Description

A simple convergence test

Author:

Kevin Long

Definition at line 58 of file PlayaDefaultOptConvergenceTest.hpp.

---

Constructor & Destructor Documentation

Playa::DefaultOptConvergenceTest::DefaultOptConvergenceTest

(

const ParameterList &

params

)

Definition at line 52 of file PlayaDefaultOptConvergenceTest.cpp.

References fTyp_, and xTyp_.

---

Member Function Documentation

void Playa::DefaultOptConvergenceTest::print

(

std::ostream &

os

)

const [virtual]

Implements Playa::Printable.

Definition at line 125 of file PlayaDefaultOptConvergenceTest.cpp.

References gradTol_, maxIters_, minIters_, objTol_, and stepTol_.

OptStatus Playa::DefaultOptConvergenceTest::test

(

const OptState &

state

)

const [virtual]

Implements Playa::OptConvergenceTestBase.

Definition at line 69 of file PlayaDefaultOptConvergenceTest.cpp.

References Playa::OptState::fCur(), Playa::OptState::fPrev(), fTyp_, Playa::OptState::gradCur(), gradTol_, Playa::OptState::iter(), Playa::max(), maxIters_, minIters_, Playa::Vector< Scalar >::normInf(), Playa::normInf(), objTol_, Playa::Opt_Continue, Playa::Opt_Converged, Playa::Opt_ExceededMaxiters, PLAYA_MSG1, PLAYA_MSG2, requiredPasses_, stepTol_, Playa::ObjectWithVerbosity::verb(), Playa::OptState::xCur(), Playa::OptState::xPrev(), and xTyp_.

---

Member Data Documentation

double Playa::DefaultOptConvergenceTest::fTyp_ [private]

Definition at line 79 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by DefaultOptConvergenceTest(), and test().

double Playa::DefaultOptConvergenceTest::gradTol_ [private]

Definition at line 76 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by print(), and test().

int Playa::DefaultOptConvergenceTest::maxIters_ [private]

Definition at line 73 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by print(), and test().

int Playa::DefaultOptConvergenceTest::minIters_ [private]

Definition at line 72 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by print(), and test().

double Playa::DefaultOptConvergenceTest::objTol_ [private]

Definition at line 75 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by print(), and test().

int Playa::DefaultOptConvergenceTest::requiredPasses_ [private]

Definition at line 74 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by test().

double Playa::DefaultOptConvergenceTest::stepTol_ [private]

Definition at line 77 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by print(), and test().

double Playa::DefaultOptConvergenceTest::xTyp_ [private]

Definition at line 78 of file PlayaDefaultOptConvergenceTest.hpp.

Referenced by DefaultOptConvergenceTest(), and test().