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