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.math3.optimization.univariate;
19  
20  import java.io.Serializable;
21  
22  /**
23   * This class holds a point and the value of an objective function at this
24   * point.
25   * This is a simple immutable container.
26   *
27   * @version $Id: UnivariatePointValuePair.java 1422230 2012-12-15 12:11:13Z erans $
28   * @deprecated As of 3.1 (to be removed in 4.0).
29   * @since 3.0
30   */
31  @Deprecated
32  public class UnivariatePointValuePair implements Serializable {
33      /** Serializable version identifier. */
34      private static final long serialVersionUID = 1003888396256744753L;
35      /** Point. */
36      private final double point;
37      /** Value of the objective function at the point. */
38      private final double value;
39  
40      /**
41       * Build a point/objective function value pair.
42       *
43       * @param point Point.
44       * @param value Value of an objective function at the point
45       */
46      public UnivariatePointValuePair(final double point,
47                                      final double value) {
48          this.point = point;
49          this.value = value;
50      }
51  
52      /**
53       * Get the point.
54       *
55       * @return the point.
56       */
57      public double getPoint() {
58          return point;
59      }
60  
61      /**
62       * Get the value of the objective function.
63       *
64       * @return the stored value of the objective function.
65       */
66      public double getValue() {
67          return value;
68      }
69  }