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    *      https://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  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  
23  package org.hipparchus.optim.univariate;
24  
25  import java.io.Serializable;
26  
27  /**
28   * This class holds a point and the value of an objective function at this
29   * point.
30   * This is a simple immutable container.
31   *
32   */
33  public class UnivariatePointValuePair implements Serializable {
34      /** Serializable version identifier. */
35      private static final long serialVersionUID = 1003888396256744753L;
36      /** Point. */
37      private final double point;
38      /** Value of the objective function at the point. */
39      private final double value;
40  
41      /**
42       * Build a point/objective function value pair.
43       *
44       * @param point Point.
45       * @param value Value of an objective function at the point
46       */
47      public UnivariatePointValuePair(final double point,
48                                      final double value) {
49          this.point = point;
50          this.value = value;
51      }
52  
53      /**
54       * Get the point.
55       *
56       * @return the point.
57       */
58      public double getPoint() {
59          return point;
60      }
61  
62      /**
63       * Get the value of the objective function.
64       *
65       * @return the stored value of the objective function.
66       */
67      public double getValue() {
68          return value;
69      }
70  }