cMHN::L1Regulator< T, D > Class Template Reference

Class storing an L1 Regulator, specializes the Regulator class. More...

#include <regulator.hpp>

Inheritance diagram for cMHN::L1Regulator< T, D >:

Public Member Functions
	~L1Regulator ()=default
	L1Regulator (L1Regulator const &)=default
	L1Regulator (L1Regulator &&)=default
L1Regulator &	operator= (L1Regulator const &) &=default
L1Regulator &	operator= (L1Regulator &&) &=default
	L1Regulator (T const &lambda)
Public Member Functions inherited from cMHN::Regulator< T, D >
	~Regulator ()=default
	Regulator (Regulator const &)=default
	Regulator (Regulator &&)=default
Regulator &	operator= (Regulator const &) &=default
Regulator &	operator= (Regulator &&) &=default
	Regulator ()=delete
	Regulator (auto const &score, auto const &grad, auto const &name, auto const &lambda=T(1e-2))
auto	score (pRC::Tensor< T, D, D > const &theta) const
auto	grad (pRC::Tensor< T, D, D > const &theta) const
auto &	lambda ()
auto const	lambda () const
auto	name () const

Detailed Description

template<class T, pRC::Size D>
class cMHN::L1Regulator< T, D >

Class storing an L1 Regulator, specializes the Regulator class.

This regulator penalises off diagonal elements of the theta matrix with their L1-norm. The member function lambda() can be used to get and set the regularization strength.

Only the regularization strength of this regulator can be changed.

Template Parameters

T	type used for calculations
D	number of events of the dataset

Constructor & Destructor Documentation

~L1Regulator()

template<class T , pRC::Size D>

cMHN::L1Regulator< T, D >::~L1Regulator ( )

default

L1Regulator() [1/3]

template<class T , pRC::Size D>

cMHN::L1Regulator< T, D >::L1Regulator ( L1Regulator< T, D > const & )

default

L1Regulator() [2/3]

template<class T , pRC::Size D>

cMHN::L1Regulator< T, D >::L1Regulator ( L1Regulator< T, D > && )

default

L1Regulator() [3/3]

template<class T , pRC::Size D>

cMHN::L1Regulator< T, D >::L1Regulator ( T const & lambda )

inlineexplicit

Member Function Documentation

operator=() [1/2]

template<class T , pRC::Size D>

L1Regulator & cMHN::L1Regulator< T, D >::operator= ( L1Regulator< T, D > && ) &

default

operator=() [2/2]

template<class T , pRC::Size D>

L1Regulator & cMHN::L1Regulator< T, D >::operator= ( L1Regulator< T, D > const & ) &

default

---

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

• cmhn/common/regulator.hpp