NOX::LineSearch::Utils::Counters Class Reference

Common counters that all line search algorithms should report. More...

#include <NOX_LineSearch_Utils_Counters.H>

List of all members.

Public Member Functions

 Counters ()
 Default constructor.
virtual ~Counters ()
 Destructor.
virtual void reset ()
 Reset the counters .
virtual bool setValues (Teuchos::ParameterList &lineSearchParams)
Increment Methods

virtual void incrementNumLineSearches (int n=1)
 Increment the counter for the total number of line search calls by n.
virtual void incrementNumNonTrivialLineSearches (int n=1)
 Increment the counter for the total number of non-trivial line search calls by n.
virtual void incrementNumFailedLineSearches (int n=1)
 Increment the counter for the total number of failed line search calls by n.
virtual void incrementNumIterations (int n=1)
 Increment the counter for the total number of line search inner iterations by n.
Accessor Methods

Returns the current counter value

virtual int getNumLineSearches () const
 Return the counter for the total number of line search calls.
virtual int getNumNonTrivialLineSearches () const
 Return the counter for the total number of non-trivial line search calls.
virtual int getNumFailedLineSearches () const
 Return the counter for the total number of failed line search calls.
virtual int getNumIterations () const
 Return the counter for the total number of line search inner iterations.

Detailed Description

Common counters that all line search algorithms should report.

Output list keys

Line searches have a common set of data that should be tracked and saved in the parameter list for the users. This class provides a set of common data objects, accessors, and a routine to print them. A sublist for output parameters will be created called "Output" in the "Line Search" parameter sublist. Valid output keys for the parameter list are:


Member Function Documentation

bool NOX::LineSearch::Utils::Counters::setValues ( Teuchos::ParameterList lineSearchParams  )  [virtual]

Sets the common line search data in an "Output" sublist of the lineSearchParams list that is supplied in the method call.

References Teuchos::ParameterList::set(), and Teuchos::ParameterList::sublist().

Referenced by NOX::LineSearch::Polynomial::compute(), NOX::LineSearch::MoreThuente::compute(), and NOX::Solver::TensorBased::performLinesearch().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Wed Apr 13 09:59:46 2011 for NOX by  doxygen 1.6.3