View Javadoc
1   /*
2    * Licensed to the Hipparchus project 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 Hipparchus project 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    *      https://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  package org.hipparchus.analysis;
18  
19  import org.hipparchus.Field;
20  import org.hipparchus.CalculusFieldElement;
21  
22  /**
23   * An interface representing a bivariate field function.
24   * @since 1.5
25   */
26  public interface FieldBivariateFunction {
27  
28      /** Convert to a {@link CalculusFieldBivariateFunction} with a specific type.
29       * @param <T> the type of the field elements
30       * @param field field for the argument and value
31       * @return converted function
32       */
33      default <T extends CalculusFieldElement<T>> CalculusFieldBivariateFunction<T> toCalculusFieldBivariateFunction(Field<T> field) {
34          return this::value;
35      }
36  
37      /**
38       * Compute the value for the function.
39       *
40       * @param x Abscissa for which the function value should be computed.
41       * @param y Ordinate for which the function value should be computed.
42       * @param <T> type of the field elements
43       * @return the value.
44       */
45      <T extends CalculusFieldElement<T>> T value(T x, T y);
46  
47  }