sopt::L2DifferentiableFunc< SCALAR > Class Template Reference

#include <l2_differentiable_func.h>

Inheritance diagram for sopt::L2DifferentiableFunc< SCALAR >:

Collaboration diagram for sopt::L2DifferentiableFunc< SCALAR >:

Public Member Functions
	L2DifferentiableFunc (const Real sigma, const LinearTransform &Phi)
void	log_message () const override
void	gradient (Vector &output, const Vector &image, const Vector &residual, const LinearTransform &Phi) override
Real	function (Vector const &image, Vector const &y, LinearTransform const &Phi) override
Public Member Functions inherited from DifferentiableFunc< SCALAR >
virtual t_Gradient	gradient ()
Real	get_step_size () const

Additional Inherited Members
Public Types inherited from DifferentiableFunc< SCALAR >
using	FB = sopt::algorithm::ForwardBackward< SCALAR >
using	Real = typename FB::Real
using	t_Vector = typename FB::t_Vector
using	t_Gradient = typename FB::t_Gradient
using	t_LinearTransform = typename FB::t_LinearTransform

Detailed Description

template<typename SCALAR>
class sopt::L2DifferentiableFunc< SCALAR >

Definition at line 11 of file l2_differentiable_func.h.

Constructor & Destructor Documentation

L2DifferentiableFunc()

template<typename SCALAR >

sopt::L2DifferentiableFunc< SCALAR >::L2DifferentiableFunc ( const Real  sigma, const LinearTransform &  Phi  )

inline

Definition at line 19 of file l2_differentiable_func.h.

                                                     : LT(Phi), sigma(sigma)
    {
        this->step_size = 0.98*sigma*sigma;
    }

References sopt::sigma().

Member Function Documentation

function()

template<typename SCALAR >

Real sopt::L2DifferentiableFunc< SCALAR >::function ( Vector const &  image, Vector const &  y, LinearTransform const &  Phi  )

inlineoverridevirtual

Implements DifferentiableFunc< SCALAR >.

Definition at line 36 of file l2_differentiable_func.h.

    {
        // Does this need to be modified to take into account MPI?
        Real Likelihood = 0.5 * ((Phi*image) - y).squaredNorm() / (sigma * sigma);
        return Likelihood;
    }

gradient()

template<typename SCALAR >

void sopt::L2DifferentiableFunc< SCALAR >::gradient ( Vector &  output, const Vector &  image, const Vector &  residual, const LinearTransform &  Phi  )

inlineoverridevirtual

Implements DifferentiableFunc< SCALAR >.

Definition at line 30 of file l2_differentiable_func.h.

    {
      output = Phi.adjoint() * (residual / (sigma * sigma));  // L2 norm
    }

log_message()

template<typename SCALAR >

void sopt::L2DifferentiableFunc< SCALAR >::log_message ( ) const

inlineoverridevirtual

Implements DifferentiableFunc< SCALAR >.

Definition at line 25 of file l2_differentiable_func.h.

    {
        SOPT_HIGH_LOG("Using L2 differentiable function f(x)");
    }

References SOPT_HIGH_LOG.

---

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

• /home/runner/work/sopt/sopt/cpp/sopt/l2_differentiable_func.h