NonDifferentiableFunc< SCALAR > Class Template Reference

#include <non_differentiable_func.h>

Inheritance diagram for NonDifferentiableFunc< SCALAR >:

Public Types
using	FB = sopt::algorithm::ForwardBackward< SCALAR >
using	Real = typename FB::Real
using	t_Vector = typename FB::t_Vector
using	t_Proximal = typename FB::t_Proximal
using	t_LinearTransform = typename FB::t_LinearTransform

Public Member Functions
virtual void	log_message () const =0
virtual t_Proximal	proximal_operator () const =0
virtual Real	function (t_Vector const &x) const =0
virtual const t_LinearTransform &	Psi () const =0

Detailed Description

template<typename SCALAR>
class NonDifferentiableFunc< SCALAR >

Definition at line 11 of file non_differentiable_func.h.

Member Typedef Documentation

FB

template<typename SCALAR >

using NonDifferentiableFunc< SCALAR >::FB = sopt::algorithm::ForwardBackward<SCALAR>

Definition at line 14 of file non_differentiable_func.h.

Real

template<typename SCALAR >

using NonDifferentiableFunc< SCALAR >::Real = typename FB::Real

Definition at line 15 of file non_differentiable_func.h.

t_LinearTransform

template<typename SCALAR >

using NonDifferentiableFunc< SCALAR >::t_LinearTransform = typename FB::t_LinearTransform

Definition at line 18 of file non_differentiable_func.h.

t_Proximal

template<typename SCALAR >

using NonDifferentiableFunc< SCALAR >::t_Proximal = typename FB::t_Proximal

Definition at line 17 of file non_differentiable_func.h.

t_Vector

template<typename SCALAR >

using NonDifferentiableFunc< SCALAR >::t_Vector = typename FB::t_Vector

Definition at line 16 of file non_differentiable_func.h.

Member Function Documentation

function()

template<typename SCALAR >

virtual Real NonDifferentiableFunc< SCALAR >::function ( t_Vector const &  x ) const

pure virtual

Implemented in sopt::algorithm::TFGProximal< SCALAR >, sopt::algorithm::RealIndicator< SCALAR >, and sopt::algorithm::L1GProximal< SCALAR >.

log_message()

template<typename SCALAR >

virtual void NonDifferentiableFunc< SCALAR >::log_message ( ) const

pure virtual

Implemented in sopt::algorithm::TFGProximal< SCALAR >, sopt::algorithm::RealIndicator< SCALAR >, and sopt::algorithm::L1GProximal< SCALAR >.

proximal_operator()

template<typename SCALAR >

virtual t_Proximal NonDifferentiableFunc< SCALAR >::proximal_operator ( ) const

pure virtual

Implemented in sopt::algorithm::TFGProximal< SCALAR >, sopt::algorithm::RealIndicator< SCALAR >, and sopt::algorithm::L1GProximal< SCALAR >.

Psi()

template<typename SCALAR >

virtual const t_LinearTransform& NonDifferentiableFunc< SCALAR >::Psi ( ) const

pure virtual

Implemented in sopt::algorithm::TFGProximal< SCALAR >, sopt::algorithm::RealIndicator< SCALAR >, and sopt::algorithm::L1GProximal< SCALAR >.

---

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

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