Functions
OQPinterface.h File Reference
#include <qpOASES_e/Utils.h>
#include <qpOASES_e/Options.h>
Include dependency graph for OQPinterface.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

returnValue readOQPdata (const char *path, int *nQP, int *nV, int *nC, int *nEC, real_t *H, real_t *g, real_t *A, real_t *lb, real_t *ub, real_t *lbA, real_t *ubA, real_t *xOpt, real_t *yOpt, real_t *objOpt)
 
BEGIN_NAMESPACE_QPOASES returnValue readOQPdimensions (const char *path, int *nQP, int *nV, int *nC, int *nEC)
 
returnValue runOQPbenchmark (const char *path, BooleanType isSparse, BooleanType useHotstarts, const Options *options, int maxAllowedNWSR, real_t *maxNWSR, real_t *avgNWSR, real_t *maxCPUtime, real_t *avgCPUtime, real_t *maxStationarity, real_t *maxFeasibility, real_t *maxComplementarity)
 
returnValue solveOQPbenchmark (int nQP, int nV, int nC, int nEC, real_t *_H, const real_t *const g, real_t *_A, const real_t *const lb, const real_t *const ub, const real_t *const lbA, const real_t *const ubA, BooleanType isSparse, BooleanType useHotstarts, const Options *options, int maxAllowedNWSR, real_t *maxNWSR, real_t *avgNWSR, real_t *maxCPUtime, real_t *avgCPUtime, real_t *maxStationarity, real_t *maxFeasibility, real_t *maxComplementarity)
 
returnValue solveOQPbenchmarkB (int nQP, int nV, real_t *_H, const real_t *const g, const real_t *const lb, const real_t *const ub, BooleanType isSparse, BooleanType useHotstarts, const Options *options, int maxAllowedNWSR, real_t *maxNWSR, real_t *avgNWSR, real_t *maxCPUtime, real_t *avgCPUtime, real_t *maxStationarity, real_t *maxFeasibility, real_t *maxComplementarity)
 

Detailed Description

Author
Hans Joachim Ferreau, Andreas Potschka, Christian Kirches
Version
3.1embedded
Date
2007-2015

