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 (NOX::Parameter::List &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 NOX::Parameter::List lineSearchParams  )  [virtual]
 

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


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:40:51 2008 for NOX by doxygen 1.3.9.1