View Javadoc
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    *      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  
18  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  package org.hipparchus.analysis.differentiation;
23  
24  import org.hipparchus.analysis.UnivariateMatrixFunction;
25  import org.hipparchus.exception.MathIllegalArgumentException;
26  
27  /**
28   * Extension of {@link UnivariateMatrixFunction} representing a univariate differentiable matrix function.
29   *
30   */
31  public interface UnivariateDifferentiableMatrixFunction
32      extends UnivariateMatrixFunction {
33  
34      /**
35       * Compute the value for the function.
36       * @param x the point for which the function value should be computed
37       * @param <T> the type of the field elements
38       * @return the value
39       * @exception MathIllegalArgumentException if {@code x} does not
40       * satisfy the function's constraints (argument out of bound, or unsupported
41       * derivative order for example)
42       */
43      <T extends Derivative<T>> T[][] value(T x) throws MathIllegalArgumentException;
44  
45  }