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
018package org.apache.commons.math3.optimization;
019
020/**
021 * Starting point (first guess) of the optimization procedure.
022 * <br/>
023 * Immutable class.
024 *
025 * @deprecated As of 3.1 (to be removed in 4.0).
026 * @since 3.1
027 */
028@Deprecated
029public class InitialGuess implements OptimizationData {
030    /** Initial guess. */
031    private final double[] init;
032
033    /**
034     * @param startPoint Initial guess.
035     */
036    public InitialGuess(double[] startPoint) {
037        init = startPoint.clone();
038    }
039
040    /**
041     * Gets the initial guess.
042     *
043     * @return the initial guess.
044     */
045    public double[] getInitialGuess() {
046        return init.clone();
047    }
048}