From 1041bf2002c6b256795484031d8f68ca85cfef05 Mon Sep 17 00:00:00 2001 From: Honglin Yu Date: Thu, 18 Dec 2014 21:33:02 +1100 Subject: [PATCH] update description of ogFunc --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ab7ddd2..12e90be 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ I am new to Julia language so the code will be cleaned gradually - Currently only provide a function called ```lbfgsb```, see its option below, # Options - - ```ogFunc``` : Objective and gradient function. It accept cuurent ```x``` and return the objective function and gradient value in a tuple. + - ```ogFunc``` : Objective and gradient function. It accept current ```x``` and a gradient array ```g```. It should return the objective function value and put the gradient into into ```g```. - ```x``` : Initial value of ```x```. - ```lb``` : lower bounds of each dimension of ```x```. Set to ```-Inf``` if equals to ```[]```. - ```ub``` : upper bounds of each dimension of ```x```. Set to ```Inf``` if equals to ```[]```.