Playa::OptState Class Reference

#include <PlayaOptState.hpp>

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
double fCur () const
double fPrev () const
Vector< double > xCur () const
Vector< double > xPrev () const
Vector< double > gradCur () const
Vector< double > gradPrev () const
void update (const Vector< double > &xNew, const Vector< double > &gradNew, const double &fNew)

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

OptStatus Playa::OptState::status (  )  const [inline]

Definition at line 59 of file PlayaOptState.hpp.

void Playa::OptState::setStatus ( const OptStatus  status  )  [inline]

Definition at line 62 of file PlayaOptState.hpp.

int Playa::OptState::iter (  )  const [inline]

Return the current iteration count

Definition at line 65 of file PlayaOptState.hpp.

double Playa::OptState::fCur (  )  const [inline]

Return the current objective function value

Definition at line 68 of file PlayaOptState.hpp.

double Playa::OptState::fPrev (  )  const [inline]

Return the previous objective function value

Definition at line 71 of file PlayaOptState.hpp.

Vector<double> Playa::OptState::xCur (  )  const [inline]

Return the current evaluation point

Definition at line 74 of file PlayaOptState.hpp.

Vector<double> Playa::OptState::xPrev (  )  const [inline]

Return the previous evaluation point

Definition at line 77 of file PlayaOptState.hpp.

Vector<double> Playa::OptState::gradCur (  )  const [inline]

Return the current gradient

Definition at line 80 of file PlayaOptState.hpp.

Vector<double> Playa::OptState::gradPrev (  )  const [inline]

Return the previous gradientx

Definition at line 83 of file PlayaOptState.hpp.

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

Definition at line 25 of file PlayaOptState.cpp.

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