imaging::DifferentiableFunctionalAdaptor< functional_t > Class Template Reference
[Minimization Module]

Converts a DifferentiableFunctionalInterface object into a DifferentiableEnergyInterface object. More...

#include <DifferentiableFunctionalAdaptor.hpp>

Inheritance diagram for imaging::DifferentiableFunctionalAdaptor< functional_t >:

imaging::DifferentiableEnergyInterface imaging::EnergyInterface

List of all members.

Public Member Functions

 DifferentiableFunctionalAdaptor (functional_t &functional)
ublas::vector< float_t > & current_argument ()
void set_argument ()
void set_argument_with_gradient ()
float_t current_energy () const
std::size_t dimension () const
const ublas::vector< float_t > & current_gradient () const


Detailed Description

template<class functional_t>
class imaging::DifferentiableFunctionalAdaptor< functional_t >

Converts a DifferentiableFunctionalInterface object into a DifferentiableEnergyInterface object.

Member Function Documentation

template<class functional_t>
ublas::vector<float_t>& imaging::DifferentiableFunctionalAdaptor< functional_t >::current_argument (  )  [inline, virtual]

Access the current argument of the energy. In general the user should not resize the current argument!

Implements imaging::EnergyInterface.

template<class functional_t>
void imaging::DifferentiableFunctionalAdaptor< functional_t >::set_argument (  )  [inline, virtual]

Compute the energy value corresponding to the current argument. This is where the main work of the energy evaluation should be done.

Implements imaging::EnergyInterface.

template<class functional_t>
void imaging::DifferentiableFunctionalAdaptor< functional_t >::set_argument_with_gradient (  )  [inline, 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().

Implements imaging::DifferentiableEnergyInterface.

template<class functional_t>
float_t imaging::DifferentiableFunctionalAdaptor< functional_t >::current_energy (  )  const [inline, virtual]

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

Implements imaging::EnergyInterface.

template<class functional_t>
std::size_t imaging::DifferentiableFunctionalAdaptor< functional_t >::dimension (  )  const [inline, virtual]

Returns the dimension the class expects as input data. The function current_argument() will return a vector of this dimension and the user should not change the size of this vector!

Implements imaging::EnergyInterface.

template<class functional_t>
const ublas::vector<float_t>& imaging::DifferentiableFunctionalAdaptor< functional_t >::current_gradient (  )  const [inline, 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()!

Implements imaging::DifferentiableEnergyInterface.


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