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 Teuchos::RCP< NOX::Utils > &u)
	Default constructor.
virtual	~Printing ()
	Destructor.
void	reset (const Teuchos::RCP< NOX::Utils > &u)
void	printOpeningRemarks (const string &lineSearchName) const
	Prints the opening information.
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.

Definition at line 66 of file NOX_LineSearch_Utils_Printing.H.

---

Constructor & Destructor Documentation

NOX::LineSearch::Utils::Printing::Printing

(

const Teuchos::RCP< NOX::Utils > &

u

)

Default constructor.

Definition at line 47 of file NOX_LineSearch_Utils_Printing.C.

NOX::LineSearch::Utils::Printing::~Printing

(

)

[virtual]

Destructor.

Definition at line 53 of file NOX_LineSearch_Utils_Printing.C.

---

Member Function Documentation

void NOX::LineSearch::Utils::Printing::printOpeningRemarks

(

const string &

lineSearchName

)

const

Prints the opening information.

Definition at line 66 of file NOX_LineSearch_Utils_Printing.C.

References NOX::Utils::fill(), NOX::Utils::InnerIteration, NOX::Utils::isPrintType(), and NOX::Utils::out().

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 and . This is to accomodate the standard merit function, .

Definition at line 77 of file NOX_LineSearch_Utils_Printing.C.

References NOX::Utils::fill(), NOX::Utils::InnerIteration, NOX::Utils::isPrintType(), NOX::Utils::out(), and NOX::Utils::sciformat().

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

---

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

• NOX_LineSearch_Utils_Printing.H
• NOX_LineSearch_Utils_Printing.C