NuclearNorm< Conf, SVD > Struct Template Reference

#include <alpaqa/functions/nuclear-norm.hpp>

Detailed Description

template<Config Conf, class SVD = DefaultSVD<Conf>>
struct alpaqa::functions::NuclearNorm< Conf, SVD >

Nuclear norm (ℓ₁-norm of singular values).

Definition at line 15 of file nuclear-norm.hpp.

Collaboration diagram for NuclearNorm< Conf, SVD >:

Public Member Functions
	NuclearNorm (real_t λ=1)
	Construct without pre-allocation.
	NuclearNorm (real_t λ, length_t rows, length_t cols)
	Construct with pre-allocation.
real_t	prox (crmat in, rmat out, real_t γ=1)

Public Attributes
real_t	λ
length_t	rows = 0
length_t	cols = 0
SVD	svd
vec	singular_values

Constructor & Destructor Documentation

NuclearNorm() [1/2]

template<Config Conf, class SVD = DefaultSVD<Conf>>

NuclearNorm ( real_t  λ = 1 )

inline

Construct without pre-allocation.

Definition at line 19 of file nuclear-norm.hpp.

NuclearNorm() [2/2]

template<Config Conf, class SVD = DefaultSVD<Conf>>

NuclearNorm ( real_t  λ, length_t  rows, length_t  cols  )

inline

Construct with pre-allocation.

Definition at line 24 of file nuclear-norm.hpp.

Member Function Documentation

prox()

template<Config Conf, class SVD = DefaultSVD<Conf>>

real_t prox ( crmat  in, rmat  out, real_t  γ = 1  )

inline

Definition at line 36 of file nuclear-norm.hpp.

Member Data Documentation

λ

template<Config Conf, class SVD = DefaultSVD<Conf>>

real_t λ

Definition at line 31 of file nuclear-norm.hpp.

rows

template<Config Conf, class SVD = DefaultSVD<Conf>>

length_t rows = 0

Definition at line 32 of file nuclear-norm.hpp.

cols

template<Config Conf, class SVD = DefaultSVD<Conf>>

length_t cols = 0

Definition at line 32 of file nuclear-norm.hpp.

svd

template<Config Conf, class SVD = DefaultSVD<Conf>>

SVD svd

Definition at line 33 of file nuclear-norm.hpp.

singular_values

template<Config Conf, class SVD = DefaultSVD<Conf>>

vec singular_values

Definition at line 34 of file nuclear-norm.hpp.

---

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

• src/alpaqa/include/alpaqa/functions/nuclear-norm.hpp