Home | History | Annotate | Download | only in analysis
      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 trivariate real function.
     24  *
     25  * @since 2.2
     26  * @version $Revision$ $Date$
     27  */
     28 public interface TrivariateRealFunction {
     29     /**
     30      * Compute the value for the function.
     31      *
     32      * @param x x-coordinate for which the function value should be computed.
     33      * @param y y-coordinate for which the function value should be computed.
     34      * @param z z-coordinate for which the function value should be computed.
     35      * @return the value.
     36      * @throws FunctionEvaluationException if the function evaluation fails.
     37      */
     38     double value(double x, double y, double z)
     39         throws FunctionEvaluationException;
     40 }
     41