stack-of-tasks / eiquadprog

C++ reimplementation of eiquadprog

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Document the difference between solvers

nim65s opened this issue · comments

As reported by @jmirabel in humanoid-path-planner/hpp-core#190 (comment), it would be nice to explain why do we have

  • eiquadprog
  • eiquadprog-fast
  • eiquadprog-rt

This should probably go to the README.

@gabrielebndn: could you do that ? :)

It can be easily explained in a few lines.
I think the best would be a properly-made doc, with doxygen and all, but it would take me some time to set it up.
If I can just put them in the README, I can certainly do it very quickly.

A couple lines in the README would do for now, because it currently says that

This repo contains a C++ implementation

While it contains 3…

I don't mind a properly-made doc, but we don't have to wait for it to fix the README :)

A doxygen doc is overkill for this purpose.

fixed by #5