1 /*
2 * Copyright (C) 2012 Alberto Irurueta Carro (alberto@irurueta.com)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package com.irurueta.numerical;
17
18 /**
19 * Listener to evaluate/retrieve a multidimensional function's gradient.
20 */
21 public interface GradientFunctionEvaluatorListener {
22
23 /**
24 * Computes/retrieves a multidimensional function's gradient.
25 *
26 * @param params Array of input parameters of a multidimensional function
27 * @param result Array containing estimated gradient. This parameter must
28 * contain an already instantiated array having the same length as params.
29 * The values of this gradient will be rewritten after executing this method
30 * and this array will contain the estimated or evaluated gradient
31 * @throws EvaluationException Raised if something fails.
32 */
33 void evaluateGradient(final double[] params, final double[] result) throws EvaluationException;
34 }