ipo_function::GradientEstimate Class Reference

Base class for gradient estimators. More...

#include <GradientEstimate.hpp>

Inheritance diagram for ipo_function::GradientEstimate:

Collaboration diagram for ipo_function::GradientEstimate:

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

size	The 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().

virtual void ipo_function::GradientEstimate::setVector ( gsl::vector const &  vector )

pure virtual

Set the vector to a new value.

Parameters

vector

The new vector value

Implemented in ipo_function::concrete::QuadraticCombination, ipo_function::concrete::LinearCombination, ipo::detail::BarrierFunction, ipo_function::detail::ForwardDifferenceDerivativesEstimates, ipo_function::detail::PhaseIBoundedVariableFunctionAndDerivatives, ipo_function::concrete::Sum, ipo_function::detail::PhaseIFunctionAndDerivatives, ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives, ipo_function::concrete::SumOfSquares, and ipo_function::detail::ForwardDifferenceGradientEstimate.

Referenced by ipo::detail::NewtonDescent::operator()().

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

gsl::vector ipo_function::GradientEstimate::functionGradient

protected

The gradient value.

Definition at line 64 of file GradientEstimate.hpp.

Referenced by gradient(), ipo_function::concrete::SumOfSquares::gradient(), ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives::gradient(), ipo_function::detail::PhaseIFunctionAndDerivatives::gradient(), ipo::detail::BarrierFunction::gradient(), ipo_function::concrete::Sum::gradient(), ipo_function::detail::PhaseIBoundedVariableFunctionAndDerivatives::gradient(), ipo_function::concrete::LinearCombination::gradient(), ipo_function::concrete::QuadraticCombination::gradient(), ipo::detail::BarrierFunction::initialiseGradientFromObjective(), ipo_function::detail::ForwardDifferenceGradientEstimate::setVector(), ipo_function::concrete::SumOfSquares::setVector(), ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives::setVector(), ipo_function::detail::PhaseIFunctionAndDerivatives::setVector(), ipo_function::concrete::Sum::setVector(), ipo_function::concrete::LinearCombination::setVector(), ipo_function::concrete::QuadraticCombination::setVector(), ipo::detail::BarrierFunction::updateGradientFromConstraint(), and ipo::detail::BarrierFunction::updateGradientFromVariable().

double ipo_function::GradientEstimate::functionValue

protected

The function value.

Definition at line 60 of file GradientEstimate.hpp.

Referenced by GradientEstimate(), ipo::detail::BarrierFunction::initialiseResultFromObjective(), ipo::detail::BarrierFunction::operator()(), ipo_function::detail::ForwardDifferenceGradientEstimate::setVector(), ipo_function::concrete::SumOfSquares::setVector(), ipo_function::detail::PhaseIObjectiveFunctionAndDerivatives::setVector(), ipo_function::detail::PhaseIFunctionAndDerivatives::setVector(), ipo_function::concrete::Sum::setVector(), ipo_function::detail::PhaseIBoundedVariableFunctionAndDerivatives::setVector(), ipo_function::detail::ForwardDifferenceDerivativesEstimates::setVector(), ipo_function::concrete::LinearCombination::setVector(), ipo_function::concrete::QuadraticCombination::setVector(), ipo::detail::BarrierFunction::updateResultFromVariable(), and value().

---

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

• GradientEstimate.hpp
• GradientEstimate.cc