NLPModels.jl icon indicating copy to clipboard operation
NLPModels.jl copied to clipboard

Documentation tweaks (fixes #460)

Open timholy opened this issue 1 year ago • 1 comments

This eliminates the inconsistency in c_i = 0 vs c_L <= c_i <= c_U noted in #460. It also:

  • adds Manifest.toml to .gitignore
  • standardizes on y rather than λ for Lagrange multipliers
  • clarifies or polishes wording in various places
  • adds NLPModels to docs/Project.toml (this is standard and might allow simplification of your workflows)

timholy avatar Apr 30 '24 07:04 timholy

Package name latest stable
ADNLPModels.jl
AmplNLReader.jl
CUTEst.jl
CaNNOLeS.jl
DCISolver.jl
FletcherPenaltySolver.jl
JSOSolvers.jl
LLSModels.jl
NLPModelsIpopt.jl
NLPModelsJuMP.jl
NLPModelsModifiers.jl
NLPModelsTest.jl
PDENLPModels.jl
Percival.jl
QuadraticModels.jl
SolverBenchmark.jl
SolverCore.jl
SolverTest.jl
SolverTools.jl

github-actions[bot] avatar May 03 '24 23:05 github-actions[bot]

Bump

timholy avatar Jul 03 '24 00:07 timholy

Sorry @timholy for the delay, thanks a lot for the contribution. This is really appreciated. I will review it this weekend.

tmigot avatar Jul 06 '24 19:07 tmigot

There's a lot I like about switching from V to E. But I guess one reason against E_i is that

$$E_i \quad \forall i \in E$$

seems slightly weird: E is being used both as an index set and as a constraint-value set. (The V is "value".)

timholy avatar Jul 23 '24 12:07 timholy

What about using ${\cal E}$ and ${\cal I}$ for the index sets?

timholy avatar Jul 23 '24 12:07 timholy

e index sets?

That's a great idea, and very close to what is done in optimization literature.

tmigot avatar Jul 24 '24 00:07 tmigot

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.13%. Comparing base (d6e949f) to head (f6dfc96). Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #462      +/-   ##
==========================================
- Coverage   99.25%   99.13%   -0.13%     
==========================================
  Files          13       13              
  Lines         807      809       +2     
==========================================
+ Hits          801      802       +1     
- Misses          6        7       +1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jul 24 '24 21:07 codecov[bot]