/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.optim.nonlinear.vector;
import org.apache.commons.math3.analysis.MultivariateMatrixFunction;
import org.apache.commons.math3.optim.OptimizationData;
Jacobian of the model (vector) function to be optimized.
Since: 3.1 Deprecated: All classes and interfaces in this package are deprecated. The optimizers that were provided here were moved to the leastsquares
package (cf. MATH-1008).
/**
* Jacobian of the model (vector) function to be optimized.
*
* @since 3.1
* @deprecated All classes and interfaces in this package are deprecated.
* The optimizers that were provided here were moved to the
* {@link org.apache.commons.math3.fitting.leastsquares} package
* (cf. MATH-1008).
*/
@Deprecated
public class ModelFunctionJacobian implements OptimizationData {
Function to be optimized. /** Function to be optimized. */
private final MultivariateMatrixFunction jacobian;
Params: - j – Jacobian of the model function to be optimized.
/**
* @param j Jacobian of the model function to be optimized.
*/
public ModelFunctionJacobian(MultivariateMatrixFunction j) {
jacobian = j;
}
Gets the Jacobian of the model function to be optimized.
Returns: the model function Jacobian.
/**
* Gets the Jacobian of the model function to be optimized.
*
* @return the model function Jacobian.
*/
public MultivariateMatrixFunction getModelFunctionJacobian() {
return jacobian;
}
}