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.math.analysis;
019    
020    import org.apache.commons.math.FunctionEvaluationException;
021    
022    /**
023     * An interface representing a trivariate real function.
024     *
025     * @since 2.2
026     * @version $Revision$ $Date$
027     */
028    public interface TrivariateRealFunction {
029        /**
030         * Compute the value for the function.
031         *
032         * @param x x-coordinate for which the function value should be computed.
033         * @param y y-coordinate for which the function value should be computed.
034         * @param z z-coordinate for which the function value should be computed.
035         * @return the value.
036         * @throws FunctionEvaluationException if the function evaluation fails.
037         */
038        double value(double x, double y, double z)
039            throws FunctionEvaluationException;
040    }