ObjectiveFunctionGradient.java

  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.optim.nonlinear.scalar;

  18. import org.apache.commons.math4.legacy.analysis.MultivariateVectorFunction;
  19. import org.apache.commons.math4.legacy.optim.OptimizationData;

  20. /**
  21.  * Gradient of the scalar function to be optimized.
  22.  *
  23.  * @since 3.1
  24.  */
  25. public class ObjectiveFunctionGradient implements OptimizationData {
  26.     /** Function to be optimized. */
  27.     private final MultivariateVectorFunction gradient;

  28.     /**
  29.      * @param g Gradient of the function to be optimized.
  30.      */
  31.     public ObjectiveFunctionGradient(MultivariateVectorFunction g) {
  32.         gradient = g;
  33.     }

  34.     /**
  35.      * Gets the gradient of the function to be optimized.
  36.      *
  37.      * @return the objective function gradient.
  38.      */
  39.     public MultivariateVectorFunction getObjectiveFunctionGradient() {
  40.         return gradient;
  41.     }
  42. }