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
|
/*
* 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.
*/
@file:OptIn(InternalUse::class)
package org.opendc.common.units
import kotlinx.serialization.Serializable
import org.opendc.common.annotations.InternalUse
import org.opendc.common.utils.ifNeg0thenPos0
import java.time.Duration
import java.time.Instant
import kotlin.text.RegexOption.IGNORE_CASE
/**
* Represents time values.
* @see[Unit]
*/
@JvmInline
@Serializable(with = Time.Companion.TimeSerializer::class)
public value class Time private constructor(
// In milliseconds.
public override val value: Double,
) : Unit<Time> {
@InternalUse
override fun new(value: Double): Time = Time(value.ifNeg0thenPos0())
public fun toNs(): Double = value * 1e6
public fun toMicros(): Double = value * 1e3
public fun toMs(): Double = value
public fun toMsLong(): Long = value.toLong()
public fun toSec(): Double = value / 1000.0
public fun toMin(): Double = toSec() / 60
public fun toHours(): Double = toMin() / 60
public fun toInstantFromEpoch(): Instant = Instant.ofEpochMilli(value.toLong())
override fun toString(): String = fmtValue()
/**
* @return the [Duration] [toString] result of this time value.
*/
override fun fmtValue(fmt: String): String = Duration.ofMillis(value.toLong()).toString()
public operator fun times(power: Power): Energy = Energy.ofWh(toHours() * power.toWatts())
public operator fun times(dataRate: DataRate): DataSize = DataSize.ofKB(toSec() * dataRate.toKBps())
public companion object {
@JvmStatic public val ZERO: Time = Time(.0)
@JvmStatic
@JvmName("ofNanos")
public fun ofNanos(nanos: Number): Time = Time(nanos.toDouble() / 1e6)
@JvmStatic
@JvmName("ofMicros")
public fun ofMicros(micros: Number): Time = Time(micros.toDouble() / 1e3)
@JvmStatic
@JvmName("ofMillis")
public fun ofMillis(ms: Number): Time = Time(ms.toDouble())
@JvmStatic
@JvmName("ofSec")
public fun ofSec(sec: Number): Time = Time(sec.toDouble() * 1000.0)
@JvmStatic
@JvmName("ofMin")
public fun ofMin(min: Number): Time = Time(min.toDouble() * 60 * 1000.0)
@JvmStatic
@JvmName("ofHours")
public fun ofHours(hours: Number): Time = Time(hours.toDouble() * 60 * 60 * 1000.0)
@JvmStatic
@JvmName("ofDuration")
public fun ofDuration(duration: Duration): Time = duration.toTime()
@JvmStatic
@JvmName("ofInstantFromEpoch")
public fun ofInstantFromEpoch(instant: Instant): Time = ofMillis(instant.toEpochMilli())
/**
* Serializer for [Time] value class. It needs to be a compile
* time constant in order to be used as serializer automatically,
* hence `object :` instead of class instantiation.
*
* ```json
* // e.g.
* "time": "10 hours"
* "time": " 30 minutes "
* "time": "1 ms"
* "time": "PT13H"
* // etc.
* ```
*/
internal object TimeSerializer : UnitSerializer<Time>(
ifNumber = {
LOG.warn(
"deserialization of number with no unit of measure, assuming it is in milliseconds." +
"Keep in mind that you can also specify the value as '$it ms'",
)
ofMillis(it.toDouble())
},
serializerFun = { this.encodeString(it.toString()) },
ifMatches("$NUM_GROUP$NANO$SEC(?:|s)\\s*", IGNORE_CASE) { ofNanos(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$MICRO$SEC(?:|s)\\s*", IGNORE_CASE) { ofMicros(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$MILLI$SEC(?:|s)\\s*", IGNORE_CASE) { ofMillis(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$SEC(?:|s)\\s*", IGNORE_CASE) { ofSec(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$MIN(?:|s)\\s*") { ofMin(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$HOUR(?:|s)\\s*") { ofHours(json.decNumFromStr(groupValues[1])) },
ifNoExc { ofDuration(Duration.parse(this)) },
ifNoExc { ofInstantFromEpoch(Instant.parse(this)) },
)
/**
* @return [this] converted to a [Time] value, with the highest possible accuracy.
*
* @throws RuntimeException if [this] cannot be represented as nanos, millis, seconds, minutes or hours with a [Long].
*/
public fun Duration.toTime(): Time {
fun tryNoThrow(block: () -> Time?) =
try {
block()
} catch (_: Exception) {
null
}
return tryNoThrow { ofNanos(this.toNanos()) }
?: tryNoThrow { ofMillis(this.toMillis()) }
?: tryNoThrow { ofSec(this.toSeconds()) }
?: tryNoThrow { ofMin(this.toMinutes()) }
?: tryNoThrow { ofHours(this.toHours()) }
?: throw RuntimeException(
"duration $this cannot be converted to ${Time::class.simpleName}, " +
"duration value overflow Long representation of nanos, millis, seconds, minutes and hours",
)
}
}
}
|
