Skip to content

Commit f179733

Browse files
authored
Merge pull request #5 from gabrielebndn/doc
[README] Document different implementations
2 parents 25242f0 + bd999e3 commit f179733

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,21 @@
33
[![Pipeline status](https://gepgitlab.laas.fr/stack-of-tasks/eiquadprog/badges/master/pipeline.svg)](https://gepgitlab.laas.fr/stack-of-tasks/eiquadprog/commits/master)
44
[![Coverage report](https://gepgitlab.laas.fr/stack-of-tasks/eiquadprog/badges/master/coverage.svg?job=doc-coverage)](http://projects.laas.fr/gepetto/doc/stack-of-tasks/eiquadprog/master/coverage/)
55

6-
This repo contains a C++ implementation of the algorithm of Goldfarb and Idnani for the solution of a (convex) Quadratic Programming problem by means of a dual method.
6+
This repo contains different C++ implementations of the algorithm of Goldfarb and Idnani for the solution of a (convex) Quadratic Programming problem by means of a dual method.
77

88
The problem is in the form:
99
min 0.5 * x G x + g0 x
1010
s.t.
1111
CE^T x + ce0 = 0
1212
CI^T x + ci0 >= 0
1313

14+
There are 3 implementations:
15+
- `eiquadprog.hpp`: the original C++ implementation
16+
- `eiquadprog-fast.hpp`: an improved version employing a wrapper, avoiding dynamic memory allocation
17+
- `eiquadprog-rt.hpp`: similar to the above, it employs fixed-size Eigen vectors. This requires the problem dimensions to be known at compile time and is recommended only for small problems.
18+
19+
Please refer to the unit tests for examples of usage.
20+
1421
## Authors
1522

1623
[Eiquadprog](https://github.com/stack-of-tasks/eiquadprog) was created at LAAS-CNRS by Gabriele Buondonno, based on

0 commit comments

Comments
 (0)