objeval.m

From Spinach Documentation Wiki
Jump to: navigation, search

Calls and collect the correct amount of outputs from an objective function - used by optimisation routines of the optimal control module. this is needed because some outputs of optimal control objective functions are very expensive.

Syntax

    [data,fx,grad,hess]=objeval(x,objfun_handle,data,spin_system)

Arguments

   x                  - objective function argument 
    
   objfun_handle      - handle to the objective function
    
   data               - data structure inherited from 
                        fminnewton.m

Returns

   data               - modified data structure with 
                        diagnostics from the objective
   
   fx                 - objective function value at x
   
   grad               - gradient of the objective function 
                        at x
   
   hess               - Hessian of the objective function 
                        at x

Notes

This function will be eliminated in a future release.

See also

fminnewton.m, lbfgs.m, hessreg.m


Version 2.2, authors: David Goodwin, Ilya Kuprov