qpalm::Data Class Reference

#include <qpalm.hpp>

Detailed Description

Stores the matrices and vectors that define the problem.

\begin{align*} & \operatorname*{\mathrm{minimize}}_x & & \tfrac{1}{2}x^\top Q x + q^\top x + c \\ & \text{subject to} & & b_\mathrm{min} \leq Ax \leq b_\mathrm{max} \end{align*}

Examples

examples/cxx/qpalm_demo.cpp.

Definition at line 38 of file qpalm.hpp.

Collaboration diagram for qpalm::Data:

Public Member Functions
	Data (index_t n, index_t m)
	Construct a problem of dimension n with m constraints.
void	set_Q (const sparse_mat_t &Q)
	Set the sparse Q matrix. Creates a copy.
void	set_A (const sparse_mat_t &A)
	Set the sparse A matrix. Creates a copy.
QPALM_CXX_EXPORTconst ::QPALMData *	get_c_data_ptr () const
	Get a pointer to the underlying C data structure.
sparse_mat_view_t	get_Q () const
	Get a view on the Q matrix of the problem.
sparse_mat_view_t	get_A () const
	Get a view on the A matrix of the problem.

Data Fields
index_t	n
	Problem dimension (size of x and q, number rows and columns of Q, number of columns of A).
index_t	m
	Number of constraints (size of bmin and bmax, number of rows of A).
ladel_sparse_matrix_ptr	Q = eigen_to_ladel_copy({n, n})
ladel_sparse_matrix_ptr	A = eigen_to_ladel_copy({m, n})
c_float	c = 0
vec_t	q = vec_t::Zero(n)
vec_t	bmin = vec_t::Zero(m)
vec_t	bmax = vec_t::Zero(m)

Constructor & Destructor Documentation

Data()

qpalm::Data::Data ( index_t  n, index_t  m  )

inline

Construct a problem of dimension n with m constraints.

Definition at line 55 of file qpalm.hpp.

Member Function Documentation

get_A()

sparse_mat_view_t qpalm::Data::get_A ( ) const

inline

Get a view on the A matrix of the problem.

Definition at line 84 of file qpalm.hpp.

get_c_data_ptr()

const ::QPALMData * qpalm::Data::get_c_data_ptr

(

)

const

Get a pointer to the underlying C data structure.

See also

QPALMData

Definition at line 7 of file qpalm.cpp.

get_Q()

sparse_mat_view_t qpalm::Data::get_Q ( ) const

inline

Get a view on the Q matrix of the problem.

Definition at line 74 of file qpalm.hpp.

set_A()

void qpalm::Data::set_A ( const sparse_mat_t &  A )

inline

Set the sparse A matrix. Creates a copy.

Examples

examples/cxx/qpalm_demo.cpp.

Definition at line 64 of file qpalm.hpp.

Here is the call graph for this function:

set_Q()

void qpalm::Data::set_Q ( const sparse_mat_t &  Q )

inline

Set the sparse Q matrix. Creates a copy.

Examples

examples/cxx/qpalm_demo.cpp.

Definition at line 58 of file qpalm.hpp.

Here is the call graph for this function:

Field Documentation

A

ladel_sparse_matrix_ptr qpalm::Data::A = eigen_to_ladel_copy({m, n})

Definition at line 47 of file qpalm.hpp.

bmax

vec_t qpalm::Data::bmax = vec_t::Zero(m)

Examples

examples/cxx/qpalm_demo.cpp.

Definition at line 51 of file qpalm.hpp.

bmin

vec_t qpalm::Data::bmin = vec_t::Zero(m)

Examples

examples/cxx/qpalm_demo.cpp.

Definition at line 50 of file qpalm.hpp.

c

c_float qpalm::Data::c = 0

Examples

examples/cxx/qpalm_demo.cpp.

Definition at line 48 of file qpalm.hpp.

m

index_t qpalm::Data::m

Number of constraints (size of bmin and bmax, number of rows of A).

Definition at line 45 of file qpalm.hpp.

n

index_t qpalm::Data::n

Problem dimension (size of x and q, number rows and columns of Q, number of columns of A).

Definition at line 42 of file qpalm.hpp.

Q

ladel_sparse_matrix_ptr qpalm::Data::Q = eigen_to_ladel_copy({n, n})

Definition at line 46 of file qpalm.hpp.

q

vec_t qpalm::Data::q = vec_t::Zero(n)

Examples

examples/cxx/qpalm_demo.cpp.

Definition at line 49 of file qpalm.hpp.

---

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

• QPALM/interfaces/cxx/include/qpalm.hpp
• QPALM/interfaces/cxx/src/qpalm.cpp