alpaqa 0.0.1
Nonconvex constrained optimization
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Classes | Public Member Functions | List of all members
PolymorphicInnerSolverBase Class Referenceabstract

#include <alpaqa/polymorphic-inner-solver.hpp>

Detailed Description

Definition at line 49 of file polymorphic-inner-solver.hpp.

+ Inheritance diagram for PolymorphicInnerSolverBase:
+ Collaboration diagram for PolymorphicInnerSolverBase:

Classes

struct  Stats
 

Public Member Functions

virtual ~PolymorphicInnerSolverBase ()=default
 
virtual Stats operator() (const Problem &problem, crvec Σ, real_t ε, bool always_overwrite_results, rvec x, rvec y, rvec err_z)=0
 
virtual void stop ()=0
 
virtual std::string get_name () const =0
 
virtual py::object get_params () const =0
 

Constructor & Destructor Documentation

◆ ~PolymorphicInnerSolverBase()

virtual ~PolymorphicInnerSolverBase ( )
virtualdefault

Member Function Documentation

◆ operator()()

virtual Stats operator() ( const Problem problem,
crvec  Σ,
real_t  ε,
bool  always_overwrite_results,
rvec  x,
rvec  y,
rvec  err_z 
)
pure virtual
Parameters
[in]problemProblem description
[in]ΣConstraint weights Σ
[in]εTolerance ε
[in]always_overwrite_resultsOverwrite x, y and err_z even if not converged
[in,out]xDecision variable x
[in,out]yLagrange multipliers y
[out]err_zSlack variable error g(x)z

Implemented in PolymorphicInnerSolverTrampoline, and PolymorphicInnerSolver< InnerSolver >.

◆ stop()

virtual void stop ( )
pure virtual

Implemented in PolymorphicInnerSolverTrampoline, and PolymorphicInnerSolver< InnerSolver >.

+ Here is the caller graph for this function:

◆ get_name()

virtual std::string get_name ( ) const
pure virtual

Implemented in PolymorphicInnerSolverTrampoline, and PolymorphicInnerSolver< InnerSolver >.

+ Here is the caller graph for this function:

◆ get_params()

virtual py::object get_params ( ) const
pure virtual

Implemented in PolymorphicInnerSolverTrampoline, and PolymorphicInnerSolver< InnerSolver >.

+ Here is the caller graph for this function:

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