Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

NOX::LineSearch::Utils::Printing Class Reference

Common line search utilites for printing line search information to the screen. More...

#include <NOX_LineSearch_Utils_Printing.H>

Inheritance diagram for NOX::LineSearch::Utils::Printing:

[legend]
Collaboration diagram for NOX::LineSearch::Utils::Printing:
[legend]
List of all members.

Public Member Functions

 Printing (const NOX::Utils &u)
 Default constructor.
virtual ~Printing ()
 Destructor.
void printStep (int n, double step, double oldf, double newf, const string s="", bool unscaleF=true) const
 Print out step information for the inner iterations of a line search algorithm.

Detailed Description

Common line search utilites for printing line search information to the screen.

All line searches should print output results in a similar format. This utility provides common output routines.

Member Function Documentation

void NOX::LineSearch::Utils::Printing::printStep (  int  n,
double  step,
double  oldf,
double  newf,
const string  s = "",
bool  unscaleF = true
)  const
 

Print out step information for the inner iterations of a line search algorithm.

Example of output from the inner iterations of a Polynomial line search:

************************************************************************
-- Polynomial Line Search -- 
  1: step = 1.000e+00 oldf = 2.403e+00 newf = 1.076e+03
  2: step = 1.000e-01 oldf = 2.403e+00 newf = 4.440e+00
  3: step = 1.000e-02 oldf = 2.403e+00 newf = 2.394e+00 (STEP ACCEPTED!)
************************************************************************

Parameters:
unscaleF - If this is true (the default), than the values printed are $ \sqrt{2 * {\rm oldf}} $ and $ \sqrt{2 * {\rm newf}} $. This is to accomodate the standard merit function, $ \phi(x) = \frac{1}{2} \|F(x)\|^2 $.

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