PGASolver Class Reference

#include <alpaqa/inner/pga.hpp>

Detailed Description

Standard Proximal Gradient Algorithm without any bells and whistles.

Definition at line 62 of file pga.hpp.

Collaboration diagram for PGASolver:

Classes
struct	Stats

Public Types
using	Params = PGAParams
using	ProgressInfo = PGAProgressInfo

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

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

---

Class Documentation

alpaqa::PGASolver::Stats

struct alpaqa::PGASolver::Stats

Collaboration diagram for PGASolver::Stats:

Class Members
SolverStatus	status
real_t	ε
microseconds	elapsed_time
unsigned	iterations

Member Typedef Documentation

Params

using Params = PGAParams

Definition at line 64 of file pga.hpp.

ProgressInfo

using ProgressInfo = PGAProgressInfo

Definition at line 75 of file pga.hpp.

Constructor & Destructor Documentation

PGASolver()

PGASolver ( const Params &  params )

inline

Definition at line 66 of file pga.hpp.

Member Function Documentation

operator()()

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

inline

Definition at line 107 of file pga.hpp.

Here is the call graph for this function:

set_progress_callback()

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

inline

Definition at line 86 of file pga.hpp.

Here is the call graph for this function:

get_name()

std::string get_name ( ) const

inline

Definition at line 91 of file pga.hpp.

stop()

void stop ( )

inline

Definition at line 93 of file pga.hpp.

Here is the call graph for this function:

get_params()

const Params & get_params ( ) const

inline

Definition at line 95 of file pga.hpp.

Member Data Documentation

params

Params params

private

Definition at line 98 of file pga.hpp.

stop_signal

AtomicStopSignal stop_signal

private

Definition at line 99 of file pga.hpp.

progress_cb

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

private

Definition at line 100 of file pga.hpp.

---

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

• pga.hpp