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 univariate real function for any field type.
24 * <p>
25 * This interface is more general than {@link CalculusFieldUnivariateFunction} because
26 * the same instance can accept any field type, not just one.
27 * </p>
28 * @see UnivariateFunction
29 * @see CalculusFieldUnivariateFunction
30 * @since 1.3
31 */
32 public interface FieldUnivariateFunction {
33
34 /** Convert to a {@link CalculusFieldUnivariateFunction} with a specific type.
35 * @param <T> the type of the field elements
36 * @param field field for the argument and value
37 * @return converted function
38 */
39 default <T extends CalculusFieldElement<T>> CalculusFieldUnivariateFunction<T> toCalculusFieldUnivariateFunction(Field<T> field) {
40 return this::value;
41 }
42
43 /**
44 * Compute the value of the function.
45 *
46 * @param <T> the type of the field elements
47 * @param x Point at which the function value should be computed.
48 * @return the value of the function.
49 * @throws IllegalArgumentException when the activated method itself can
50 * ascertain that a precondition, specified in the API expressed at the
51 * level of the activated method, has been violated.
52 * When Hipparchus throws an {@code IllegalArgumentException}, it is
53 * usually the consequence of checking the actual parameters passed to
54 * the method.
55 */
56 <T extends CalculusFieldElement<T>> T value(T x);
57
58 }