sopt::proximal::L2Norm< T > Class Template Reference

Proximal for the L2 norm. More...

#include <proximal.h>

Public Types
using	Real = typename real_type< T >::type

Public Member Functions
	L2Norm ()
	Constructs an L2 ball proximal of size gamma. More...
void	operator() (Vector< T > &out, const Real gamma, Vector< T > const &x) const
	Calls proximal function. More...
template<typename T0 >
EnveloppeExpression< L2Norm, T0 >	operator() (Real const &, Eigen::MatrixBase< T0 > const &x) const
	Lazy version. More...
template<typename T0 >
EnveloppeExpression< L2Norm, T0 >	operator() (Eigen::MatrixBase< T0 > const &x) const
	Lazy version. More...

Detailed Description

template<typename T>
class sopt::proximal::L2Norm< T >

Proximal for the L2 norm.

Definition at line 157 of file proximal.h.

Member Typedef Documentation

Real

template<typename T >

using sopt::proximal::L2Norm< T >::Real = typename real_type<T>::type

Definition at line 159 of file proximal.h.

Constructor & Destructor Documentation

L2Norm()

template<typename T >

sopt::proximal::L2Norm< T >::L2Norm ( )

inline

Constructs an L2 ball proximal of size gamma.

Definition at line 161 of file proximal.h.

{}

Member Function Documentation

operator()() [1/3]

template<typename T >

template<typename T0 >

EnveloppeExpression<L2Norm, T0> sopt::proximal::L2Norm< T >::operator() ( Eigen::MatrixBase< T0 > const &  x ) const

inline

Lazy version.

Definition at line 175 of file proximal.h.

                                                                                 {
    return {*this, x};
  }

operator()() [2/3]

template<typename T >

template<typename T0 >

EnveloppeExpression<L2Norm, T0> sopt::proximal::L2Norm< T >::operator() ( Real const &  , Eigen::MatrixBase< T0 > const &  x  ) const

inline

Lazy version.

Definition at line 169 of file proximal.h.

                                                                                               {
    return {*this, x};
  }

operator()() [3/3]

template<typename T >

void sopt::proximal::L2Norm< T >::operator() ( Vector< T > &  out, const Real  gamma, Vector< T > const &  x  ) const

inline

Calls proximal function.

Definition at line 164 of file proximal.h.

                                                                              {
    proximal::l2_norm(out, gamma, x);
  }

References sopt::proximal::l2_norm().

---

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

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