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.scalar;
23
24 import org.hipparchus.analysis.MultivariateVectorFunction;
25 import org.hipparchus.optim.OptimizationData;
26
27 /**
28 * Gradient of the scalar function to be optimized.
29 *
30 */
31 public class ObjectiveFunctionGradient implements OptimizationData {
32 /** Function to be optimized. */
33 private final MultivariateVectorFunction gradient;
34
35 /** Simple constructor.
36 * @param g Gradient of the function to be optimized.
37 */
38 public ObjectiveFunctionGradient(MultivariateVectorFunction g) {
39 gradient = g;
40 }
41
42 /**
43 * Gets the gradient of the function to be optimized.
44 *
45 * @return the objective function gradient.
46 */
47 public MultivariateVectorFunction getObjectiveFunctionGradient() {
48 return gradient;
49 }
50 }