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
|
/*
* 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.units.Time.Companion.toTime
import org.opendc.common.utils.fmt
import org.opendc.common.utils.ifNeg0thenPos0
import java.time.Duration
import kotlin.text.RegexOption.IGNORE_CASE
/**
* Represents frequency values.
* @see[Unit]
*/
@JvmInline
@Serializable(with = Frequency.Companion.FrequencySerializer::class)
public value class Frequency private constructor(
// As MHz.
override val value: Double,
) : Unit<Frequency> {
override fun new(value: Double): Frequency = Frequency(value.ifNeg0thenPos0().also { check(it >= .0) })
public fun toHz(): Double = value * 1e6
public fun toKHz(): Double = value * 1e3
public fun toMHz(): Double = value
public fun toGHz(): Double = value / 1e3
override fun toString(): String = fmtValue()
override fun fmtValue(fmt: String): String =
when (abs()) {
in ZERO..ofHz(500) -> "${toHz().fmt(fmt)} Hz"
in ofHz(500)..ofKHz(500) -> "${toKHz().fmt(fmt)} KHz"
in ofKHz(500)..ofMHz(500) -> "${toMHz().fmt(fmt)} MHz"
else -> "${toGHz().fmt(fmt)} GHz"
}
public operator fun times(time: Time): Double = toHz() * time.toSec()
public operator fun times(duration: Duration): Double = toHz() * duration.toTime().toSec()
public companion object {
@JvmStatic public val ZERO: Frequency = Frequency(.0)
@JvmStatic
@JvmName("ofHz")
public fun ofHz(hz: Number): Frequency = ofMHz(hz.toDouble() / 1e6)
@JvmStatic
@JvmName("ofKHz")
public fun ofKHz(kHz: Number): Frequency = ofMHz(kHz.toDouble() / 1e3)
@JvmStatic
@JvmName("ofMHz")
public fun ofMHz(mHz: Number): Frequency = Frequency(mHz.toDouble())
@JvmStatic
@JvmName("ofGHz")
public fun ofGHz(gHz: Number): Frequency = ofMHz(gHz.toDouble() * 1e3)
private val HERTZ = Regex("\\s*(?:Hz|Hertz|hz|hertz)\\s*?")
/**
* Serializer for [Frequency] 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.
* "frequency": "1000 Hz"
* "frequency": " 10 GHz "
* "frequency": "2megahertz"
* // etc.
* ```
*/
internal object FrequencySerializer : UnitSerializer<Frequency>(
ifNumber = {
LOG.warn("deserialization of number with no unit of measure, assuming it is in MHz...")
ofMHz(it.toDouble())
},
serializerFun = { this.encodeString(it.toString()) },
ifMatches("$NUM_GROUP$HERTZ", IGNORE_CASE) { ofHz(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$KILO$HERTZ", IGNORE_CASE) { ofKHz(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$MEGA$HERTZ", IGNORE_CASE) { ofMHz(json.decNumFromStr(groupValues[1])) },
ifMatches("$NUM_GROUP$GIGA$HERTZ", IGNORE_CASE) { ofGHz(json.decNumFromStr(groupValues[1])) },
)
}
}
|
