Namespaces
namespace	concepts

namespace	dense

namespace	detail

namespace	eigen

namespace	sparse

namespace	tags

namespace	utils

Classes
struct	CPUTimes

struct	Info
	This class stores the results statistics of PROXQP solvers with sparse and dense backends. More...

struct	LdltView

struct	LdltViewMut

struct	MatrixView

struct	MatrixViewMut

struct	Results
	This class stores all the results of PROXQP solvers with sparse and dense backends. More...

struct	Settings
	This class defines the settings of PROXQP solvers with sparse and dense backends. More...

struct	StridedVectorView

struct	StridedVectorViewMut

struct	Timer
	This class mimics the way "boost/timer/timer.hpp" operates while using the modern std::chrono library. Importantly, this class will only have an effect for C++11 and more. More...

struct	VectorView

struct	VectorViewMut

Typedefs
using	usize = decltype(sizeof(0))

using	f32 = float

using	f64 = double

template<typename T >
using	unref = typename detail::unlref<T&>::Type

Enumerations
enum struct	Symmetry { general , lower , upper }

enum struct	Layout : unsigned char { colmajor = 0 , rowmajor = 1 }

enum struct	SparseBackend { Automatic , SparseCholesky , MatrixFree }

enum struct	DenseBackend { Automatic , PrimalDualLDLT , PrimalLDLT }

enum struct	MeritFunctionType { GPDAL , PDAL }

enum struct	HessianType { Zero , Dense , Diagonal }

enum struct	EigenValueEstimateMethodOption { PowerIteration , ExactMethod }

enum struct	QPSolverOutput { PROXQP_SOLVED , PROXQP_MAX_ITER_REACHED , PROXQP_PRIMAL_INFEASIBLE , PROXQP_SOLVED_CLOSEST_PRIMAL_FEASIBLE , PROXQP_DUAL_INFEASIBLE , PROXQP_NOT_RUN }

enum struct	InitialGuessStatus { NO_INITIAL_GUESS , EQUALITY_CONSTRAINED_INITIAL_GUESS , WARM_START_WITH_PREVIOUS_RESULT , WARM_START , COLD_START_WITH_PREVIOUS_RESULT }

enum struct	PreconditionerStatus { EXECUTE , KEEP , IDENTITY }

Functions
constexpr auto	flip_layout (Layout l) noexcept -> Layout

constexpr auto	to_eigen_layout (Layout l) -> int

constexpr auto	from_eigen_layout (int l) -> Layout

	VEG_TAG (from_ptr_size, FromPtrSize)

	VEG_TAG (from_ptr_size_stride, FromPtrSizeStride)

	VEG_TAG (from_ptr_rows_cols_stride, FromPtrRowsColsStride)

	VEG_TAG (from_eigen, FromEigen)

template<typename T >
bool	operator== (const Info< T > &info1, const Info< T > &info2)

template<typename T >
bool	operator!= (const Info< T > &info1, const Info< T > &info2)

template<typename T >
bool	operator== (const Results< T > &results1, const Results< T > &results2)

template<typename T >
bool	operator!= (const Results< T > &results1, const Results< T > &results2)

std::ostream &	operator<< (std::ostream &os, const SparseBackend &sparse_backend)

std::ostream &	operator<< (std::ostream &os, const DenseBackend &dense_backend)

template<typename T >
bool	operator== (const Settings< T > &settings1, const Settings< T > &settings2)

template<typename T >
bool	operator!= (const Settings< T > &settings1, const Settings< T > &settings2)

void	print_line ()

void	print_header ()

void	print_preambule ()

Variables
constexpr Layout	colmajor = Layout::colmajor

constexpr Layout	rowmajor = Layout::rowmajor

Typedef Documentation

◆ usize

using proxsuite::proxqp::usize = decltype(sizeof(0))

Definition at line 24 of file views.hpp.

◆ f32

using proxsuite::proxqp::f32 = float

Definition at line 67 of file views.hpp.

◆ f64

using proxsuite::proxqp::f64 = double

Definition at line 68 of file views.hpp.

◆ unref

template<typename T >

using proxsuite::proxqp::unref = typename detail::unlref<T&>::Type

Definition at line 495 of file views.hpp.

Enumeration Type Documentation

◆ Symmetry

enum struct proxsuite::proxqp::Symmetry

strong

Enumerator
general
lower
upper

Definition at line 20 of file ruiz.hpp.

◆ Layout

enum struct proxsuite::proxqp::Layout : unsigned char

strong

Enumerator
colmajor
rowmajor

Definition at line 238 of file views.hpp.

◆ SparseBackend

enum struct proxsuite::proxqp::SparseBackend

strong

Enumerator
Automatic
SparseCholesky
MatrixFree

Definition at line 19 of file settings.hpp.

◆ DenseBackend

enum struct proxsuite::proxqp::DenseBackend

strong

Enumerator
Automatic
PrimalDualLDLT
PrimalLDLT

Definition at line 26 of file settings.hpp.

◆ MeritFunctionType

enum struct proxsuite::proxqp::MeritFunctionType

strong

Enumerator
GPDAL
PDAL

Definition at line 34 of file settings.hpp.

◆ HessianType

