TaoSetObjectiveAndGradient#

Sets a combined objective function and gradient evaluation routine for the function to be optimized

Synopsis#

#include "petsctao.h" 
PetscErrorCode TaoSetObjectiveAndGradient(Tao tao, Vec g, PetscErrorCode (*func)(Tao, Vec, PetscReal *, Vec, void *), void *ctx)

Logically collective

Input Parameters#

tao - the Tao context
g - [optional] the vector to internally hold the gradient computation
func - the gradient function
ctx - [optional] user-defined context for private data for the gradient evaluation routine (may be NULL)

Calling sequence of func#

func (Tao tao, Vec x, PetscReal *f, Vec g, void *ctx);

x - input vector
f - objective value (output)
g - gradient value (output)
ctx - [optional] user-defined function context

Note#

For some optimization methods using a combined function can be more eifficient.

Level#

beginner

Location#

src/tao/interface/taosolver_fg.c

Examples#

Edit on GitLab

Index of all Tao routines
Table of Contents for all manual pages
Index of all manual pages