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    *      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.math.analysis;
19  
20  import org.apache.commons.math.FunctionEvaluationException;
21  
22  /** 
23   * An interface representing a multivariate real function.
24   * @version $Revision: 799857 $ $Date: 2009-08-01 09:07:12 -0400 (Sat, 01 Aug 2009) $
25   * @since 2.0
26   */
27  public interface MultivariateRealFunction {
28  
29      /** 
30       * Compute the value for the function at the given point.
31       * @param point point at which the function must be evaluated
32       * @return function value for the given point
33       * @exception FunctionEvaluationException if the function evaluation fails
34       * @exception IllegalArgumentException if points dimension is wrong
35       */
36      double value(double[] point)
37          throws FunctionEvaluationException, IllegalArgumentException;
38  
39  }