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 * http://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 package org.apache.commons.math4.legacy.analysis;
19
20 /**
21 * An interface representing a multivariate real function.
22 *
23 * @since 2.0
24 */
25 public interface MultivariateFunction {
26
27 /**
28 * Compute the value for the function at the given point.
29 *
30 * @param point Point at which the function must be evaluated.
31 * @return the function value for the given point.
32 * @throws org.apache.commons.math4.legacy.exception.DimensionMismatchException
33 * if the parameter's dimension is wrong for the function being evaluated.
34 * @throws org.apache.commons.math4.legacy.exception.MathIllegalArgumentException
35 * when the activated method itself can ascertain that preconditions,
36 * specified in the API expressed at the level of the activated method,
37 * have been violated. In the vast majority of cases where Commons Math
38 * throws this exception, it is the result of argument checking of actual
39 * parameters immediately passed to a method.
40 */
41 double value(double[] point);
42 }