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 >:

Related Functions
(Note that these are not member functions.)
template<typename Scalar >
const RCP < GoldenQuadInterpBracket < Scalar > >	goldenQuadInterpBracket ()
	Nonmember constructor. More...

Constructor/Initializers/Accessors
	GoldenQuadInterpBracket ()
	Construct with default parameters. More...

Overridden from ParameterListAcceptor
void	setParameterList (RCP< ParameterList > const &paramList)

RCP< const ParameterList >	getValidParameters () 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. More...

Additional Inherited Members
Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

Public Member Functions inherited from Teuchos::VerboseObject< GoldenQuadInterpBracket< Scalar > >
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< GoldenQuadInterpBracket< Scalar > > verboseObject)

	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

Public Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
RCP< ParameterList >	getNonconstParameterList ()

RCP< ParameterList >	unsetParameterList ()

RCP< const ParameterList >	getParameterList () const

Static Public Member Functions inherited from Teuchos::VerboseObject< GoldenQuadInterpBracket< Scalar > >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from Teuchos::VerboseObject< GoldenQuadInterpBracket< Scalar > >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
void	setMyParamList (const RCP< ParameterList > &paramList)

RCP< ParameterList >	getMyNonconstParamList ()

RCP< const ParameterList >	getMyParamList () const

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 63 of file GlobiPack_GoldenQuadInterpBracket_decl.hpp.

Constructor & Destructor Documentation

template<typename Scalar >

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

Construct with default parameters.

Definition at line 59 of file GlobiPack_GoldenQuadInterpBracket_def.hpp.

Member Function Documentation

template<typename Scalar >

void GlobiPack::GoldenQuadInterpBracket< Scalar >::setParameterList ( RCP< ParameterList > const & paramList )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 67 of file GlobiPack_GoldenQuadInterpBracket_def.hpp.

template<typename Scalar >

RCP< const ParameterList > GlobiPack::GoldenQuadInterpBracket< Scalar >::getValidParameters ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 77 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 94 of file GlobiPack_GoldenQuadInterpBracket_def.hpp.

Friends And Related Function Documentation

template<typename Scalar >

const RCP< GoldenQuadInterpBracket< Scalar > > goldenQuadInterpBracket ( )

Definition at line 157 of file GlobiPack_GoldenQuadInterpBracket_decl.hpp.

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

Related Functions

Constructor/Initializers/Accessors

Overridden from ParameterListAcceptor

Bracket.

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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