alpaqa: PANOCDirection< PolymorphicPANOCDirectionBase > Struct Reference

alpaqa 0.0.1

Nonconvex constrained optimization

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

Detailed Description

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

Collaboration diagram for PANOCDirection< PolymorphicPANOCDirectionBase >:

Public Types
using	DirectionPtr = std::shared_ptr< PolymorphicPANOCDirectionBase >

Public Member Functions
	PANOCDirection (const DirectionPtr &direction)

	PANOCDirection (DirectionPtr &&direction)

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

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

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

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

void	reset ()

std::string	get_name () const

Public Attributes
DirectionPtr	direction

Member Typedef Documentation

◆ DirectionPtr

using DirectionPtr = std::shared_ptr<PolymorphicPANOCDirectionBase>

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

Constructor & Destructor Documentation

◆ PANOCDirection() [1/2]

PANOCDirection ( const DirectionPtr & direction )

inline

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

◆ PANOCDirection() [2/2]

PANOCDirection ( DirectionPtr && direction )

inline

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

Member Function Documentation

◆ initialize()

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

inline

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

◆ update()

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

inline

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

◆ apply()

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

inline

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

◆ changed_γ()

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

inline

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

◆ reset()

void reset ( )

inline

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

◆ get_name()

std::string get_name ( ) const

inline

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

Member Data Documentation

◆ direction

DirectionPtr direction

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

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

polymorphic-panoc-direction.hpp