PolymorphicPANOCDirectionBase Class Reference

#include <panocpy/polymorphic-panoc-direction.hpp>

Detailed Description

Definition at line 13 of file polymorphic-panoc-direction.hpp.

Inheritance diagram for PolymorphicPANOCDirectionBase:

Collaboration diagram for PolymorphicPANOCDirectionBase:

Public Member Functions
virtual	~PolymorphicPANOCDirectionBase ()=default
virtual void	initialize (crvec x₀, crvec x̂₀, crvec p₀, crvec grad₀)=0
virtual bool	update (crvec xₖ, crvec xₖ₊₁, crvec pₖ, crvec pₖ₊₁, crvec grad_new, const Box &C, real_t γ_new)=0
virtual bool	apply (crvec xₖ, crvec x̂ₖ, crvec pₖ, real_t γ, rvec qₖ)=0
virtual void	changed_γ (real_t γₖ, real_t old_γₖ)=0
virtual void	reset ()=0
virtual std::string	get_name () const =0
vec	apply_ret (crvec xₖ, crvec x̂ₖ, crvec pₖ, real_t γ)
virtual py::object	get_params () const =0

Constructor & Destructor Documentation

~PolymorphicPANOCDirectionBase()

virtual ~PolymorphicPANOCDirectionBase ( )

virtualdefault

Member Function Documentation

initialize()

virtual void initialize ( crvec  x₀, crvec  x̂₀, crvec  p₀, crvec  grad₀  )

pure virtual

Implemented in PolymorphicPANOCDirectionTrampoline, and PolymorphicPANOCDirection< DirectionProviderT >.

Here is the caller graph for this function:

update()

virtual bool update ( crvec  xₖ, crvec  xₖ₊₁, crvec  pₖ, crvec  pₖ₊₁, crvec  grad_new, const Box &  C, real_t  γ_new  )

pure virtual

Implemented in PolymorphicPANOCDirectionTrampoline, and PolymorphicPANOCDirection< DirectionProviderT >.

Here is the caller graph for this function:

apply()

virtual bool apply ( crvec  xₖ, crvec  x̂ₖ, crvec  pₖ, real_t  γ, rvec  qₖ  )

pure virtual

Implemented in PolymorphicPANOCDirectionTrampoline, and PolymorphicPANOCDirection< DirectionProviderT >.

Here is the caller graph for this function:

changed_γ()

virtual void changed_γ ( real_t  γₖ, real_t  old_γₖ  )

pure virtual

Implemented in PolymorphicPANOCDirectionTrampoline, and PolymorphicPANOCDirection< DirectionProviderT >.

Here is the caller graph for this function:

reset()

virtual void reset ( )

pure virtual

Implemented in PolymorphicPANOCDirectionTrampoline, and PolymorphicPANOCDirection< DirectionProviderT >.

Here is the caller graph for this function:

get_name()

virtual std::string get_name ( ) const

pure virtual

Implemented in PolymorphicPANOCDirectionTrampoline, and PolymorphicPANOCDirection< DirectionProviderT >.

Here is the caller graph for this function:

apply_ret()

vec apply_ret ( crvec  xₖ, crvec  x̂ₖ, crvec  pₖ, real_t  γ  )

inline

Definition at line 24 of file polymorphic-panoc-direction.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

get_params()

virtual py::object get_params ( ) const

pure virtual

Implemented in PolymorphicPANOCDirectionTrampoline, and PolymorphicPANOCDirection< DirectionProviderT >.

---

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

• polymorphic-panoc-direction.hpp