com.imsl.math
Interface MinConNLP.Gradient

All Superinterfaces:

MinConNLP.Function

Enclosing class:

MinConNLP

public static interface MinConNLP.Gradient
extends MinConNLP.Function

Public interface for the user supplied function to compute the gradient for MinConNLP object.

Method Summary

void	gradient(double[] x, int iact, double[] result) Computes the value of the gradient of the function at the given point.

Methods inherited from interface com.imsl.math.MinConNLP.Function

f

Method Detail

gradient

void gradient(double[] x,
              int iact,
              double[] result)

Computes the value of the gradient of the function at the given point.

Parameters:

x - an input double array, the point at which the gradient of the objective function or gradient of a constraint is to be evaluated

iact - an input int value indicating whether evaluation of the objective function gradient is requested or evaluation of a constraint gradient is requested. If iact is zero, then an objective function gradient evaluation is requested. If iact is nonzero then the value of iact indicates the index of the constraint gradient to evaluate. (1 indicates the first constraint, 2 indicates the second, etc.)

result - a double array. If iact is zero, then the value of the objective function gradient at x is returned in result. If iact is nonzero, then the computed gradient of the requested constraint value at the point x is returned in result.