View Javadoc
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   * Interface to define how multi dimension functions can be evaluated.
20   * This interface is used in several algorithms to provide methods to evaluate
21   * functions and retrieve their minima/maxima, etc.
22   */
23  public interface MultiDimensionFunctionEvaluatorListener {
24  
25      /**
26       * Evaluates a multi dimension function such as f([x1, x2, ..., xn]) at
27       * provided multidimensional point and returns the result as a scalar value.
28       *
29       * @param point Multidimensional point where function will be evaluated.
30       *              This must be an array of length equal to the dimensionality of the
31       *              function.
32       * @return Value returned by the function.
33       * @throws EvaluationException Raised if something failed during the evaluation.
34       */
35      double evaluate(final double[] point) throws EvaluationException;
36  }