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.univariate;
19
20 /**
21 * This class holds a point and the value of an objective function at this
22 * point.
23 * This is a simple immutable container.
24 *
25 * @since 3.0
26 */
27 public class UnivariatePointValuePair {
28 /** Point. */
29 private final double point;
30 /** Value of the objective function at the point. */
31 private final double value;
32
33 /**
34 * Build a point/objective function value pair.
35 *
36 * @param point Point.
37 * @param value Value of an objective function at the point
38 */
39 public UnivariatePointValuePair(final double point,
40 final double value) {
41 this.point = point;
42 this.value = value;
43 }
44
45 /**
46 * Get the point.
47 *
48 * @return the point.
49 */
50 public double getPoint() {
51 return point;
52 }
53
54 /**
55 * Get the value of the objective function.
56 *
57 * @return the stored value of the objective function.
58 */
59 public double getValue() {
60 return value;
61 }
62 }