View Javadoc
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  
18  package org.apache.commons.math4.legacy.optim;
19  
20  /**
21   * Starting point (first guess) of the optimization procedure.
22   * <br>
23   * Immutable class.
24   *
25   * @since 3.1
26   */
27  public class InitialGuess implements OptimizationData {
28      /** Initial guess. */
29      private final double[] init;
30  
31      /**
32       * @param startPoint Initial guess.
33       */
34      public InitialGuess(double[] startPoint) {
35          init = startPoint.clone();
36      }
37  
38      /**
39       * Gets the initial guess.
40       *
41       * @return the initial guess.
42       */
43      public double[] getInitialGuess() {
44          return init.clone();
45      }
46  }