    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     */
    017    package org.apache.commons.math3.optim.nonlinear.vector;
    018
    019    import org.apache.commons.math3.analysis.MultivariateVectorFunction;
    020    import org.apache.commons.math3.optim.OptimizationData;
    021
    022    /**
    023     * Model (vector) function to be optimized.
    024     *
    025     * @version $Id$
    026     * @since 3.1
    027     */
    028    public class ModelFunction implements OptimizationData {
    029        /** Function to be optimized. */
    030        private final MultivariateVectorFunction model;
    031
    032        /**
    033         * @param m Model function to be optimized.
    034         */
    035        public ModelFunction(MultivariateVectorFunction m) {
    036            model = m;
    037        }
    038
    039        /**
    040         * Gets the model function to be optimized.
    041         *
    042         * @return the model function.
    043         */
    044        public MultivariateVectorFunction getModelFunction() {
    045            return model;
    046        }
    047    }