Gnimuc / LBFGSB.jl

Julia wrapper for L-BFGS-B Nonlinear Optimization Code
MIT License
38 stars 6 forks source link

An API that constructs the bounds matrix and the L_BFGS_B struct #10

Closed raminammour closed 4 years ago

raminammour commented 4 years ago

Hello,

Thanks for wrapping the lbfgsb library!

I think this interface is a bit more high level, lbfgsb can be exported and documented. Normally users solve with one problem size, and I could never remember what the bounds mean :)

Let me know if you think this is useful, and I can document/test and export these functions.

Cheers!

coveralls commented 4 years ago

Pull Request Test Coverage Report for Build 59


Changes Missing Coverage Covered Lines Changed/Added Lines %
src/wrapper.jl 16 19 84.21%
<!-- Total: 16 19 84.21% -->
Files with Coverage Reduction New Missed Lines %
src\wrapper.jl 3 91.3%
<!-- Total: 3 -->
Totals Coverage Status
Change from base Build 49: -2.7%
Covered Lines: 174
Relevant Lines: 184

💛 - Coveralls
Gnimuc commented 4 years ago

Thanks for your contribution! This looks good. I'll merge it when the documentation and tests are added. 😉

raminammour commented 4 years ago

Do you want lbfgsb documented as the main API or as an additional (secondary) API to the existing one?

Gnimuc commented 4 years ago

I guess it's more like a helper function over the original one. We can mention it in the README and add some docstrings with a simple example.

raminammour commented 4 years ago

I added some tests and some help in the README. LBFGS_B does not have doc strings itself to piggy back off of those so I relied on the README. Let me know if this is sufficient.

Gnimuc commented 4 years ago

LGTM. Thanks again!