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