View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      https://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  
23  package org.hipparchus.analysis;
24  
25  /**
26   * An interface representing a multivariate real function.
27   *
28   */
29  public interface MultivariateFunction {
30  
31      /**
32       * Compute the value for the function at the given point.
33       *
34       * @param point Point at which the function must be evaluated.
35       * @return the function value for the given point.
36       * @throws org.hipparchus.exception.MathIllegalArgumentException
37       * if the parameter's dimension is wrong for the function being evaluated.
38       * @throws  org.hipparchus.exception.MathIllegalArgumentException
39       * when the activated method itself can ascertain that preconditions,
40       * specified in the API expressed at the level of the activated method,
41       * have been violated.  In the vast majority of cases where Hipparchus
42       * throws this exception, it is the result of argument checking of actual
43       * parameters immediately passed to a method.
44       */
45      double value(double[] point);
46  }