Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic documentation should be added #23

Open
CoronelBuendia opened this issue Apr 4, 2025 · 0 comments · May be fixed by #25
Open

Basic documentation should be added #23

CoronelBuendia opened this issue Apr 4, 2025 · 0 comments · May be fixed by #25

Comments

@CoronelBuendia
Copy link

OK, so I've had a quick look at this and it all seems to work fine, but I had a few hiccoughs along the way, mostly to do with some assumptions I made. I think it would be great to add the following minor additions to the documentation:

  • Make explicit the form of the QSP being solved. Specifically the orders of the Taylor expansions of the objective (2nd) and constraint functions (1st). But this would be made clear by simply stating that the objective is assumed to be quadratic and the constraints are linearised. Or just the equation!
  • Clearly document that the sign convention for inequality constraints is >= 0.0. This is not a universal convention in optimisers and is worth mentioning.
  • I briefly tried in Add complex alkylation test #20 to include equality and inequality constraints with vector outputs, but did not succeed. From briefly looking at the code (specifically T) it would appear possible to have vector-valued constraints. Either make it clearer what the proper API is for specifying vector-valued constraints and matrix Jacobians (also i, j or j,i ?) or error if this is attempted.
@timothy-nunn timothy-nunn linked a pull request Apr 11, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant