package/gonum
1
0
Fork 0
mirror of https://github.com/gonum/gonum.git synced 2025-09-26 19:21:17 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

optimize: fix doc comments for Grad and Hess fields of Problem

Browse Source
This commit is contained in:
Dan Kortschak
2019-04-30 23:02:58 +09:30
parent ac0c935b54
commit 9827ae2933
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
optimize/types.go
View File

@@ -123,14 +123,12 @@ type Problem struct {
// must not modify x.
Func func(x []float64) float64
// Grad evaluates the gradient at x and returns the result. Grad may use
// the provided slice which will be the same length as x. Grad must not
// modify x.
// Grad evaluates the gradient at x and stores the result in grad which will
// be the same length as x. Grad must not modify x.
Grad func(grad, x []float64)
// Hess evaluates the Hessian at x and stores the result in-place in hess.
// Hess must not modify x. Hess may use the provided mat.SymDense which
// will have dimensions matching the length of x.
// Hess evaluates the Hessian at x and stores the result in-place in hess which
// will have dimensions matching the length of x. Hess must not modify x.
Hess func(hess *mat.SymDense, x []float64)
// Status reports the status of the objective function being optimized and any