StructuredPANOCLBFGSSolver Class Reference

#include <panoc-alm/inner/decl/structured-panoc-lbfgs.hpp>

Detailed Description

Second order PANOC solver for ALM.

Definition at line 80 of file decl/structured-panoc-lbfgs.hpp.

Collaboration diagram for StructuredPANOCLBFGSSolver:

Classes
struct	Stats

Public Types
using	Params = StructuredPANOCLBFGSParams
using	ProgressInfo = StructuredPANOCLBFGSProgressInfo

Public Member Functions
	StructuredPANOCLBFGSSolver (Params params, LBFGSParams lbfgsparams)
Stats	operator() (const Problem &problem, crvec Σ, real_t ε, bool always_overwrite_results, rvec x, rvec y, rvec err_z)
StructuredPANOCLBFGSSolver &	set_progress_callback (std::function< void(const ProgressInfo &)> cb)
std::string	get_name () const
void	stop ()
const Params &	get_params () const

Public Attributes
LBFGS	lbfgs

Private Attributes
Params	params
AtomicStopSignal	stop_signal
std::function< void(const ProgressInfo &)>	progress_cb

---

Class Documentation

pa::StructuredPANOCLBFGSSolver::Stats

struct pa::StructuredPANOCLBFGSSolver::Stats

Collaboration diagram for StructuredPANOCLBFGSSolver::Stats:

Class Members
SolverStatus	status
real_t	ε
microseconds	elapsed_time
unsigned	iterations
unsigned	linesearch_failures
unsigned	lbfgs_failures
unsigned	lbfgs_rejected
unsigned	τ_1_accepted
unsigned	count_τ
real_t	sum_τ

Member Typedef Documentation

Params

using Params = StructuredPANOCLBFGSParams

Definition at line 82 of file decl/structured-panoc-lbfgs.hpp.

ProgressInfo

using ProgressInfo = StructuredPANOCLBFGSProgressInfo

Definition at line 97 of file decl/structured-panoc-lbfgs.hpp.

Constructor & Destructor Documentation

StructuredPANOCLBFGSSolver()

StructuredPANOCLBFGSSolver ( Params  params, LBFGSParams  lbfgsparams  )

inline

Definition at line 99 of file decl/structured-panoc-lbfgs.hpp.

Member Function Documentation

operator()()

StructuredPANOCLBFGSSolver::Stats operator() ( const Problem &  problem, crvec  Σ, real_t  ε, bool  always_overwrite_results, rvec  x, rvec  y, rvec  err_z  )

inline

Parameters

[in]	problem	Problem description
[in]	Σ	Constraint weights \( \Sigma \)
[in]	ε	Tolerance \( \varepsilon \)
[in]	always_overwrite_results	Overwrite x, y and err_z even if not converged
[in,out]	x	Decision variable \( x \)
[in,out]	y	Lagrange multipliers \( y \)
[out]	err_z	Slack variable error \( g(x) - z \)

Definition at line 18 of file structured-panoc-lbfgs.hpp.

Here is the call graph for this function:

set_progress_callback()

StructuredPANOCLBFGSSolver& set_progress_callback ( std::function< void(const ProgressInfo &)>  cb )

inline

Definition at line 111 of file decl/structured-panoc-lbfgs.hpp.

get_name()

std::string get_name ( ) const

inline

Definition at line 116 of file decl/structured-panoc-lbfgs.hpp.

stop()

void stop ( )

inline

Definition at line 118 of file decl/structured-panoc-lbfgs.hpp.

Here is the call graph for this function:

get_params()

const Params& get_params ( ) const

inline

Definition at line 120 of file decl/structured-panoc-lbfgs.hpp.

Member Data Documentation

params

Params params

private

Definition at line 123 of file decl/structured-panoc-lbfgs.hpp.

stop_signal

AtomicStopSignal stop_signal

private

Definition at line 124 of file decl/structured-panoc-lbfgs.hpp.

progress_cb

std::function<void(const ProgressInfo &)> progress_cb

private

Definition at line 125 of file decl/structured-panoc-lbfgs.hpp.

lbfgs

LBFGS lbfgs

Definition at line 128 of file decl/structured-panoc-lbfgs.hpp.

---

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

• decl/structured-panoc-lbfgs.hpp