math.function.Gradient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of finwhale Show documentation

Statistical distributions library (in statu nascendi)

There is a newer version: 0.9.5

package math.function;

/**
 * Interface for the gradient of once-differentiable double-valued functions
 * over double[] arrays.
 */
public interface Gradient {
    /**
     * The first-derivative vector (a.k.a. gradient) of a double-valued function
     * over a double[] array evaluated at the input location {@code x} gets
     * stored into the output vector {@code grad}.
     * 
     * @param x
     *            a double[] input vector (not modified)
     * @param grad
     *            a double[] output vector containing the gradient
     *            at location {@code x} (modified)
     */
    void derivativeAt(double[] x, double[] grad);
}