AndersonDirection< Conf > Struct Template Reference

#include <alpaqa/inner/directions/panoc/anderson.hpp>

Detailed Description

template<Config Conf>
struct alpaqa::AndersonDirection< Conf >

Definition at line 17 of file anderson.hpp.

Collaboration diagram for AndersonDirection< Conf >:

Classes
struct	Params

Public Types
using	Problem = TypeErasedProblem< config_t >
using	AndersonAccel = alpaqa::AndersonAccel< config_t >
using	AcceleratorParams = typename AndersonAccel::Params
using	DirectionParams = AndersonDirectionParams< config_t >

Public Member Functions
	AndersonDirection ()=default
	AndersonDirection (const Params &params)
	AndersonDirection (const typename AndersonAccel::Params &params, const DirectionParams &directionparams={})
	AndersonDirection (const AndersonAccel &anderson, const DirectionParams &directionparams={})
	AndersonDirection (AndersonAccel &&anderson, const DirectionParams &directionparams={})
void	initialize (const Problem &problem, crvec y, crvec Σ, real_t γ_0, crvec x_0, crvec x̂_0, crvec p_0, crvec grad_ψx_0)
bool	has_initial_direction () const
bool	update (real_t γₖ, real_t γₙₑₓₜ, crvec xₖ, crvec xₙₑₓₜ, crvec pₖ, crvec pₙₑₓₜ, crvec grad_ψxₖ, crvec grad_ψxₙₑₓₜ)
bool	apply (real_t γₖ, crvec xₖ, crvec x̂ₖ, crvec pₖ, crvec grad_ψxₖ, rvec qₖ) const
void	changed_γ (real_t γₖ, real_t old_γₖ)
void	reset ()
std::string	get_name () const
auto	get_params () const

Public Attributes
AndersonAccel	anderson
DirectionParams	direction_params

---

Class Documentation

alpaqa::AndersonDirection::Params

struct alpaqa::AndersonDirection::Params

Collaboration diagram for AndersonDirection< Conf >::Params:

Class Members
AcceleratorParams	accelerator = {}
DirectionParams	direction = {}

Member Typedef Documentation

Problem

using Problem = TypeErasedProblem<config_t>

Definition at line 20 of file anderson.hpp.

AndersonAccel

using AndersonAccel = alpaqa::AndersonAccel<config_t>

Definition at line 21 of file anderson.hpp.

AcceleratorParams

using AcceleratorParams = typename AndersonAccel::Params

Definition at line 22 of file anderson.hpp.

DirectionParams

using DirectionParams = AndersonDirectionParams<config_t>

Definition at line 23 of file anderson.hpp.

Constructor & Destructor Documentation

AndersonDirection() [1/5]

AndersonDirection ( )

default

AndersonDirection() [2/5]

AndersonDirection ( const Params &  params )

inline

Definition at line 33 of file anderson.hpp.

AndersonDirection() [3/5]

AndersonDirection ( const typename AndersonAccel::Params &  params, const DirectionParams &  directionparams = {}  )

inline

Definition at line 35 of file anderson.hpp.

AndersonDirection() [4/5]

AndersonDirection ( const AndersonAccel &  anderson, const DirectionParams &  directionparams = {}  )

inline

Definition at line 38 of file anderson.hpp.

AndersonDirection() [5/5]

AndersonDirection ( AndersonAccel &&  anderson, const DirectionParams &  directionparams = {}  )

inline

Definition at line 41 of file anderson.hpp.

Member Function Documentation

initialize()

void initialize ( const Problem &  problem, crvec  y, crvec  Σ, real_t  γ_0, crvec  x_0, crvec  x̂_0, crvec  p_0, crvec  grad_ψx_0  )

inline

See also

PANOCDirection::initialize

Definition at line 46 of file anderson.hpp.

Here is the call graph for this function:

has_initial_direction()

bool has_initial_direction ( ) const

inline

See also

PANOCDirection::has_initial_direction

Definition at line 56 of file anderson.hpp.

update()

bool update ( real_t  γₖ, real_t  γₙₑₓₜ, crvec  xₖ, crvec  xₙₑₓₜ, crvec  pₖ, crvec  pₙₑₓₜ, crvec  grad_ψxₖ, crvec  grad_ψxₙₑₓₜ  )

inline

See also

PANOCDirection::update

Definition at line 59 of file anderson.hpp.

apply()

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

inline

See also

PANOCDirection::apply

Definition at line 68 of file anderson.hpp.

Here is the call graph for this function:

changed_γ()

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

inline

See also

PANOCDirection::changed_γ

Definition at line 77 of file anderson.hpp.

Here is the call graph for this function:

reset()

void reset ( )

inline

See also

PANOCDirection::reset

Definition at line 85 of file anderson.hpp.

Here is the call graph for this function:

get_name()

std::string get_name ( ) const

inline

See also

PANOCDirection::get_name

Definition at line 88 of file anderson.hpp.

get_params()

auto get_params ( ) const

inline

Definition at line 91 of file anderson.hpp.

Here is the call graph for this function:

Member Data Documentation

anderson

AndersonAccel anderson

mutable

Definition at line 25 of file anderson.hpp.

direction_params

DirectionParams direction_params

Definition at line 95 of file anderson.hpp.

---

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

• src/alpaqa/include/alpaqa/inner/directions/panoc/anderson.hpp