proxsuite::proxqp::sparse::Model< T, I > Struct Template Reference

This class stores the model of the QP problem. More...

#include <proxsuite/proxqp/sparse/model.hpp>

Collaboration diagram for proxsuite::proxqp::sparse::Model< T, I >:

Public Types
typedef T	Scalar
using	VectorType = Eigen::Matrix<T, Eigen::Dynamic, 1>

Public Member Functions
	Model (isize dim, isize n_eq, isize n_in)
auto	kkt () const -> proxsuite::linalg::sparse::MatRef< T, I >
auto	kkt_mut () -> proxsuite::linalg::sparse::MatMut< T, I >
auto	kkt_unscaled () const -> proxsuite::linalg::sparse::MatRef< T, I >
auto	kkt_mut_unscaled () -> proxsuite::linalg::sparse::MatMut< T, I >

Public Attributes
isize	dim
isize	n_eq
isize	n_in
isize	H_nnz
isize	A_nnz
isize	C_nnz
proxsuite::linalg::veg::Vec< I >	kkt_col_ptrs
proxsuite::linalg::veg::Vec< I >	kkt_row_indices
proxsuite::linalg::veg::Vec< T >	kkt_values
proxsuite::linalg::veg::Vec< I >	kkt_col_ptrs_unscaled
proxsuite::linalg::veg::Vec< I >	kkt_row_indices_unscaled
proxsuite::linalg::veg::Vec< T >	kkt_values_unscaled
VectorType	g
VectorType	b
VectorType	l
VectorType	u

Detailed Description

template<typename T, typename I>
struct proxsuite::proxqp::sparse::Model< T, I >

This class stores the model of the QP problem.

Model class of the sparse solver storing the QP problem structure.

Definition at line 22 of file model.hpp.

Member Typedef Documentation

Scalar

template<typename T, typename I>

typedef T proxsuite::proxqp::sparse::Model< T, I >::Scalar

Definition at line 24 of file model.hpp.

VectorType

template<typename T, typename I>

using proxsuite::proxqp::sparse::Model< T, I >::VectorType = Eigen::Matrix<T, Eigen::Dynamic, 1>

Definition at line 25 of file model.hpp.

Constructor & Destructor Documentation

Model()

template<typename T, typename I>

proxsuite::proxqp::sparse::Model< T, I >::Model ( isize dim, isize n_eq, isize n_in )

inline

Default constructor.

Parameters

dim	primal variable dimension.
n_eq	number of equality constraints.
n_in	number of inequality constraints.

Definition at line 54 of file model.hpp.

Member Function Documentation

kkt()

template<typename T, typename I>

auto proxsuite::proxqp::sparse::Model< T, I >::kkt ( ) const -> proxsuite::linalg::sparse::MatRef<T, I>

inline

Returns the current (scaled) KKT matrix of the problem.

Definition at line 77 of file model.hpp.

kkt_mut()

template<typename T, typename I>

auto proxsuite::proxqp::sparse::Model< T, I >::kkt_mut ( ) -> proxsuite::linalg::sparse::MatMut<T, I>

inline

Returns the current (scaled) KKT matrix of the problem (mutable form).

Definition at line 96 of file model.hpp.

kkt_unscaled()

template<typename T, typename I>

auto proxsuite::proxqp::sparse::Model< T, I >::kkt_unscaled ( ) const -> proxsuite::linalg::sparse::MatRef<T, I>

inline

Returns the original (unscaled) KKT matrix of the problem.

Definition at line 115 of file model.hpp.

kkt_mut_unscaled()

template<typename T, typename I>

auto proxsuite::proxqp::sparse::Model< T, I >::kkt_mut_unscaled ( ) -> proxsuite::linalg::sparse::MatMut<T, I>

inline

Returns the original (unscaled) KKT matrix of the problem (mutable form).

Definition at line 134 of file model.hpp.

Member Data Documentation

dim

template<typename T, typename I>

isize proxsuite::proxqp::sparse::Model< T, I >::dim

Definition at line 27 of file model.hpp.

n_eq

template<typename T, typename I>

isize proxsuite::proxqp::sparse::Model< T, I >::n_eq

Definition at line 28 of file model.hpp.

n_in

template<typename T, typename I>

isize proxsuite::proxqp::sparse::Model< T, I >::n_in

Definition at line 29 of file model.hpp.

H_nnz

template<typename T, typename I>

isize proxsuite::proxqp::sparse::Model< T, I >::H_nnz

Definition at line 31 of file model.hpp.

A_nnz

template<typename T, typename I>

isize proxsuite::proxqp::sparse::Model< T, I >::A_nnz

Definition at line 32 of file model.hpp.

C_nnz

template<typename T, typename I>

isize proxsuite::proxqp::sparse::Model< T, I >::C_nnz

Definition at line 33 of file model.hpp.

kkt_col_ptrs

template<typename T, typename I>

proxsuite::linalg::veg::Vec<I> proxsuite::proxqp::sparse::Model< T, I >::kkt_col_ptrs

Definition at line 35 of file model.hpp.

kkt_row_indices

template<typename T, typename I>

proxsuite::linalg::veg::Vec<I> proxsuite::proxqp::sparse::Model< T, I >::kkt_row_indices

Definition at line 36 of file model.hpp.

kkt_values

template<typename T, typename I>

proxsuite::linalg::veg::Vec<T> proxsuite::proxqp::sparse::Model< T, I >::kkt_values

Definition at line 37 of file model.hpp.

kkt_col_ptrs_unscaled

template<typename T, typename I>

proxsuite::linalg::veg::Vec<I> proxsuite::proxqp::sparse::Model< T, I >::kkt_col_ptrs_unscaled

Definition at line 39 of file model.hpp.

kkt_row_indices_unscaled

template<typename T, typename I>

proxsuite::linalg::veg::Vec<I> proxsuite::proxqp::sparse::Model< T, I >::kkt_row_indices_unscaled

Definition at line 40 of file model.hpp.

kkt_values_unscaled

template<typename T, typename I>

proxsuite::linalg::veg::Vec<T> proxsuite::proxqp::sparse::Model< T, I >::kkt_values_unscaled

Definition at line 41 of file model.hpp.

g

template<typename T, typename I>

VectorType proxsuite::proxqp::sparse::Model< T, I >::g

Definition at line 43 of file model.hpp.

b

template<typename T, typename I>

VectorType proxsuite::proxqp::sparse::Model< T, I >::b

Definition at line 44 of file model.hpp.

l

template<typename T, typename I>

VectorType proxsuite::proxqp::sparse::Model< T, I >::l

Definition at line 45 of file model.hpp.

u

template<typename T, typename I>

VectorType proxsuite::proxqp::sparse::Model< T, I >::u

Definition at line 46 of file model.hpp.

---

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

• include/proxsuite/proxqp/sparse/model.hpp