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.math4.legacy.fitting.leastsquares;
18  
19  import org.apache.commons.math4.legacy.linear.RealMatrix;
20  import org.apache.commons.math4.legacy.linear.RealVector;
21  
22  /**
23   * A interface for functions that compute a vector of values and can compute their
24   * derivatives (Jacobian).
25   *
26   * @since 3.4
27   */
28  public interface ValueAndJacobianFunction extends MultivariateJacobianFunction {
29      /**
30       * Compute the value.
31       *
32       * @param params Point.
33       * @return the value at the given point.
34       */
35      RealVector computeValue(double[] params);
36  
37      /**
38       * Compute the Jacobian.
39       *
40       * @param params Point.
41       * @return the Jacobian at the given point.
42       */
43      RealMatrix computeJacobian(double[] params);
44  }