OptiPack Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Private Attributes | Related Functions | List of all members
OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar > Class Template Reference

Default line search point evaluator using a polynomial linear combination of vectors. More...

#include <OptiPack_DefaultPolyLineSearchPointEvaluator.hpp>

Inheritance diagram for OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar >:
Inheritance graph
[legend]

Public Types

typedef ScalarTraits< Scalar >
::magnitudeType 
ScalarMag
 
- Public Types inherited from OptiPack::LineSearchPointEvaluatorBase< Scalar >
typedef ScalarTraits< Scalar >
::magnitudeType 
ScalarMag
 

Private Attributes

Array< RCP< const
Thyra::VectorBase< Scalar > > > 
vecs_
 

Related Functions

(Note that these are not member functions.)

template<typename Scalar >
const RCP
< DefaultPolyLineSearchPointEvaluator
< Scalar > > 
defaultPolyLineSearchPointEvaluator ()
 Nonmember constructor. More...
 

Constructors/intializers/accessors.

 DefaultPolyLineSearchPointEvaluator ()
 
void initialize (const ArrayView< const RCP< const Thyra::VectorBase< Scalar > > > &vecs)
 

Overridden from LineSearchPointEvaluatorBase.

virtual void computePoint (const ScalarMag &alpha, const Ptr< Thyra::VectorBase< Scalar > > &p) const
 

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
 
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
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

template<typename Scalar>
class OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar >

Default line search point evaluator using a polynomial linear combination of vectors.

This object computes:

  p = sum( alpha^i * vec[i], i = 0...n-1 )

This allows, for instance, a curvy-linear line search algorithm.

Definition at line 69 of file OptiPack_DefaultPolyLineSearchPointEvaluator.hpp.

Member Typedef Documentation

template<typename Scalar >
typedef ScalarTraits<Scalar>::magnitudeType OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar >::ScalarMag

Constructor & Destructor Documentation

Member Function Documentation

template<typename Scalar >
void OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar >::initialize ( const ArrayView< const RCP< const Thyra::VectorBase< Scalar > > > &  vecs)
template<typename Scalar >
void OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar >::computePoint ( const ScalarMag alpha,
const Ptr< Thyra::VectorBase< Scalar > > &  p 
) const
virtual

Friends And Related Function Documentation

template<typename Scalar >
const RCP< DefaultPolyLineSearchPointEvaluator< Scalar > > defaultPolyLineSearchPointEvaluator ( )
related

Nonmember constructor.

Definition at line 110 of file OptiPack_DefaultPolyLineSearchPointEvaluator.hpp.

Member Data Documentation

template<typename Scalar >
Array<RCP<const Thyra::VectorBase<Scalar> > > OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar >::vecs_
private

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