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    
018    package org.apache.commons.math3.optim;
019    
020    /**
021     * Starting point (first guess) of the optimization procedure.
022     * <br/>
023     * Immutable class.
024     *
025     * @version $Id: InitialGuess.java 1416643 2012-12-03 19:37:14Z tn $
026     * @since 3.1
027     */
028    public class InitialGuess implements OptimizationData {
029        /** Initial guess. */
030        private final double[] init;
031    
032        /**
033         * @param startPoint Initial guess.
034         */
035        public InitialGuess(double[] startPoint) {
036            init = startPoint.clone();
037        }
038    
039        /**
040         * Gets the initial guess.
041         *
042         * @return the initial guess.
043         */
044        public double[] getInitialGuess() {
045            return init.clone();
046        }
047    }