NOX::Parameter::LineSearchConstructor Class Reference

Support for user-defined line searches. More...

#include <NOX_Parameter_LineSearchConstructor.H>

Inheritance diagram for NOX::Parameter::LineSearchConstructor:

[legend]
Collaboration diagram for NOX::Parameter::LineSearchConstructor:
[legend]
List of all members.

Public Member Functions

 LineSearchConstructor ()
 Default Constructor.
virtual ~LineSearchConstructor ()
 Destructor.
virtual LineSearchConstructorclone () const =0
 Clone a exact replica of yourself and pass back a pointer.
virtual const string & getType () const =0
 Get a short descriptive string describing the Arbitrary object.
virtual ostream & print (ostream &stream, int indent=0) const
 Print out detailed information describing the Arbitrary object.
virtual NOX::LineSearch::GenericnewLineSearch (const NOX::Utils &u, NOX::Parameter::List &p) const =0
 Construct a new direction and return its pointer.

Detailed Description

Support for user-defined line searches.

This object has the ability to be passed via a NOX::Parameter::List and to generate new line searches.

It is able to be passed via a NOX::Parameter::List because it is derived from NOX::Parameter::Arbitrary class.

It is used by NOX::LineSearch::Manager to generate a user-defined direction via the newLineSearch() function.

The user can write a method that derives from this one or use the templated default method, NOX::Parameter::LineSearchConstructorT.


Member Function Documentation

virtual LineSearchConstructor* NOX::Parameter::LineSearchConstructor::clone  )  const [pure virtual]
 

Clone a exact replica of yourself and pass back a pointer.

It's left to the implementer to decide precisely how clone should function. The main requirement is that the cloned copy should still be valid even if the original is destroyed and even if multiple cloned copies exist.

Implements NOX::Parameter::Arbitrary.

Implemented in NOX::Parameter::LineSearchConstructorT< T >.

virtual ostream& NOX::Parameter::LineSearchConstructor::print ostream &  stream,
int  indent = 0
const [inline, virtual]
 

Print out detailed information describing the Arbitrary object.

Each line of output should be indented by the number of spaces specified by indent.

Reimplemented from NOX::Parameter::Arbitrary.

Reimplemented in NOX::Parameter::LineSearchConstructorT< T >.


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