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.CalculusFieldElement;
20  import org.hipparchus.Field;
21  
22  /**
23   * An interface representing a scalar multivariate function for any field type.
24   * @see MultivariateFunction
25   * @since 2.2
26   */
27  public interface FieldMultivariateFunction {
28  
29      /** Convert to a {@link CalculusFieldMultivariateFunction} with a specific type.
30       * @param <T> the type of the field elements
31       * @param field field for the argument and value
32       * @return converted function
33       */
34      @SuppressWarnings("unchecked")
35      default <T extends CalculusFieldElement<T>> CalculusFieldMultivariateFunction<T> toCalculusFieldMultivariateFunction(Field<T> field) {
36          return this::value;
37      }
38  
39      /**
40       * Compute the value of the function.
41       *
42       * @param <T> the type of the field elements
43       * @param x Point at which the function value should be computed.
44       * @return the value of the function.
45       */
46      <T extends CalculusFieldElement<T>> T value(@SuppressWarnings("unchecked") T... x);
47  
48  }