#include <qpalm.hpp>

Detailed Description

Main QPALM solver.

See also: qpalm_solve

Examples: examples/cxx/qpalm_demo.cpp.

Definition at line 133 of file qpalm.hpp.

Collaboration diagram for qpalm::Solver:

Public Member Functions
QPALM_CXX_EXPORT	Solver (const Data &data, const Settings &settings)
	Create a new solver for the problem defined by `data` and with the parameters defined by `settings`.

QPALM_CXX_EXPORT void	update_settings (const Settings &settings)

QPALM_CXX_EXPORT void	update_bounds (std::optional< const_ref_vec_t > bmin, std::optional< const_ref_vec_t > bmax)

QPALM_CXX_EXPORT void	update_q (const_ref_vec_t q)

QPALM_CXX_EXPORT void	update_Q_A (const_ref_vec_t Q_vals, const_ref_vec_t A_vals)

QPALM_CXX_EXPORT void	warm_start (std::optional< const_ref_vec_t > x, std::optional< const_ref_vec_t > y)

QPALM_CXX_EXPORT void	solve ()
	Solve the problem.

QPALM_CXX_EXPORT SolutionView	get_solution () const
	Get the solution computed by solve().

QPALM_CXX_EXPORT const QPALMInfo &	get_info () const
	Get the solver information from the last call to solve().

QPALM_CXX_EXPORT const_borrowed_vec_t	get_prim_inf_certificate () const
	Get the certificate of primal infeasibility of the problem.

QPALM_CXX_EXPORT const_borrowed_vec_t	get_dual_inf_certificate () const
	Get the certificate of dual infeasibility of the problem.

index_t	get_n () const
	Get the problem dimension \( n \) (size of \( x \)).

index_t	get_m () const
	Get the number of constraints \( m \).

QPALM_CXX_EXPORTconst ::QPALMWorkspace *	get_c_work_ptr () const
	Get a pointer to the underlying C workspace data structure.

Constructor & Destructor Documentation

◆ Solver()

qpalm::Solver::Solver	(	const Data &	data,
		const Settings &	settings
	)

Create a new solver for the problem defined by data and with the parameters defined by settings.

Definition at line 25 of file qpalm.cpp.

Member Function Documentation

◆ get_c_work_ptr()

QPALM_CXX_EXPORTconst ::QPALMWorkspace * qpalm::Solver::get_c_work_ptr ( ) const

inline

Get a pointer to the underlying C workspace data structure.

See also: QPALMWorkspace

Definition at line 186 of file qpalm.hpp.

◆ get_dual_inf_certificate()

const_borrowed_vec_t qpalm::Solver::get_dual_inf_certificate ( ) const

Get the certificate of dual infeasibility of the problem.

Definition at line 76 of file qpalm.cpp.

◆ get_info()

const QPALMInfo & qpalm::Solver::get_info ( ) const

Get the solver information from the last call to solve().

Note: Returns a reference that is only valid as long as the solver is not destroyed.

Examples: examples/cxx/qpalm_demo.cpp.

Definition at line 66 of file qpalm.cpp.

◆ get_m()

index_t qpalm::Solver::get_m ( ) const

inline

Get the number of constraints \( m \).

See also: QPALMData::m

Definition at line 182 of file qpalm.hpp.

◆ get_n()

index_t qpalm::Solver::get_n ( ) const

inline

Get the problem dimension \( n \) (size of \( x \)).

See also: QPALMData::n

Definition at line 179 of file qpalm.hpp.

◆ get_prim_inf_certificate()

const_borrowed_vec_t qpalm::Solver::get_prim_inf_certificate ( ) const

Get the certificate of primal infeasibility of the problem.

Definition at line 71 of file qpalm.cpp.

◆ get_solution()

SolutionView qpalm::Solver::get_solution ( ) const

Get the solution computed by solve().

Note: Returns a view that is only valid as long as the solver is not destroyed.

See also: QPALMWorkspace::solution

Examples: examples/cxx/qpalm_demo.cpp.

Definition at line 54 of file qpalm.cpp.

◆ solve()

void qpalm::Solver::solve ( )

Solve the problem.

The solution will be available through get_solution() and the solver information and statistics through get_info().

See also: qpalm_solve

Examples: examples/cxx/qpalm_demo.cpp.

Definition at line 52 of file qpalm.cpp.