ALMSolverFull< InnerSolverT > Class Template Reference

#include <panoc-alm/decl/alm.hpp>

Detailed Description

template<class InnerSolverT = PANOCSolverFull<>>
class pa::ALMSolverFull< InnerSolverT >

Definition at line 128 of file decl/alm.hpp.

Collaboration diagram for ALMSolverFull< InnerSolverT >:

Classes
struct	Stats

Public Types
using	Params = ALMParams
using	InnerSolver = InnerSolverT

Public Member Functions
	ALMSolverFull (Params params, InnerSolver &&inner_solver)
	ALMSolverFull (Params params, const InnerSolver &inner_solver)
Stats	operator() (const ProblemFull &problem, rvec y, rvec x)
std::string	get_name () const
void	stop ()
	Abort the computation and return the result so far. More...
const Params &	get_params () const

Public Attributes
InnerSolver	inner_solver

Private Attributes
Params	params

Member Typedef Documentation

Params

using Params = ALMParams

Definition at line 130 of file decl/alm.hpp.

InnerSolver

using InnerSolver = InnerSolverT

Definition at line 131 of file decl/alm.hpp.

Constructor & Destructor Documentation

ALMSolverFull() [1/2]

ALMSolverFull ( Params  params, InnerSolver &&  inner_solver  )

inline

Definition at line 153 of file decl/alm.hpp.

ALMSolverFull() [2/2]

ALMSolverFull ( Params  params, const InnerSolver &  inner_solver  )

inline

Definition at line 156 of file decl/alm.hpp.

Member Function Documentation

operator()()

ALMSolverFull< InnerSolverT >::Stats operator()	(	const ProblemFull &	problem,
		rvec	y,
		rvec	x
	)

Definition at line 190 of file alm.hpp.

Here is the call graph for this function:

get_name()

std::string get_name ( ) const

inline

Definition at line 161 of file decl/alm.hpp.

stop()

void stop ( )

inline

Abort the computation and return the result so far.

Can be called from other threads or signal handlers.

Definition at line 167 of file decl/alm.hpp.

get_params()

const Params& get_params ( ) const

inline

Definition at line 169 of file decl/alm.hpp.

Member Data Documentation

params

Params params

private

Definition at line 172 of file decl/alm.hpp.

inner_solver

InnerSolver inner_solver

Definition at line 175 of file decl/alm.hpp.

---

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

• decl/alm.hpp