Interior-point-optimisation  1.0-1
Interior-pointoptimisationlibrary
ipo_function::GradientEstimate Class Referenceabstract

Base class for gradient estimators. More...

#include <GradientEstimate.hpp>

Inheritance diagram for ipo_function::GradientEstimate:
Inheritance graph
Collaboration diagram for ipo_function::GradientEstimate:
Collaboration graph

Public Member Functions

 GradientEstimate (size_t const size=0)
 Constructor. More...
 
virtual void setVector (gsl::vector const &vector)=0
 Set the vector to a new value. More...
 
virtual double value () const
 
virtual gsl::vector gradient () const
 
- Public Member Functions inherited from ipo_function::detail::FunctionBase
 FunctionBase (size_t const size=0)
 Constructor. More...
 
virtual ~FunctionBase ()=0
 Make the class abstract. More...
 
size_t getSize () const
 Get size of vector for function arguments or zero for arbitrary size. More...
 

Protected Attributes

double functionValue
 The function value. More...
 
gsl::vector functionGradient
 The gradient value. More...
 
- Protected Attributes inherited from ipo_function::detail::FunctionBase
size_t const size
 Size of vector arguments to supply to subclass functions. More...
 

Detailed Description

Base class for gradient estimators.

The constructor subclass of GradientEstimate should use FunctionBase( size ) to specify the size of vectors it uses unless these are arbitrary.

Definition at line 35 of file GradientEstimate.hpp.

Constructor & Destructor Documentation

GradientEstimate::GradientEstimate ( size_t const  size = 0)

Constructor.

Parameters
sizeThe size of vector for member functions that take a vector
See also
FunctionBase

Definition at line 28 of file GradientEstimate.cc.

References functionValue.

Member Function Documentation

gsl::vector GradientEstimate::gradient ( ) const
virtual
Returns
The gradient estimated at the vector (gsl::vector::vector).

Definition at line 39 of file GradientEstimate.cc.

References functionGradient.

Referenced by ipo::detail::LineSearch::operator()(), ipo::detail::NewtonDescent::operator()(), and ipo_function::detail::PhaseIFunctionAndDerivatives::setVector().

double GradientEstimate::value ( ) const
virtual
Returns
The function (Function) evaluated at the vector (gsl::vector::vector).

Definition at line 34 of file GradientEstimate.cc.

References functionValue.

Referenced by ipo_function::detail::PhaseIFunctionAndDerivatives::hessian(), ipo::detail::NewtonDescent::operator()(), and ipo_function::concrete::LinearCombination::setCoefficient().

Member Data Documentation


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