RVLUmin::UMinDir< Scalar > Class Template Reference

Abstract interface for computation of search directions, in support of descent methods. More...

#include <uminstep.hh>

Inheritance diagram for RVLUmin::UMinDir< Scalar >:

RVLAlg::Terminator RVLUmin::LBFGSDir< Scalar > List of all members.

Public Member Functions

 UMinDir ()
 UMinDir (UMinDir< Scalar > const &)
virtual ~UMinDir ()
virtual void calcDir (Vector< Scalar > &dir, FunctionalEvaluation< Scalar > &fx)=0
 Returns search direction in mutable first argument.
virtual void updateDir (LineSearchAlg< Scalar > const &ls)=0
 Use data generated during line search to update any internals.
virtual void resetDir ()=0
 Reinitialize direction computation.
virtual ostream & write (ostream &str) const =0
 verbose output stream

Detailed Description

template<typename Scalar>
class RVLUmin::UMinDir< Scalar >

Abstract interface for computation of search directions, in support of descent methods.

Since computation can succeed or fail, must have character of terminator.

Definition at line 57 of file uminstep.hh.


Constructor & Destructor Documentation

template<typename Scalar>
RVLUmin::UMinDir< Scalar >::UMinDir (  ) 

Definition at line 59 of file uminstep.hh.

template<typename Scalar>
RVLUmin::UMinDir< Scalar >::UMinDir ( UMinDir< Scalar > const &   ) 

Definition at line 60 of file uminstep.hh.

template<typename Scalar>
virtual RVLUmin::UMinDir< Scalar >::~UMinDir (  )  [virtual]

Definition at line 61 of file uminstep.hh.


Member Function Documentation

template<typename Scalar>
virtual void RVLUmin::UMinDir< Scalar >::calcDir ( Vector< Scalar > &  dir,
FunctionalEvaluation< Scalar > &  fx 
) [pure virtual]

Returns search direction in mutable first argument.

Implemented in RVLUmin::LBFGSDir< Scalar >.

template<typename Scalar>
virtual void RVLUmin::UMinDir< Scalar >::updateDir ( LineSearchAlg< Scalar > const &  ls  )  [pure virtual]

Use data generated during line search to update any internals.

Implemented in RVLUmin::LBFGSDir< Scalar >.

template<typename Scalar>
virtual void RVLUmin::UMinDir< Scalar >::resetDir (  )  [pure virtual]

Reinitialize direction computation.

Implemented in RVLUmin::LBFGSDir< Scalar >.

template<typename Scalar>
virtual ostream& RVLUmin::UMinDir< Scalar >::write ( ostream &  str  )  const [pure virtual]

verbose output stream

Implemented in RVLUmin::LBFGSDir< Scalar >.


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for RvlUmin by  doxygen 1.4.7