sopt::algorithm::RealIndicator< SCALAR > Class Template Reference

#include <real_indicator.h>

Inheritance diagram for sopt::algorithm::RealIndicator< SCALAR >:

Collaboration diagram for sopt::algorithm::RealIndicator< SCALAR >:

Public Types
using	NDF = NonDifferentiableFunc< SCALAR >
using	Real = typename NDF::Real
using	t_Vector = typename NDF::t_Vector
using	t_Proximal = typename NDF::t_Proximal
using	t_LinearTransform = typename NDF::t_LinearTransform
Public Types inherited from NonDifferentiableFunc< SCALAR >
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
	RealIndicator ()
void	log_message () const override
Real	function (t_Vector const &x) const override
t_Proximal	proximal_operator () const override
t_LinearTransform const &	Psi () const override

Public Attributes
t_LinearTransform	linear_operator = sopt::linear_transform_identity<SCALAR>()

Detailed Description

template<typename SCALAR>
class sopt::algorithm::RealIndicator< SCALAR >

Definition at line 15 of file real_indicator.h.

Member Typedef Documentation

NDF

template<typename SCALAR >

using sopt::algorithm::RealIndicator< SCALAR >::NDF = NonDifferentiableFunc<SCALAR>

Definition at line 18 of file real_indicator.h.

Real

template<typename SCALAR >

using sopt::algorithm::RealIndicator< SCALAR >::Real = typename NDF::Real

Definition at line 19 of file real_indicator.h.

t_LinearTransform

template<typename SCALAR >

using sopt::algorithm::RealIndicator< SCALAR >::t_LinearTransform = typename NDF::t_LinearTransform

Definition at line 22 of file real_indicator.h.

t_Proximal

template<typename SCALAR >

using sopt::algorithm::RealIndicator< SCALAR >::t_Proximal = typename NDF::t_Proximal

Definition at line 21 of file real_indicator.h.

t_Vector

template<typename SCALAR >

using sopt::algorithm::RealIndicator< SCALAR >::t_Vector = typename NDF::t_Vector

Definition at line 20 of file real_indicator.h.

Constructor & Destructor Documentation

RealIndicator()

template<typename SCALAR >

sopt::algorithm::RealIndicator< SCALAR >::RealIndicator ( )

inline

Definition at line 24 of file real_indicator.h.

{}

Member Function Documentation

function()

template<typename SCALAR >

RealIndicator< SCALAR >::Real sopt::algorithm::RealIndicator< SCALAR >::function ( t_Vector const &  x ) const

overridevirtual

Implements NonDifferentiableFunc< SCALAR >.

Definition at line 54 of file real_indicator.h.

{
  if constexpr (std::is_same<SCALAR, sopt::t_complex>::value)
  {
    for (auto &z : x) {
      if (z.imag() != 0) {
        SOPT_HIGH_LOG("Non-real vector in real indicator function; real projection has not been properly performed.");
        return 1;  // should in principle be inf but not sure how to model this
      }
    }
  }
  return 0;
}

References SOPT_HIGH_LOG.

log_message()

template<typename SCALAR >

void sopt::algorithm::RealIndicator< SCALAR >::log_message ( ) const

inlineoverridevirtual

Implements NonDifferentiableFunc< SCALAR >.

Definition at line 26 of file real_indicator.h.

    {
        SOPT_HIGH_LOG("Using Real Indicator for g(x)");
    }

References SOPT_HIGH_LOG.

proximal_operator()

template<typename SCALAR >

t_Proximal sopt::algorithm::RealIndicator< SCALAR >::proximal_operator ( ) const

inlineoverridevirtual

Implements NonDifferentiableFunc< SCALAR >.

Definition at line 36 of file real_indicator.h.

    {
        return [this](t_Vector &out, Real gamma, t_Vector const &image) {
         out = image.real();
       };
    }

Psi()

template<typename SCALAR >

t_LinearTransform const& sopt::algorithm::RealIndicator< SCALAR >::Psi ( ) const

inlineoverridevirtual

Implements NonDifferentiableFunc< SCALAR >.

Definition at line 45 of file real_indicator.h.

    {
        return linear_operator;
    }

References sopt::algorithm::RealIndicator< SCALAR >::linear_operator.

Member Data Documentation

linear_operator

template<typename SCALAR >

t_LinearTransform sopt::algorithm::RealIndicator< SCALAR >::linear_operator = sopt::linear_transform_identity<SCALAR>()

Definition at line 50 of file real_indicator.h.

Referenced by sopt::algorithm::RealIndicator< SCALAR >::Psi().

---

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

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