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   * @deprecated As of 3.1 (to be removed in 4.0).
28   * @since 3.0
29   */
30  @Deprecated
31  public class UnivariatePointValuePair implements Serializable {
32      /** Serializable version identifier. */
33      private static final long serialVersionUID = 1003888396256744753L;
34      /** Point. */
35      private final double point;
36      /** Value of the objective function at the point. */
37      private final double value;
38  
39      /**
40       * Build a point/objective function value pair.
41       *
42       * @param point Point.
43       * @param value Value of an objective function at the point
44       */
45      public UnivariatePointValuePair(final double point,
46                                      final double value) {
47          this.point = point;
48          this.value = value;
49      }
50  
51      /**
52       * Get the point.
53       *
54       * @return the point.
55       */
56      public double getPoint() {
57          return point;
58      }
59  
60      /**
61       * Get the value of the objective function.
62       *
63       * @return the stored value of the objective function.
64       */
65      public double getValue() {
66          return value;
67      }
68  }