Skip to content

Commit 28a4d8e

Browse files
Add docstring
1 parent 7f5ae93 commit 28a4d8e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/lbfgsb.jl

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
using Optimization.SciMLBase, LBFGSB
22

3+
"""
4+
$(TYPEDEF)
5+
6+
L-BFGS-B Nonlinear Optimization Code from [LBFGSB](https://github.com/Gnimuc/LBFGSB.jl/tree/master).
7+
It is a quasi-Newton optimization algorithm that supports bounds.
8+
9+
References
10+
11+
- R. H. Byrd, P. Lu and J. Nocedal. A Limited Memory Algorithm for Bound Constrained Optimization, (1995), SIAM Journal on Scientific and Statistical Computing , 16, 5, pp. 1190-1208.
12+
- C. Zhu, R. H. Byrd and J. Nocedal. L-BFGS-B: Algorithm 778: L-BFGS-B, FORTRAN routines for large scale bound constrained optimization (1997), ACM Transactions on Mathematical Software, Vol 23, Num. 4, pp. 550 - 560.
13+
- J.L. Morales and J. Nocedal. L-BFGS-B: Remark on Algorithm 778: L-BFGS-B, FORTRAN routines for large scale bound constrained optimization (2011), to appear in ACM Transactions on Mathematical Software.
14+
"""
315
@kwdef struct LBFGS
416
m::Int=10
517
end

0 commit comments

Comments
 (0)