sopt::proximal::EuclidianNorm Class Reference

Proximal of euclidian norm. More...

#include <proximal.h>

Public Member Functions
template<typename T0 >
void	operator() (Vector< typename T0::Scalar > &out, typename real_type< typename T0::Scalar >::type const &t, Eigen::MatrixBase< T0 > const &x) const
template<typename T0 >
ProximalExpression< EuclidianNorm, T0 >	operator() (typename T0::Scalar const &t, Eigen::MatrixBase< T0 > const &x) const
	Lazy version. More...

Detailed Description

Proximal of euclidian norm.

Definition at line 18 of file proximal.h.

Member Function Documentation

operator()() [1/2]

template<typename T0 >

ProximalExpression<EuclidianNorm, T0> sopt::proximal::EuclidianNorm::operator() ( typename T0::Scalar const &  t, Eigen::MatrixBase< T0 > const &  x  ) const

inline

Lazy version.

Definition at line 45 of file proximal.h.

                                                                                       {
    return {*this, t, x};
  }

operator()() [2/2]

template<typename T0 >

void sopt::proximal::EuclidianNorm::operator() ( Vector< typename T0::Scalar > &  out, typename real_type< typename T0::Scalar >::type const &  t, Eigen::MatrixBase< T0 > const &  x  ) const

inline

Definition at line 29 of file proximal.h.

                                                      {
    using Scalar = typename T0::Scalar;
#ifdef SOPT_MPI
    auto const norm = mpi::l2_norm(x, comm_);
#else
    auto const norm = x.norm();
#endif
    if (norm > t)
      out = (Scalar(1) - t / norm) * x;
    else
      out.fill(0);
  }

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