mlfGradient (MATLAB C Math Library)

Numerical gradient

Minimum number of arguments: four, maximum: user-defined. Terminate the argument list with a NULL.

C Prototype

mxArray *mlfGradient(mlfVarargoutList *varargout, mxArray *f, ...);

C Syntax

#include "matlab.h"

mxArray *F;            /* Required input argument(s) */
mxArray *h, *h1;       /* Optional input argument(s) */
mxArray *FY = NULL;    /* Optional output argument(s) */
mxArray *FX = NULL;    /* Return value */

mlfAssign(&FX, mlfGradient(NULL,F,NULL,NULL));
mlfAssign(&FX, mlfGradient(NULL,F,h,NULL));
mlfAssign(&FX, mlfGradient(&FY,F,NULL,NULL));
mlfAssign(&FX, mlfGradient(&FY,F,h,NULL));
mlfAssign(&FX, mlfGradient(&FY,F,h1,h2));

mlfGradient(mlfVarargout(&FX,NULL),F,NULL,NULL));
mlfGradient(mlfVarargout(&FX,&FY,NULL),F,h,NULL));
mlfGradient(mlfVarargout(&Fx,&Fy,&Fz,...,NULL),F,NULL,NULL));
mlfAssign(&FX, mlfGradient(mlfVarargout(&I,&J,NULL)&FY,F,h,NULL));
mlfAssign(&FX, mlfGradient(mlfVarargout(&I,&J,NULL)&FY,F,h1,h2));

mlfInd2sub(mlfVarargout(&I,&J,NULL),siz,IND);
mlfInd2sub(mlfVarargout(&I1,I2,I3,...,NULL),siz,IND);

Note
With pure varargout functions, do not use the first output argument as the return value for the function. Pass all output arguments to mlfVarargout(). You do not need to use mlfAssign() to assign a return value.

MATLAB Syntax

FX = gradient(F)
[FX,FY] = gradient(F)
[Fx,Fy,Fz,...] = gradient(F)
[...] = gradient(F,h)
[...] = gradient(F,h1,h2,...)