Declaration of an interface comprising several utility functions for solving test problems from the Online QP Benchmark Collection (This collection is no longer maintained, see http://www.qpOASES.org/onlineQP for a backup).

Definition in file OQPinterface.h.

Function Documentation

returnValue readOQPdata ( const char *  path,
int *  nQP,
int *  nV,
int *  nC,
int *  nEC,
real_t H,
real_t g,
real_t A,
real_t lb,
real_t ub,
real_t lbA,
real_t ubA,
real_t xOpt,
real_t yOpt,
real_t objOpt 
)

Reads data of an Online QP Benchmark problem from file. This function allocates the required memory for all data; after successfully calling it, you have to free this memory yourself!

Returns
SUCCESSFUL_RETURN
RET_INVALID_ARGUMENTS
RET_UNABLE_TO_READ_FILE
RET_FILEDATA_INCONSISTENT
Parameters
pathFull path of the data files (without trailing slash!).
nQPOutput: Number of QPs.
nVOutput: Number of variables.
nCOutput: Number of constraints.
nECOutput: Number of equality constraints.
HOutput: Hessian matrix.
gOutput: Sequence of gradient vectors.
AOutput: Constraint matrix.
lbOutput: Sequence of lower bound vectors (on variables).
ubOutput: Sequence of upper bound vectors (on variables).
lbAOutput: Sequence of lower constraints' bound vectors.
ubAOutput: Sequence of upper constraints' bound vectors.
xOptOutput: Sequence of primal solution vectors (not read if a null pointer is passed).
yOptOutput: Sequence of dual solution vectors (not read if a null pointer is passed).
objOptOutput: Sequence of optimal objective function values (not read if a null pointer is passed).

Definition at line 85 of file OQPinterface.c.

BEGIN_NAMESPACE_QPOASES returnValue readOQPdimensions ( const char *  path,
int *  nQP,
int *  nV,
int *  nC,
int *  nEC 
)

Reads dimensions of an Online QP Benchmark problem from file.

Returns
SUCCESSFUL_RETURN
RET_UNABLE_TO_READ_FILE
RET_FILEDATA_INCONSISTENT
Parameters
pathFull path of the data files (without trailing slash!).
nQPOutput: Number of QPs.
nVOutput: Number of variables.
nCOutput: Number of constraints.
nECOutput: Number of equality constraints.

Definition at line 50 of file OQPinterface.c.

returnValue runOQPbenchmark ( const char *  path,
BooleanType  isSparse,
BooleanType  useHotstarts,
const Options options,
int  maxAllowedNWSR,
real_t maxNWSR,
real_t avgNWSR,
real_t maxCPUtime,
real_t avgCPUtime,
real_t maxStationarity,
real_t maxFeasibility,
real_t maxComplementarity 
)

Runs an Online QP Benchmark problem and determines the maximum violation of the KKT optimality conditions as well as the maximum and average number of iterations and CPU time to solve each QP.

Returns
SUCCESSFUL_RETURN
RET_UNABLE_TO_READ_BENCHMARK
RET_BENCHMARK_ABORTED
Parameters
pathFull path of the benchmark files (without trailing slash!).
isSparseShall convert matrices to sparse format before solution?
useHotstartsShall QP solution be hotstarted?
optionsQP solver options to be used while solving benchmark problems.
maxAllowedNWSRMaximum number of working set recalculations to be performed.
maxNWSROutput: Maximum number of performed working set recalculations.
avgNWSROutput: Average number of performed working set recalculations.
maxCPUtimeOutput: Maximum CPU time required for solving each QP.
avgCPUtimeOutput: Average CPU time required for solving each QP.
maxStationarityOutput: Maximum residual of stationarity condition.
maxFeasibilityOutput: Maximum residual of primal feasibility condition.
maxComplementarityOutput: Maximum residual of complementarity condition.

Definition at line 413 of file OQPinterface.c.

returnValue solveOQPbenchmark ( int  nQP,
int  nV,
int  nC,
int  nEC,
real_t _H,
const real_t *const  g,
real_t _A,
const real_t *const  lb,
const real_t *const  ub,
const real_t *const  lbA,
const real_t *const  ubA,
BooleanType  isSparse,
BooleanType  useHotstarts,
const Options options,
int  maxAllowedNWSR,
real_t maxNWSR,
real_t avgNWSR,
real_t maxCPUtime,
real_t avgCPUtime,
real_t maxStationarity,
real_t maxFeasibility,
real_t maxComplementarity 
)

Solves an Online QP Benchmark problem as specified by the arguments. The maximum deviations from the given optimal solution as well as the maximum CPU time to solve each QP are determined.

Returns
SUCCESSFUL_RETURN
RET_BENCHMARK_ABORTED
Parameters
nQPNumber of QPs.
nVNumber of variables.
nCNumber of constraints.
nECNumber of equality constraints.
_HHessian matrix.
gSequence of gradient vectors.
_AConstraint matrix.
lbSequence of lower bound vectors (on variables).
ubSequence of upper bound vectors (on variables).
lbASequence of lower constraints' bound vectors.
ubASequence of upper constraints' bound vectors.
isSparseShall convert matrices to sparse format before solution?
useHotstartsShall QP solution be hotstarted?
optionsQP solver options to be used while solving benchmark problems.
maxAllowedNWSRMaximum number of working set recalculations to be performed.
maxNWSROutput: Maximum number of performed working set recalculations.
avgNWSROutput: Average number of performed working set recalculations.
maxCPUtimeOutput: Maximum CPU time required for solving each QP.
avgCPUtimeOutput: Average CPU time required for solving each QP.
maxStationarityOutput: Maximum residual of stationarity condition.
maxFeasibilityOutput: Maximum residual of primal feasibility condition.
maxComplementarityOutput: Maximum residual of complementarity condition.

Definition at line 178 of file OQPinterface.c.

returnValue solveOQPbenchmarkB ( int  nQP,
int  nV,
real_t _H,
const real_t *const  g,
const real_t *const  lb,
const real_t *const  ub,
BooleanType  isSparse,
BooleanType  useHotstarts,
const Options options,
int  maxAllowedNWSR,
real_t maxNWSR,
real_t avgNWSR,
real_t maxCPUtime,
real_t avgCPUtime,
real_t maxStationarity,
real_t maxFeasibility,
real_t maxComplementarity 
)

Solves an Online QP Benchmark problem (without constraints) as specified by the arguments. The maximum deviations from the given optimal solution as well as the maximum CPU time to solve each QP are determined.

Returns
SUCCESSFUL_RETURN
RET_BENCHMARK_ABORTED
Parameters
nQPNumber of QPs.
nVNumber of variables.
_HHessian matrix.
gSequence of gradient vectors.
lbSequence of lower bound vectors (on variables).
ubSequence of upper bound vectors (on variables).
isSparseShall convert matrices to sparse format before solution?
useHotstartsShall QP solution be hotstarted?
optionsQP solver options to be used while solving benchmark problems.
maxAllowedNWSRMaximum number of working set recalculations to be performed.
maxNWSROutput: Maximum number of performed working set recalculations.
avgNWSROutput: Average number of performed working set recalculations.
maxCPUtimeOutput: Maximum CPU time required for solving each QP.
avgCPUtimeOutput: Average CPU time required for solving each QP.
maxStationarityOutput: Maximum residual of stationarity condition.
maxFeasibilityOutput: Maximum residual of primal feasibility condition.
maxComplementarityOutput: Maximum residual of complementarity condition.

Definition at line 302 of file OQPinterface.c.



acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:20