Skip to content

Add documentation#51

Closed
frapac wants to merge 4 commits into
mainfrom
fp/docs
Closed

Add documentation#51
frapac wants to merge 4 commits into
mainfrom
fp/docs

Conversation

@frapac

@frapac frapac commented Apr 29, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

Comment thread docs/Project.toml
@@ -0,0 +1,7 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am currently using DocumenterInterLinks to address the references in MOI. Let me know if you have a better solution

* `x₂ ≤ ub` (ub ≠ 0) gives `S = MOI.LessThan{T}`
* `lb ≤ x₂ ≤ ub` gives `S = MOI.Interval{T}`
* `x₂` free gives `S = MOI.Zeros`
* `x₂` free gives `S = MOI.Real`

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to discuss about this change, as I am not sure about it.

To me S is the set where x2 (the right-hand-side) belongs. The set of x1 is MOI.dual_set_type(S) (if it applies).

If x2 is free, then I think we should define S = MOI.Real. Or am I missing something?

@codecov

codecov Bot commented Apr 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7676233) to head (aa8cc27).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #51   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        14           
  Lines          575       575           
=========================================
  Hits           575       575           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@odow

odow commented May 22, 2026

Copy link
Copy Markdown
Member

I don't think this package needs dedicated documentation. The README should suffice. We can direct folks to the JuMP docs instead.

@frapac

frapac commented May 22, 2026

Copy link
Copy Markdown
Collaborator Author

To me, the main motivation for this documentation is to write tutorials. To name a few :

  • complementarity approach for market power ;
  • complementarity approach for power systems ;
  • complementarity approach for non-smooth optimal control.

The idea is to give a list of concrete applications for this package, and a few reformulation tricks. I am not sure this can fit in the README (but maybe not a good idea to include these tutorials in this package's documentation).

@odow

odow commented May 23, 2026

Copy link
Copy Markdown
Member

Agree on the tutorials, but I think I'd prefer that we added this package as a dependency to the JuMP docs and made stuff like https://jump.dev/JuMP.jl/dev/tutorials/nonlinear/complementarity/

@odow

odow commented May 23, 2026

Copy link
Copy Markdown
Member

Maintaining many separate documentation websites is a pain

@frapac

frapac commented May 25, 2026

Copy link
Copy Markdown
Collaborator Author

Your comment makes sense. If you think it makes sense to have the tutorials in JuMP's documentation, then let's go for it.

Closing this PR as it is not relevant anymore.

@frapac frapac closed this May 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants