blob: 98248ceec1efa4c1408d6a075eea70b2ada35e5b (
plain)
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
|
/*
* 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.Precision;
/**
* Base class for all convergence checker implementations.
*
* @param <PAIR> Type of (point, value) pair.
* @deprecated As of 3.1 (to be removed in 4.0).
* @since 3.0
*/
@Deprecated
public abstract class AbstractConvergenceChecker<PAIR> implements ConvergenceChecker<PAIR> {
/**
* Default relative threshold.
*
* @deprecated in 3.1 (to be removed in 4.0) because this value is too small to be useful as a
* default (cf. MATH-798).
*/
@Deprecated private static final double DEFAULT_RELATIVE_THRESHOLD = 100 * Precision.EPSILON;
/**
* Default absolute threshold.
*
* @deprecated in 3.1 (to be removed in 4.0) because this value is too small to be useful as a
* default (cf. MATH-798).
*/
@Deprecated private static final double DEFAULT_ABSOLUTE_THRESHOLD = 100 * Precision.SAFE_MIN;
/** Relative tolerance threshold. */
private final double relativeThreshold;
/** Absolute tolerance threshold. */
private final double absoluteThreshold;
/**
* Build an instance with default thresholds.
*
* @deprecated in 3.1 (to be removed in 4.0). Convergence thresholds are problem-dependent. As
* this class is intended for users who want to set their own convergence criterion instead
* of relying on an algorithm's default procedure, they should also set the thresholds
* appropriately (cf. MATH-798).
*/
@Deprecated
public AbstractConvergenceChecker() {
this.relativeThreshold = DEFAULT_RELATIVE_THRESHOLD;
this.absoluteThreshold = DEFAULT_ABSOLUTE_THRESHOLD;
}
/**
* Build an instance with a specified thresholds.
*
* @param relativeThreshold relative tolerance threshold
* @param absoluteThreshold absolute tolerance threshold
*/
public AbstractConvergenceChecker(
final double relativeThreshold, final double absoluteThreshold) {
this.relativeThreshold = relativeThreshold;
this.absoluteThreshold = absoluteThreshold;
}
/**
* @return the relative threshold.
*/
public double getRelativeThreshold() {
return relativeThreshold;
}
/**
* @return the absolute threshold.
*/
public double getAbsoluteThreshold() {
return absoluteThreshold;
}
/** {@inheritDoc} */
public abstract boolean converged(int iteration, PAIR previous, PAIR current);
}
|
