PolymorphicPANOCDirection< DirectionProviderT > Class Template Reference

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

Detailed Description

template<class DirectionProviderT>
class alpaqa::PolymorphicPANOCDirection< DirectionProviderT >

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

Inheritance diagram for PolymorphicPANOCDirection< DirectionProviderT >:

Collaboration diagram for PolymorphicPANOCDirection< DirectionProviderT >:

Public Types
using	DirectionProvider = DirectionProviderT

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

Private Attributes
PANOCDirection< DirectionProvider >	direction_provider

Member Typedef Documentation

DirectionProvider

using DirectionProvider = DirectionProviderT

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

Constructor & Destructor Documentation

PolymorphicPANOCDirection() [1/2]

PolymorphicPANOCDirection ( DirectionProvider &&  direction )

inline

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

PolymorphicPANOCDirection() [2/2]

PolymorphicPANOCDirection ( const DirectionProvider &  direction )

inline

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

Member Function Documentation

initialize()

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

inlineoverridevirtual

Implements PolymorphicPANOCDirectionBase.

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

Here is the caller graph for this function:

update()

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

inlineoverridevirtual

Implements PolymorphicPANOCDirectionBase.

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

Here is the caller graph for this function:

apply()

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

inlineoverridevirtual

Implements PolymorphicPANOCDirectionBase.

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

changed_γ()

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

inlineoverridevirtual

Implements PolymorphicPANOCDirectionBase.

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

Here is the caller graph for this function:

reset()

void reset ( )

inlineoverridevirtual

Implements PolymorphicPANOCDirectionBase.

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

Here is the caller graph for this function:

get_name()

std::string get_name ( ) const

inlineoverridevirtual

Implements PolymorphicPANOCDirectionBase.

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

Here is the caller graph for this function:

get_params()

py::object get_params ( ) const

inlineoverridevirtual

Implements PolymorphicPANOCDirectionBase.

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

Here is the caller graph for this function:

apply_ret()

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

inlineinherited

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:

Member Data Documentation

direction_provider

PANOCDirection<DirectionProvider> direction_provider

private

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

---

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

• polymorphic-panoc-direction.hpp