imaging::DifferentiableEnergyInterface Class Reference
[Minimization Module]

Abstract class interface for differentiable energies depending on vector valued input data. More...

#include <DifferentiableEnergyInterface.hpp>

Inheritance diagram for imaging::DifferentiableEnergyInterface:

imaging::EnergyInterface imaging::DifferentiableFunctionalAdaptor< functional_t > imaging::MumfordShahEnergy< shape_t >

List of all members.

Public Member Functions

virtual const ublas::vector
< float_t > & 
current_gradient () const =0
virtual void set_argument_with_gradient ()=0


Detailed Description

Abstract class interface for differentiable energies depending on vector valued input data.

In addition to the requirements of EnergyInterface, classes implementing DifferentiableEnergyInterface provide a current gradient computed from the current argument. These energy can be minimized using gradient based minimization techniques.


Member Function Documentation

virtual const ublas::vector<float_t>& imaging::DifferentiableEnergyInterface::current_gradient (  )  const [pure virtual]

Returns the current gradient. This function should not actually compute the current energy but return the cached result of the last call to set_argument()!

Implemented in imaging::DifferentiableFunctionalAdaptor< functional_t >, and imaging::MumfordShahEnergy< shape_t >.

Referenced by imaging::SteepestDescent::minimize(), and imaging::NlCg::minimize().

virtual void imaging::DifferentiableEnergyInterface::set_argument_with_gradient (  )  [pure virtual]

Compute the energy value and the gradient corresponding to the current argument. This is where the main work of the energy evaluation should be done. In contrast to set_argument() this function also computes the gradient. I.e. in general it is more expensive than set_argument().

Implemented in imaging::DifferentiableFunctionalAdaptor< functional_t >, and imaging::MumfordShahEnergy< shape_t >.

Referenced by imaging::SteepestDescent::minimize(), and imaging::NlCg::minimize().


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

Generated on Tue Feb 10 10:01:31 2009 for imaging2 by  doxygen 1.5.5