enum struct proxsuite::proxqp::HessianType

strong

Enumerator
Zero
Dense
Diagonal

Definition at line 40 of file settings.hpp.

◆ EigenValueEstimateMethodOption

enum struct proxsuite::proxqp::EigenValueEstimateMethodOption

strong

Enumerator
PowerIteration
ExactMethod

Definition at line 47 of file settings.hpp.

◆ QPSolverOutput

enum struct proxsuite::proxqp::QPSolverOutput

strong

Enumerator
PROXQP_SOLVED
PROXQP_MAX_ITER_REACHED
PROXQP_PRIMAL_INFEASIBLE
PROXQP_SOLVED_CLOSEST_PRIMAL_FEASIBLE
PROXQP_DUAL_INFEASIBLE
PROXQP_NOT_RUN

Definition at line 17 of file status.hpp.

◆ InitialGuessStatus

enum struct proxsuite::proxqp::InitialGuessStatus

strong

Enumerator
NO_INITIAL_GUESS
EQUALITY_CONSTRAINED_INITIAL_GUESS
WARM_START_WITH_PREVIOUS_RESULT
WARM_START
COLD_START_WITH_PREVIOUS_RESULT

Definition at line 28 of file status.hpp.

◆ PreconditionerStatus

enum struct proxsuite::proxqp::PreconditionerStatus

strong

Enumerator
EXECUTE
KEEP
IDENTITY

Definition at line 37 of file status.hpp.

Function Documentation

◆ flip_layout()

constexpr auto proxsuite::proxqp::flip_layout ( Layout l ) -> Layout

constexprnoexcept

Definition at line 248 of file views.hpp.

◆ to_eigen_layout()

constexpr auto proxsuite::proxqp::to_eigen_layout ( Layout l ) -> int

constexpr

Definition at line 253 of file views.hpp.

◆ from_eigen_layout()

constexpr auto proxsuite::proxqp::from_eigen_layout ( int l ) -> Layout

constexpr

Definition at line 258 of file views.hpp.

◆ operator==() [1/3]

template<typename T >

bool proxsuite::proxqp::operator==	(	const Info< T > &	info1,
		const Info< T > &	info2 )

Definition at line 208 of file results.hpp.

◆ operator!=() [1/3]

template<typename T >

bool proxsuite::proxqp::operator!=	(	const Info< T > &	info1,
		const Info< T > &	info2 )

Definition at line 228 of file results.hpp.

◆ operator==() [2/3]

template<typename T >

bool proxsuite::proxqp::operator==	(	const Results< T > &	results1,
		const Results< T > &	results2 )

Definition at line 235 of file results.hpp.

◆ operator!=() [2/3]

template<typename T >

bool proxsuite::proxqp::operator!=	(	const Results< T > &	results1,
		const Results< T > &	results2 )

Definition at line 244 of file results.hpp.

◆ operator<<() [1/2]

std::ostream & proxsuite::proxqp::operator<<	(	std::ostream &	os,
		const SparseBackend &	sparse_backend )

inline

Definition at line 54 of file settings.hpp.

◆ operator<<() [2/2]

std::ostream & proxsuite::proxqp::operator<<	(	std::ostream &	os,
		const DenseBackend &	dense_backend )

inline

Definition at line 66 of file settings.hpp.

◆ operator==() [3/3]

template<typename T >

bool proxsuite::proxqp::operator==	(	const Settings< T > &	settings1,
		const Settings< T > &	settings2 )

Definition at line 320 of file settings.hpp.

◆ operator!=() [3/3]

template<typename T >

bool proxsuite::proxqp::operator!=	(	const Settings< T > &	settings1,
		const Settings< T > &	settings2 )

Definition at line 375 of file settings.hpp.

◆ print_line()

void proxsuite::proxqp::print_line ( )

inline

Definition at line 15 of file prints.hpp.

◆ print_header()

void proxsuite::proxqp::print_header ( )

inline

Definition at line 23 of file prints.hpp.

◆ print_preambule()

void proxsuite::proxqp::print_preambule ( )

inline

Definition at line 30 of file prints.hpp.

Variable Documentation

◆ colmajor

constexpr Layout proxsuite::proxqp::colmajor = Layout::colmajor

constexpr

Definition at line 244 of file views.hpp.

◆ rowmajor

constexpr Layout proxsuite::proxqp::rowmajor = Layout::rowmajor

constexpr

Definition at line 245 of file views.hpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ usize

◆ f32

◆ f64

◆ unref

Enumeration Type Documentation

◆ Symmetry

◆ Layout

◆ SparseBackend

◆ DenseBackend

◆ MeritFunctionType

◆ HessianType

◆ EigenValueEstimateMethodOption

◆ QPSolverOutput

◆ InitialGuessStatus

◆ PreconditionerStatus

Function Documentation

◆ flip_layout()

◆ to_eigen_layout()

◆ from_eigen_layout()

◆ operator==() [1/3]

◆ operator!=() [1/3]

◆ operator==() [2/3]

◆ operator!=() [2/3]

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator==() [3/3]

◆ operator!=() [3/3]

◆ print_line()

◆ print_header()

◆ print_preambule()

Variable Documentation

◆ colmajor

◆ rowmajor