1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.optimization;
import org.apache.commons.math3.util.Pair;
import java.io.Serializable;
/**
* This class holds a point and the value of an objective function at that point.
*
* @see PointVectorValuePair
* @see org.apache.commons.math3.analysis.MultivariateFunction
* @deprecated As of 3.1 (to be removed in 4.0).
* @since 3.0
*/
@Deprecated
public class PointValuePair extends Pair<double[], Double> implements Serializable {
/** Serializable UID. */
private static final long serialVersionUID = 20120513L;
/**
* Builds a point/objective function value pair.
*
* @param point Point coordinates. This instance will store a copy of the array, not the array
* passed as argument.
* @param value Value of the objective function at the point.
*/
public PointValuePair(final double[] point, final double value) {
this(point, value, true);
}
/**
* Builds a point/objective function value pair.
*
* @param point Point coordinates.
* @param value Value of the objective function at the point.
* @param copyArray if {@code true}, the input array will be copied, otherwise it will be
* referenced.
*/
public PointValuePair(final double[] point, final double value, final boolean copyArray) {
super(copyArray ? ((point == null) ? null : point.clone()) : point, value);
}
/**
* Gets the point.
*
* @return a copy of the stored point.
*/
public double[] getPoint() {
final double[] p = getKey();
return p == null ? null : p.clone();
}
/**
* Gets a reference to the point.
*
* @return a reference to the internal array storing the point.
*/
public double[] getPointRef() {
return getKey();
}
/**
* Replace the instance with a data transfer object for serialization.
*
* @return data transfer object that will be serialized
*/
private Object writeReplace() {
return new DataTransferObject(getKey(), getValue());
}
/** Internal class used only for serialization. */
private static class DataTransferObject implements Serializable {
/** Serializable UID. */
private static final long serialVersionUID = 20120513L;
/** Point coordinates. @Serial */
private final double[] point;
/** Value of the objective function at the point. @Serial */
private final double value;
/**
* Simple constructor.
*
* @param point Point coordinates.
* @param value Value of the objective function at the point.
*/
DataTransferObject(final double[] point, final double value) {
this.point = point.clone();
this.value = value;
}
/**
* Replace the deserialized data transfer object with a {@link PointValuePair}.
*
* @return replacement {@link PointValuePair}
*/
private Object readResolve() {
return new PointValuePair(point, value, false);
}
}
}
|
