InitialGuess.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  17. package org.apache.commons.math3.optimization;

  18. /**
  19.  * Starting point (first guess) of the optimization procedure.
  20.  * <br/>
  21.  * Immutable class.
  22.  *
  23.  * @deprecated As of 3.1 (to be removed in 4.0).
  24.  * @since 3.1
  25.  */
  26. @Deprecated
  27. public class InitialGuess implements OptimizationData {
  28.     /** Initial guess. */
  29.     private final double[] init;

  30.     /**
  31.      * @param startPoint Initial guess.
  32.      */
  33.     public InitialGuess(double[] startPoint) {
  34.         init = startPoint.clone();
  35.     }

  36.     /**
  37.      * Gets the initial guess.
  38.      *
  39.      * @return the initial guess.
  40.      */
  41.     public double[] getInitialGuess() {
  42.         return init.clone();
  43.     }
  44. }