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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/*
* Copyright (c) 2024 AtLarge Research
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.opendc.common.utils
import org.slf4j.Logger
import kotlin.math.abs
/**
* When comparing 2 doubles, `==` can produce wrong results. The threshold comparison method check that
* the difference between both numbers is within a specified tolerance, commonly called epsilon.
* In this case we use adaptive epsilons, meaning the epsilon is adjusted proportionally to
* the values that are being compared.
*
* This value represents the default epsilon multiplier used if an epsilon is not provided.
*/
internal const val DFLT_EPS_MULTIPLIER: Double = 1e-05
internal const val DFLT_MIN_EPS: Double = 1.0e-06
/**
* Compares [this] with [other] using threshold comparison method with epsilon = [epsilon].
*
* @param[minEpsilon] the minimum epsilon that can be computed when [epsilon] is not provided.
* If [epsilon] is provided, this param has no effect.
* @param[epsilon] represent the tolerance of the comparison.
* If not provided an adaptive epsilon is computed (based on the largest value in the comparison).
* @return `true` if [this] is considered equal to [other], `false` otherwise.
*/
@JvmOverloads
public fun Double.approx(
other: Double,
minEpsilon: Double = DFLT_MIN_EPS,
epsilon: Double = adaptiveEps(this, other, minEpsilon),
): Boolean = this == other || abs(this - other) <= epsilon
/**
* Infix version of [approx].
* @see[approx]
*/
@JvmSynthetic
@JvmName("approx, jvm name to avoid same jvm signature (not invokable from java)")
public infix fun Double.approx(other: Double): Boolean = approx(other, epsilon = DFLT_EPS_MULTIPLIER)
/**
* @return [this] approximated to [to] if within `[to] - epsilon` and `[to] + epsilon`.
*/
@JvmOverloads
public fun Double.roundToIfWithinEpsilon(
to: Double,
epsilon: Double = DFLT_MIN_EPS,
): Double =
if (this in (to - epsilon)..(to + epsilon)) {
to
} else {
this
}
/**
* Compares [this] with [other] using threshold comparison method with epsilon = [epsilon].
*
* @param[minEpsilon] the minimum epsilon that can be computed when [epsilon] is not provided.
* If [epsilon] is provided, this param has no effect.
* @param[epsilon] represent the tolerance of the comparison.
* If not provided an adaptive epsilon is computed (based on the largest value in the comparison).
* @return `true` if [this] is considered larger than [other], `false` otherwise.
*/
@JvmOverloads
public fun Double.approxLarger(
other: Double,
minEpsilon: Double = DFLT_MIN_EPS,
epsilon: Double = adaptiveEps(this, other, minEpsilon),
): Boolean = (this - other) > epsilon
/**
* Infix version of [approxLarger].
* @see[approxLarger]
*/
@JvmSynthetic
@JvmName("approxLarger, jvm name to avoid same jvm signature (not invokable from java)")
public infix fun Double.approxLarger(other: Double): Boolean = this.approxLarger(other, epsilon = DFLT_EPS_MULTIPLIER)
/**
* Compares [this] with [other] using threshold comparison method with epsilon = [epsilon].
*
* @param[minEpsilon] the minimum epsilon that can be computed when [epsilon] is not provided.
* If [epsilon] is provided, this param has no effect.
* @param[epsilon] represent the tolerance of the comparison.
* If not provided an adaptive epsilon is computed (based on the largest value in the comparison).
* @return `true` if [this] is considered larger or equal than [other], `false` otherwise.
*/
@JvmOverloads
public fun Double.approxLargerOrEq(
other: Double,
minEpsilon: Double = DFLT_MIN_EPS,
epsilon: Double = adaptiveEps(this, other, minEpsilon),
): Boolean = (this - other) > -epsilon
/**
* Infix version of [approxLargerOrEq].
* @see[approxLargerOrEq]
*/
@JvmSynthetic
@JvmName("approxLargerOrEq, jvm name to avoid same jvm signature (not invokable from java)")
public infix fun Double.approxLargerOrEq(other: Double): Boolean = this.approxLargerOrEq(other, epsilon = DFLT_EPS_MULTIPLIER)
/**
* Compares [this] with [other] using threshold comparison method with epsilon = [epsilon].
*
* @param[minEpsilon] the minimum epsilon that can be computed when [epsilon] is not provided.
* If [epsilon] is provided, this param has no effect.
* @param[epsilon] represent the tolerance of the comparison.
* If not provided an adaptive epsilon is computed (based on the largest value in the comparison).
* @return `true` if [this] is considered smaller than [other], `false` otherwise.
*/
@JvmOverloads
public fun Double.approxSmaller(
other: Double,
minEpsilon: Double = DFLT_MIN_EPS,
epsilon: Double = adaptiveEps(this, other, minEpsilon),
): Boolean = (this - other) < -epsilon
/**
* Infix version of [approxLarger].
* @see[approxLarger]
*/
@JvmSynthetic
@JvmName("approxSmaller, jvm name to avoid same jvm signature (not invokable from java)")
public infix fun Double.approxSmaller(other: Double): Boolean = this.approxLarger(other, epsilon = DFLT_EPS_MULTIPLIER)
/**
* Compares [this] with [other] using threshold comparison method with epsilon = [epsilon].
*
* @param[minEpsilon] the minimum epsilon that can be computed when [epsilon] is not provided.
* If [epsilon] is provided, this param has no effect.
* @param[epsilon] represent the tolerance of the comparison.
* If not provided an adaptive epsilon is computed (based on the largest value in the comparison).
* @return `true` if [this] is considered smaller or equal than [other], `false` otherwise.
*/
@JvmOverloads
public fun Double.approxSmallerOrEq(
other: Double,
minEpsilon: Double = DFLT_MIN_EPS,
epsilon: Double = adaptiveEps(this, other, minEpsilon),
): Boolean = this - other < epsilon
/**
* Infix version of [approxSmallerOrEq].
* @see[approxSmallerOrEq]
*/
@JvmSynthetic
@JvmName("approxSmallerOrEq, jvm name to avoid same jvm signature (not invokable from java)")
public infix fun Double.approxSmallerOrEq(other: Double): Boolean = approxSmallerOrEq(other, DFLT_EPS_MULTIPLIER)
/**
* @return the result of [block] if [this] is NaN, [this] otherwise.
*/
public inline infix fun Double.ifNaN(block: () -> Double): Double =
if (this.isNaN()) {
block()
} else {
this
}
/**
* @return [replacement] if [this] is NaN, [this] otherwise.
*/
public infix fun Double.ifNaN(replacement: Double): Double =
if (this.isNaN()) {
replacement
} else {
this
}
/**
* @return adaptive epsilon computed proportionally to the max absolute value of [a] and [b]
*/
internal fun adaptiveEps(
a: Double,
b: Double,
minEpsilon: Double = DFLT_MIN_EPS,
): Double = DFLT_EPS_MULTIPLIER * maxOf(minEpsilon, abs(a), abs(b))
/**
* ```kotlin
* // replace
* String.format("%.3f", doubleValue)
* // with
* doubleValue.fmt("%.3f")
* ```
*
* @return [this] formatted by [fmt].
*/
public fun Double.fmt(fmt: String): String = String.format(fmt, this)
/**
* If [this] is a `-.0` [Double], it converts it to a `+.0` one.
* Useful for comparisons, since `-.0 >= +.0` is `false`.
* @param[warnLogger] the [Logger] to use to log the warning msg if any.
*/
public fun Double.ifNeg0thenPos0(warnLogger: Logger? = null): Double =
if (this == -.0) {
warnLogger?.warn("negative 0 floating point converted to positive 0")
.0
} else {
this
}
|
