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  
18  package org.apache.commons.math3.analysis.differentiation;
19  
20  import org.apache.commons.math3.analysis.MultivariateVectorFunction;
21  import org.apache.commons.math3.exception.MathIllegalArgumentException;
22  
23  
24  /**
25   * Extension of {@link MultivariateVectorFunction} representing a
26   * multivariate differentiable vectorial function.
27   * @since 3.1
28   */
29  public interface MultivariateDifferentiableVectorFunction
30      extends MultivariateVectorFunction {
31  
32      /**
33       * Compute the value for the function at the given point.
34       * @param point point at which the function must be evaluated
35       * @return function value for the given point
36       * @exception MathIllegalArgumentException if {@code point} does not
37       * satisfy the function's constraints (wrong dimension, argument out of bound,
38       * or unsupported derivative order for example)
39       */
40      DerivativeStructure[] value(DerivativeStructure[] point)
41          throws MathIllegalArgumentException;
42  
43  }