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    *      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  package org.apache.commons.math3.analysis.differentiation;
18  
19  import org.apache.commons.math3.analysis.UnivariateMatrixFunction;
20  import org.apache.commons.math3.exception.MathIllegalArgumentException;
21  
22  /**
23   * Extension of {@link UnivariateMatrixFunction} representing a univariate differentiable matrix function.
24   *
25   * @version $Id: UnivariateDifferentiableMatrixFunction.java 1462496 2013-03-29 14:56:08Z psteitz $
26   * @since 3.1
27   */
28  public interface UnivariateDifferentiableMatrixFunction
29      extends UnivariateMatrixFunction {
30  
31      /**
32       * Compute the value for the function.
33       * @param x the point for which the function value should be computed
34       * @return the value
35       * @exception MathIllegalArgumentException if {@code x} does not
36       * satisfy the function's constraints (argument out of bound, or unsupported
37       * derivative order for example)
38       */
39      DerivativeStructure[][] value(DerivativeStructure x) throws MathIllegalArgumentException;
40  
41  }