#include <alpaqa/inner/directions/pantr/newton-tr.hpp>

Detailed Description

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

Definition at line 27 of file newton-tr.hpp.

Collaboration diagram for NewtonTRDirection< Conf >:

Classes
struct	Params

Public Types
using	Problem = TypeErasedProblem< config_t >

using	AcceleratorParams = SteihaugCGParams< config_t >

using	DirectionParams = NewtonTRDirectionParams< config_t >

Public Member Functions
	NewtonTRDirection ()=default

	NewtonTRDirection (const Params &params)

	NewtonTRDirection (const AcceleratorParams &params, 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ₙₑₓₜ)

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

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

void	reset ()

std::string	get_name () const

auto	get_params () const

Public Attributes
SteihaugCG< config_t >	steihaug

DirectionParams	direction_params

const Problem *	problem = nullptr

std::optional< crvec >	y = std::nullopt

std::optional< crvec >	Σ = std::nullopt

indexvec	JK_sto

vec	rJ_sto

vec	qJ_sto

vec	work

vec	work_2

vec	work_n_fd

vec	work_m_fd

Class Documentation

◆ alpaqa::NewtonTRDirection::Params

struct alpaqa::NewtonTRDirection::Params

Collaboration diagram for NewtonTRDirection< Conf >::Params:

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

Member Typedef Documentation

◆ Problem

using Problem = TypeErasedProblem<config_t>

Definition at line 30 of file newton-tr.hpp.

◆ AcceleratorParams

using AcceleratorParams = SteihaugCGParams<config_t>

Definition at line 31 of file newton-tr.hpp.

◆ DirectionParams

using DirectionParams = NewtonTRDirectionParams<config_t>

Definition at line 32 of file newton-tr.hpp.

Constructor & Destructor Documentation

◆ NewtonTRDirection() [1/3]

NewtonTRDirection ( )

default

◆ NewtonTRDirection() [2/3]

NewtonTRDirection ( const Params & params )

inline

Definition at line 40 of file newton-tr.hpp.

◆ NewtonTRDirection() [3/3]

NewtonTRDirection	(	const AcceleratorParams &	params,
		const DirectionParams &	directionparams = `{}`
	)

inline

Definition at line 42 of file newton-tr.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: PANTRDirection::initialize

Definition at line 47 of file newton-tr.hpp.

Here is the call graph for this function:

◆ has_initial_direction()

bool has_initial_direction ( ) const

inline

See also: PANTRDirection::has_initial_direction

Definition at line 79 of file newton-tr.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: PANTRDirection::update

Definition at line 82 of file newton-tr.hpp.

◆ apply()

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

inline

See also: PANTRDirection::apply

Definition at line 91 of file newton-tr.hpp.

Here is the call graph for this function:

◆ changed_γ()

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

inline

See also: PANTRDirection::changed_γ

Definition at line 158 of file newton-tr.hpp.

◆ reset()

void reset ( )

inline

See also: PANTRDirection::reset

Definition at line 165 of file newton-tr.hpp.

◆ get_name()

std::string get_name ( ) const

inline

See also: PANTRDirection::get_name

Definition at line 168 of file newton-tr.hpp.

◆ get_params()

auto get_params ( ) const

inline

Definition at line 172 of file newton-tr.hpp.

Member Data Documentation

◆ steihaug

SteihaugCG<config_t> steihaug

Definition at line 176 of file newton-tr.hpp.

◆ direction_params

DirectionParams direction_params

Definition at line 177 of file newton-tr.hpp.

◆ problem

const Problem* problem = nullptr

Definition at line 178 of file newton-tr.hpp.

◆ y

std::optional<crvec> y = std::nullopt

Definition at line 180 of file newton-tr.hpp.

◆ Σ

std::optional<crvec> Σ = std::nullopt

Definition at line 181 of file newton-tr.hpp.

◆ JK_sto

indexvec JK_sto

mutable

Definition at line 186 of file newton-tr.hpp.

◆ rJ_sto

vec rJ_sto

mutable

Definition at line 187 of file newton-tr.hpp.

◆ qJ_sto

vec qJ_sto

mutable

Definition at line 188 of file newton-tr.hpp.

◆ work

vec work

mutable

Definition at line 189 of file newton-tr.hpp.

◆ work_2

vec work_2

Definition at line 189 of file newton-tr.hpp.

◆ work_n_fd

vec work_n_fd

Definition at line 189 of file newton-tr.hpp.

◆ work_m_fd

vec work_m_fd

Definition at line 189 of file newton-tr.hpp.

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

src/alpaqa/include/alpaqa/inner/directions/pantr/newton-tr.hpp

Detailed Description

Classes

Public Types

Public Member Functions

Public Attributes

Class Documentation

◆ alpaqa::NewtonTRDirection::Params

Member Typedef Documentation

◆ Problem

◆ AcceleratorParams

◆ DirectionParams

Constructor & Destructor Documentation

◆ NewtonTRDirection() [1/3]

◆ NewtonTRDirection() [2/3]

◆ NewtonTRDirection() [3/3]

Member Function Documentation

◆ initialize()

◆ has_initial_direction()

◆ update()

◆ apply()

◆ changed_γ()

◆ reset()

◆ get_name()

◆ get_params()

Member Data Documentation

◆ steihaug

◆ direction_params

◆ problem

◆ y

◆ Σ

◆ JK_sto

◆ rJ_sto

◆ qJ_sto

◆ work

◆ work_2

◆ work_n_fd

◆ work_m_fd