NoopDirection< Conf > Struct Template Reference

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

Detailed Description

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

Direction provider that provides no directions (apply always returns false).

Definition at line 12 of file noop.hpp.

Collaboration diagram for NoopDirection< Conf >:

Classes
struct	Params

Public Types
using	Problem = TypeErasedProblem<config_t>
using	AcceleratorParams = std::monostate
using	DirectionParams = std::monostate

Public Member Functions
	NoopDirection ()=default
	NoopDirection (Params)
	NoopDirection (AcceleratorParams, 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
void	get_params () const

---

Class Documentation

alpaqa::NoopDirection::Params

struct alpaqa::NoopDirection::Params

Collaboration diagram for NoopDirection< Conf >::Params:

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

Member Typedef Documentation

Problem

template<Config Conf>

using Problem = TypeErasedProblem<config_t>

Definition at line 15 of file noop.hpp.

AcceleratorParams

template<Config Conf>

using AcceleratorParams = std::monostate

Definition at line 16 of file noop.hpp.

DirectionParams

template<Config Conf>

using DirectionParams = std::monostate

Definition at line 17 of file noop.hpp.

Constructor & Destructor Documentation

NoopDirection() [1/3]

template<Config Conf>

NoopDirection ( )

default

NoopDirection() [2/3]

template<Config Conf>

NoopDirection ( Params )

inline

Definition at line 25 of file noop.hpp.

NoopDirection() [3/3]

template<Config Conf>

NoopDirection ( AcceleratorParams , DirectionParams  )

inline

Definition at line 26 of file noop.hpp.

Member Function Documentation

initialize()

template<Config Conf>

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

initialize

Definition at line 29 of file noop.hpp.

has_initial_direction()

template<Config Conf>

bool has_initial_direction ( ) const

inlinenodiscard

See also

has_initial_direction

Definition at line 36 of file noop.hpp.

update()

template<Config Conf>

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

inlinenodiscard

See also

update

Definition at line 40 of file noop.hpp.

apply()

template<Config Conf>

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

inlinenodiscard

See also

apply

Definition at line 50 of file noop.hpp.

changed_γ()

template<Config Conf>

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

inline

See also

changed_γ

Definition at line 57 of file noop.hpp.

reset()

template<Config Conf>

void reset ( )

inline

See also

reset

Definition at line 61 of file noop.hpp.

get_name()

template<Config Conf>

std::string get_name ( ) const

inlinenodiscard

See also

get_name

Definition at line 64 of file noop.hpp.

get_params()

template<Config Conf>

void get_params ( ) const

inline

Definition at line 67 of file noop.hpp.

---

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

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