001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018 package org.apache.commons.math3.analysis;
019
020 /**
021 * An interface representing a multivariate real function.
022 *
023 * @version $Id: MultivariateFunction.java 1364387 2012-07-22 18:14:11Z tn $
024 * @since 2.0
025 */
026 public interface MultivariateFunction {
027
028 /**
029 * Compute the value for the function at the given point.
030 *
031 * @param point Point at which the function must be evaluated.
032 * @return the function value for the given point.
033 * @throws org.apache.commons.math3.exception.DimensionMismatchException
034 * if the parameter's dimension is wrong for the function being evaluated.
035 * @throws org.apache.commons.math3.exception.MathIllegalArgumentException
036 * when the activated method itself can ascertain that preconditions,
037 * specified in the API expressed at the level of the activated method,
038 * have been violated. In the vast majority of cases where Commons Math
039 * throws this exception, it is the result of argument checking of actual
040 * parameters immediately passed to a method.
041 */
042 double value(double[] point);
043 }