GlobiPack Version of the Day
Related Functions
GlobiPack::GoldenQuadInterpBracket< Scalar > Class Template Reference

Simple concrete class that implements a 1D algorithm to bracket the minimum of a 1D merit function. More...

#include <GlobiPack_GoldenQuadInterpBracket_decl.hpp>

Inheritance diagram for GlobiPack::GoldenQuadInterpBracket< Scalar >:
Inheritance graph
[legend]

List of all members.

Related Functions

(Note that these are not member functions.)

template<typename Scalar >
const RCP
< GoldenQuadInterpBracket
< Scalar > > 
goldenQuadInterpBracket ()
 Nonmember constructor.

Constructor/Initializers/Accessors

 GoldenQuadInterpBracket ()
 Construct with default parameters.

Overridden from ParameterListAcceptor

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< const ParameterListgetValidParameters () const
 

Bracket.

bool bracketMinimum (const MeritFunc1DBase< Scalar > &phi, const Ptr< PointEval1D< Scalar > > &pointLower, const Ptr< PointEval1D< Scalar > > &pointMiddle, const Ptr< PointEval1D< Scalar > > &pointUpper, const Ptr< int > &numIters=Teuchos::null) const
 Bracket the minimum of a 1D function.

Detailed Description

template<typename Scalar>
class GlobiPack::GoldenQuadInterpBracket< Scalar >

Simple concrete class that implements a 1D algorithm to bracket the minimum of a 1D merit function.

ToDo: Finish Documentation!

Definition at line 50 of file GlobiPack_GoldenQuadInterpBracket_decl.hpp.


Constructor & Destructor Documentation

template<typename Scalar >
GlobiPack::GoldenQuadInterpBracket< Scalar >::GoldenQuadInterpBracket ( )

Construct with default parameters.

Definition at line 46 of file GlobiPack_GoldenQuadInterpBracket_def.hpp.


Member Function Documentation

template<typename Scalar >
void GlobiPack::GoldenQuadInterpBracket< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList) [virtual]
template<typename Scalar >
RCP< const ParameterList > GlobiPack::GoldenQuadInterpBracket< Scalar >::getValidParameters ( ) const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 64 of file GlobiPack_GoldenQuadInterpBracket_def.hpp.

template<typename Scalar >
bool GlobiPack::GoldenQuadInterpBracket< Scalar >::bracketMinimum ( const MeritFunc1DBase< Scalar > &  phi,
const Ptr< PointEval1D< Scalar > > &  pointLower,
const Ptr< PointEval1D< Scalar > > &  pointMiddle,
const Ptr< PointEval1D< Scalar > > &  pointUpper,
const Ptr< int > &  numIters = Teuchos::null 
) const

Bracket the minimum of a 1D function.

Parameters:
phi[in] The evaluator object for the merit function which evaluates phi(alpha)).
pointLower[in/out] In input, *pointLower give the initial guess for the lower bound for the point. This lower bound will be respected and will never be violated. On output, *pointLower gives the lower bound for the bracket of the minimum. The derivative field pointLower->Dphi is not accessed.
pointMiddle[in/out] In input, *pointMiddle give the initial guess for the point. On output, *pointMiddle gives the bracketed minimum. The derivative field pointUpper->Dphi is not accessed.
pointUpper[out] On output, *pointUpper gives the upper bound for the bracket of the minimum. The derivative field pointUpper->Dphi is not accessed.
numIters[out] If not null, on output, numIters gives the number of iterations used.
Returns:
Returns true if a bracket has been found, false otherwise.

Preconditions:

  • pointLower->alpha < pointMiddle->alpha

Postconditions:

  • [returnVal==true] pointLower->alpha < pointMiddle->alpha && pointMiddle->alpha < pointUpper->alpha

  • [returnVal==true] pointLower->phi > pointMiddle->phi && pointMiddle->phi < pointUpper->phi

Definition at line 81 of file GlobiPack_GoldenQuadInterpBracket_def.hpp.


Friends And Related Function Documentation

template<typename Scalar >
const RCP< GoldenQuadInterpBracket< Scalar > > goldenQuadInterpBracket ( ) [related]

Nonmember constructor.

Definition at line 144 of file GlobiPack_GoldenQuadInterpBracket_decl.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends