#include "Auxilary.h"

Include dependency graph for qpSWIFT.h:

This graph shows which files directly or indirectly include this file:

Functions
QP *	QP_SETUP (qp_int n, qp_int m, qp_int p, qp_int Pjc, qp_int Pir, qp_real Ppr, qp_int Ajc, qp_int Air, qp_real Apr, qp_int Gjc, qp_int Gir, qp_real Gpr, qp_real c, qp_real h, qp_real b, qp_real sigma_d, qp_int *Permut)
	qpSWIFT entry point Function More...

QP *	QP_SETUP_dense (qp_int n, qp_int m, qp_int p, qp_real Ppr, qp_real Apr, qp_real Gpr, qp_real c, qp_real h, qp_real b, qp_int *Permut, int ordering)
	qpSWIFT entry point Function More...

qp_int	QP_SOLVE (QP *myQP)
	qpSWIFT main function More...

void	QP_CLEANUP (QP *myQP)
	qpSWIFT exit function More...

void	QP_CLEANUP_dense (QP *myQP)
	qpSWIFT exit function More...

Function Documentation

◆ QP_CLEANUP()

void QP_CLEANUP ( QP * myQP )

qpSWIFT exit function

Parameters

[in] myQP QP structure with all the fields written

all the allocated memory is cleared
must be called after QP_SETUP, QP_SOLVE functions only
Clears all the memory except the input arguments of QP_SETUP function

◆ QP_CLEANUP_dense()

void QP_CLEANUP_dense ( QP * myQP )

qpSWIFT exit function

Parameters

[in] myQP QP structure with all the fields written

all the allocated memory is cleared
must be called after QP_SETUP_dense, QP_SOLVE functions only
Clears all the memory except the input arguments of QP_SETUP function

◆ QP_SETUP()

QP* QP_SETUP	(	qp_int	n,
		qp_int	m,
		qp_int	p,
		qp_int *	Pjc,
		qp_int *	Pir,
		qp_real *	Ppr,
		qp_int *	Ajc,
		qp_int *	Air,
		qp_real *	Apr,
		qp_int *	Gjc,
		qp_int *	Gir,
		qp_real *	Gpr,
		qp_real *	c,
		qp_real *	h,
		qp_real *	b,
		qp_real	sigma_d,
		qp_int *	Permut
	)

qpSWIFT entry point Function

Parameters

[out]	myQP	QP structure with all the fields written
[in]	n	Number of equality constraints, must be non-zero
[in]	m	Number of inequality constraints, must be non-zero
[in]	p	Number of equality constraints, can be zero if none specified
[in]	Pjc	jc vector of P matrix in Compressed Coulmn Storage format; required
[in]	Pir	ir vector of P matrix in Compressed Coulmn Storage format; required
[in]	Ppr	pr vector of P matrix in Compressed Coulmn Storage format; required
[in]	Ajc	jc vector of A matrix in Compressed Coulmn Storage format; can be set to NULL if not needed
[in]	Air	ir vector of A matrix in Compressed Coulmn Storage format; can be set to NULL if not needed
[in]	Apr	pr vector of A matrix in Compressed Coulmn Storage format; can be set to NULL if not needed
[in]	Gjc	jc vector of G matrix in Compressed Coulmn Storage format; required
[in]	Gir	ir vector of G matrix in Compressed Coulmn Storage format; required
[in]	Gpr	pr vector of G matrix in Compressed Coulmn Storage format; required
[in]	c	c vector
[in]	h	h vector
[in]	b	b vector
[in]	sigma_d	entering parameter; default value is 0.0
[in]	Permut	permutation vector of the KKT matrix; can be set to NULL to use the default AMD ordering

-> takes input in dense matrix format only
-> no error checking is performed

◆ QP_SETUP_dense()

QP* QP_SETUP_dense	(	qp_int	n,
		qp_int	m,
		qp_int	p,
		qp_real *	Ppr,
		qp_real *	Apr,
		qp_real *	Gpr,
		qp_real *	c,
		qp_real *	h,
		qp_real *	b,
		qp_int *	Permut,
		int	ordering
	)

qpSWIFT entry point Function

Parameters

[out]	myQP	QP structure with all the fields written
[in]	n	Number of equality constraints, must be non-zero
[in]	m	Number of inequality constraints, must be non-zero
[in]	p	Number of equality constraints, can be zero if none specified
[in]	Ppr	pointer to the matrix P; can be in either column major or row major
[in]	Apr	pointer to the matrix A; can be in either column major or row major; can be set ot NULL if not needed
[in]	Gpr	pointer to the matrix G; can be in either column major or row major
[in]	c	c vector
[in]	h	h vector
[in]	b	b vector; can be set to NULL if not needed
[in]	Permut	permutation vector of the KKT matrix; can be set to NULL to use the default AMD ordering
[in]	ordering	ordering of all the three matrices P, A and G; available options are ROW_MAJOR_ORDERING for row major ordering of P, A and G matrices COLUMN_MAJOR_ORDERING for column major ordering of P, A and G matrices

-> takes input in dense matrix format only
-> no error checking is performed

◆ QP_SOLVE()

qp_int QP_SOLVE ( QP * myQP )

qpSWIFT main function

Parameters

[in]	myQP	QP structure with all the fields written
[out]	ExitCode	Number of equality constraints, must be non-zero

all the iterations are performed here must be called after QP_SETUP or QP_SETUP_dense function only

ExitCode = 0 => Optimal Solution Found
ExitCode = 1 => Failure in solving LDL' factorization
ExitCode = 2 => Maximum Number of Iterations Exceeded
ExitCode = 3 => Unknown Problem in Solver

Functions

Function Documentation

◆ QP_CLEANUP()

◆ QP_CLEANUP_dense()

◆ QP_SETUP()

◆ QP_SETUP_dense()

◆ QP_SOLVE()