001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math4.optim.nonlinear.scalar;
018
019import org.apache.commons.math4.analysis.MultivariateVectorFunction;
020import org.apache.commons.math4.optim.OptimizationData;
021
022/**
023 * Gradient of the scalar function to be optimized.
024 *
025 * @since 3.1
026 */
027public class ObjectiveFunctionGradient implements OptimizationData {
028    /** Function to be optimized. */
029    private final MultivariateVectorFunction gradient;
030
031    /**
032     * @param g Gradient of the function to be optimized.
033     */
034    public ObjectiveFunctionGradient(MultivariateVectorFunction g) {
035        gradient = g;
036    }
037
038    /**
039     * Gets the gradient of the function to be optimized.
040     *
041     * @return the objective function gradient.
042     */
043    public MultivariateVectorFunction getObjectiveFunctionGradient() {
044        return gradient;
045    }
046}