Playa::OptState Class Reference

OptState encapsulates the current state of an optimization run, for use in convergence testing. More...

List of all members.

Public Member Functions
	OptState (const Vector< double > &xCur, const double &fCur, const Vector< double > &gradCur)
OptStatus	status () const
void	setStatus (const OptStatus status)
int	iter () const
	Return the current iteration count.
double	fCur () const
	Return the current objective function value.
double	fPrev () const
	Return the previous objective function value.
Vector< double >	xCur () const
	Return the current evaluation point.
Vector< double >	xPrev () const
	Return the previous evaluation point.
Vector< double >	gradCur () const
	Return the current gradient.
Vector< double >	gradPrev () const
	Return the previous gradientx.
void	update (const Vector< double > &xNew, const Vector< double > &gradNew, const double &fNew)
Private Attributes
OptStatus	status_
int	iter_
Vector< double >	xCur_
Vector< double >	xPrev_
Vector< double >	gradCur_
Vector< double >	gradPrev_
double	fCur_
double	fPrev_

---

Detailed Description

OptState encapsulates the current state of an optimization run, for use in convergence testing.

Definition at line 50 of file PlayaOptState.hpp.

---

Constructor & Destructor Documentation

Playa::OptState::OptState	(	const Vector< double > &	xCur,
		const double &	fCur,
		const Vector< double > &	gradCur
	)

Definition at line 12 of file PlayaOptState.cpp.

---

Member Function Documentation

double Playa::OptState::fCur

(

)

const [inline]

Return the current objective function value.

Definition at line 68 of file PlayaOptState.hpp.

References fCur_.

Referenced by Playa::LineSearchBasedOptBase::run(), and Playa::DefaultOptConvergenceTest::test().

double Playa::OptState::fPrev

(

)

const [inline]

Return the previous objective function value.

Definition at line 71 of file PlayaOptState.hpp.

References fPrev_.

Referenced by Playa::DefaultOptConvergenceTest::test().

Vector<double> Playa::OptState::gradCur

(

)

const [inline]

Return the current gradient.

Definition at line 80 of file PlayaOptState.hpp.

References gradCur_.

Referenced by Playa::LineSearchBasedOptBase::run(), and Playa::DefaultOptConvergenceTest::test().

Vector<double> Playa::OptState::gradPrev

(

)

const [inline]

Return the previous gradientx.

Definition at line 83 of file PlayaOptState.hpp.

References gradPrev_.

int Playa::OptState::iter

(

)

const [inline]

Return the current iteration count.

Definition at line 65 of file PlayaOptState.hpp.

References iter_.

Referenced by Playa::LineSearchBasedOptBase::run(), and Playa::DefaultOptConvergenceTest::test().

void Playa::OptState::setStatus

(

const OptStatus

status

)

[inline]

Definition at line 62 of file PlayaOptState.hpp.

References status_.

Referenced by Playa::LineSearchBasedOptBase::run().

OptStatus Playa::OptState::status

(

)

const [inline]

Definition at line 59 of file PlayaOptState.hpp.

References status_.

Referenced by Playa::LineSearchBasedOptBase::run().

void Playa::OptState::update	(	const Vector< double > &	xNew,
		const Vector< double > &	gradNew,
		const double &	fNew
	)

Definition at line 25 of file PlayaOptState.cpp.

References Playa::Vector< Scalar >::acceptCopyOf(), fCur_, fPrev_, gradCur_, gradPrev_, iter_, xCur_, and xPrev_.

Referenced by Playa::LineSearchBasedOptBase::run().

Vector<double> Playa::OptState::xCur

(

)

const [inline]

Return the current evaluation point.

Definition at line 74 of file PlayaOptState.hpp.

References xCur_.

Referenced by Playa::LineSearchBasedOptBase::run(), and Playa::DefaultOptConvergenceTest::test().

Vector<double> Playa::OptState::xPrev

(

)

const [inline]

Return the previous evaluation point.

Definition at line 77 of file PlayaOptState.hpp.

References xPrev_.

Referenced by Playa::DefaultOptConvergenceTest::test().

---

Member Data Documentation

double Playa::OptState::fCur_ [private]

Definition at line 99 of file PlayaOptState.hpp.

Referenced by fCur(), and update().

double Playa::OptState::fPrev_ [private]

Definition at line 100 of file PlayaOptState.hpp.

Referenced by fPrev(), and update().

Vector<double> Playa::OptState::gradCur_ [private]

Definition at line 96 of file PlayaOptState.hpp.

Referenced by gradCur(), and update().

Vector<double> Playa::OptState::gradPrev_ [private]

Definition at line 97 of file PlayaOptState.hpp.

Referenced by gradPrev(), and update().

int Playa::OptState::iter_ [private]

Definition at line 91 of file PlayaOptState.hpp.

Referenced by iter(), and update().

OptStatus Playa::OptState::status_ [private]

Definition at line 90 of file PlayaOptState.hpp.

Referenced by setStatus(), and status().

Vector<double> Playa::OptState::xCur_ [private]

Definition at line 93 of file PlayaOptState.hpp.

Referenced by update(), and xCur().

Vector<double> Playa::OptState::xPrev_ [private]

Definition at line 94 of file PlayaOptState.hpp.

Referenced by update(), and xPrev().