monotonic.rb 0.8.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG +35 -0
- data/README.md +64 -9
- data/lib/Monotonic/Measurement.rb +176 -0
- data/lib/Monotonic/Timer.rb +40 -1
- data/lib/Monotonic/VERSION.rb +1 -1
- data/monotonic.rb.gemspec +1 -0
- data/test/Monotonic/Measurement_test.rb +179 -0
- data/test/Monotonic/Timer_test.rb +4 -4
- data/test/gemspec_test.rb +11 -1
- metadata +17 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 31e7ee27a90e0a41a51e5739b7024b16a2d7e10f71002bde23362bc90ccef9e5
|
|
4
|
+
data.tar.gz: 48b392a44f8d69bfe6ce2ecaee02b99d47645a148317c97c304188b0584ba3d8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 32e4581c05f382de37da5794488759f1c7206a54f79f1ad593d1809b9a53dde4407a17e4d3ab4eab8b4eaeaa18caea85dfc4300ab219db1e3291bcacb79987a9
|
|
7
|
+
data.tar.gz: 308211ccff21283d9ff5a851396ff660df6f605d3ffe607176c26c53075bfc930f3bbfacc5edfee758f11b6e702d7c5bf46de88e3b3193aa3636ef956dcd7664
|
data/CHANGELOG
CHANGED
|
@@ -1,5 +1,40 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## 20260817
|
|
4
|
+
|
|
5
|
+
0.10.0: + Monotonic::Measurement arithmetic, so that a speedup is a ratio which knows how well it is known.
|
|
6
|
+
|
|
7
|
+
1. + Monotonic::Measurement#+ and #-: two intervals give an interval, their doubts combining in quadrature through Measurand rather than by addition. A duration joins as exact, having none of its own, and a bare number is refused, having no unit to be added to.
|
|
8
|
+
2. + Monotonic::Measurement#*: scales by a number, the uncertainty scaling with it. Two intervals are refused, there being no unit of time squared, as Duration::Common refuses them.
|
|
9
|
+
3. + Monotonic::Measurement#/: by a number it stays an interval; by another interval the units cancel and a Measurand is left, dimensionless and carrying the doubt of both. That ratio is t1/tn, and the reason for the release: a speedup stated without knowing whether it is real is worth little.
|
|
10
|
+
4. + Monotonic::Measurement.from: builds from a measurand whose uncertainty has been propagated rather than measured, so that what comes back from arithmetic carries neither an instrument's floor nor a drift still to be applied a second time.
|
|
11
|
+
5. ~ monotonic.rb.gemspec: /measurand >= 0.1.0/measurand >= 0.1.2/. Measurand#/ divided two integer values as integers until 0.1.2, so a ratio of two nanosecond counts came back as 0 rather than 0.8788. #/ is the point of this release and does not work below 0.1.2, which the added tests demonstrate: they fail twice against 0.1.0 and pass against 0.1.2.
|
|
12
|
+
6. + test/Monotonic/Measurement_test.rb: each operator and what it refuses, and the ratio — that it is dimensionless, that it divides exactly, and that it carries the doubt of both operands.
|
|
13
|
+
7. + test/gemspec_test.rb: that each runtime dependency declares a minimum, and which minimum. The existing test asserted the names alone, which is what let 5 above happen: the gemspec named measurand and said nothing about needing a measurand that works. Asserting the whole map means a minimum cannot move without the test being made to agree.
|
|
14
|
+
8. ~ README.md: + the arithmetic to the Description, + a Monotonic::Measurement arithmetic section to Usage, and + a blank line after require in two examples, the other three having had one.
|
|
15
|
+
9. ~ Monotonic::VERSION: /0.9.0/0.10.0/
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## 20260816
|
|
19
|
+
|
|
20
|
+
0.9.0: Use measurand gem, + Monotonic::Measurement and Monotonic::Timer.floor.
|
|
21
|
+
|
|
22
|
+
1. + measurand as a dependency, constrained to >= 0.1.0 where Measurand#place became public. How well a figure is known is its business, and it was being hand-rolled here: combining an absolute floor with a relative drift by addition gave 109.49ns where the correct combination in quadrature gives 87.78ns, a quarter out.
|
|
23
|
+
2. + Monotonic::Timer.floor: what it costs to measure at all, in nanoseconds, measured by timing measurements of nothing and remembered. The clock's tick is not the limit, an interval wanting two readings and the taking of them taking time. A high percentile rather than a median, so that the ordinary case is covered and not merely the best one. It is a floor and not an error bar: the tail is unbounded and one-sided, the scheduler being free to take the processor away between the two readings, and no single measurement can detect that it did.
|
|
24
|
+
3. + Monotonic::Measurement: an elapsed interval together with what it is worth. #to_s shows only as many digits as the uncertainty reaches, the least significant place being settled by Measurand#place upon the Particle Data Group convention, so 1265625ns against a floor of 84ns prints as 1.26562ms and the same count measured coarsely prints as 1.27ms. The unit ladder is powers of a thousand and stops at seconds, the scheme being a decimal-places one and minutes being sexagesimal. Nothing is capped, a day resolved to a hundred nanoseconds printing every figure it has: the absurdity is the mismatch between instrument and question, and is better seen than rounded away.
|
|
25
|
+
4. + Monotonic::Measurement#uncertainty, #measurand, #unit_name, #decimals, #nanoseconds, #floor, #drift: every figure the rendering rests upon, so that a string can be walked back to the clock which produced it.
|
|
26
|
+
5. + Monotonic::Measurement#floor takes a number or anything answering to #call, and Monotonic::Timer hands over its .floor method rather than its value. Measuring the floor is a thousand null measurements, and a caller which only wants a number should not set them going: a timed block costs 0.008ms where it would cost 0.307ms, the floor being measured when doubt is first asked about.
|
|
27
|
+
6. + Monotonic::Measurement drift, optional and nil by default: the relative term, being the rate at which the clock's own oscillator wanders. It cannot be measured from within, weighing a clock wanting a better clock and this being the best one here, so it is supplied by a caller or not at all.
|
|
28
|
+
7. + Monotonic::Measurement#to_i and #to_f, both in nanoseconds, its own unit, as Duration::Minutes answers 5 rather than 300; #to_duration for every other unit; and #<=> with Comparable, against another measurement only, a bare number having no unit to compare against.
|
|
29
|
+
8. ~ BREAKING: Monotonic::Timer#time and .time return a Monotonic::Measurement rather than a Float of seconds. What comes back now says how much of itself is real, which a bare Float could not: 0.001295791 shows nine figures upon an instrument which resolves five. #total_time and #total_nanoseconds are unchanged for a number.
|
|
30
|
+
9. + Monotonic::Timer#measurement and #to_s.
|
|
31
|
+
10. + test/Monotonic/Measurement_test.rb: the unit chosen, the digits allowed, the uncertainty and that it combines in quadrature, the comparison, the conversions, the lazy floor, and that every figure the rendering rests upon is reachable.
|
|
32
|
+
11. + test/Monotonic/Timer_test.rb: the floor, and that a timed block returns a measurement which carries the interval and the floor.
|
|
33
|
+
12. ~ test/gemspec_test.rb: the runtime dependency list.
|
|
34
|
+
13. ~ README.md: + the floor and the measurement, and what a timed block now hands back.
|
|
35
|
+
14. ~ Monotonic::VERSION: /0.8.0/0.9.0/
|
|
36
|
+
|
|
37
|
+
|
|
3
38
|
## 20260816
|
|
4
39
|
|
|
5
40
|
0.8.0: Use duration.rb gem.
|
data/README.md
CHANGED
|
@@ -35,6 +35,31 @@ timer.total_nanoseconds
|
|
|
35
35
|
# => 2508000, upon a clock which ticks in whole microseconds
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
+
A timed block hands back a `Monotonic::Measurement` rather than a bare number, so that what comes back says how much of itself is real. `Monotonic::Timer.floor` is what it costs to measure at all, taken by timing measurements of nothing, and the measurement shows only as many digits as that floor reaches — the doubt itself being [measurand](https://github.com/thoran/measurand)'s business, which combines an absolute floor with a relative drift in quadrature rather than by addition.
|
|
39
|
+
|
|
40
|
+
```ruby
|
|
41
|
+
Monotonic::Timer.floor
|
|
42
|
+
# => 84
|
|
43
|
+
measurement = Monotonic::Timer.time{sleep 0.001}
|
|
44
|
+
measurement.to_s
|
|
45
|
+
# => "1.26562 ms"
|
|
46
|
+
measurement.uncertainty
|
|
47
|
+
# => 84.0
|
|
48
|
+
measurement.to_duration.to_microseconds.to_f
|
|
49
|
+
# => 1265.625
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Nothing is capped: a day resolved to a hundred nanoseconds prints every figure it has, the absurdity being the mismatch between what the instrument resolves and what was asked of it, which is better seen than rounded away. The floor is a floor and not an error bar — the tail is unbounded and one-sided, the scheduler being free to take the processor away between the two readings — so repeat and take a robust statistic where that matters.
|
|
53
|
+
|
|
54
|
+
Measurements combine, and what may combine with what follows from the units. Two intervals add and subtract to an interval, their doubts going in quadrature; a duration joins in as exact, having none of its own; a bare number is refused, having no unit to be added to. Scaling by a number keeps the unit and scales the doubt with it, while multiplying two intervals is refused, there being no unit of time squared. Dividing one interval by another cancels the units and leaves a `Measurand` — dimensionless, and still knowing how well it is known, which is what a speedup is.
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
serial = Monotonic::Timer.time{run_on_one}
|
|
58
|
+
parallel = Monotonic::Timer.time{run_on_eight}
|
|
59
|
+
serial / parallel
|
|
60
|
+
# => Measurand(6.83, 0.00012), dimensionless
|
|
61
|
+
```
|
|
62
|
+
|
|
38
63
|
|
|
39
64
|
## Installation
|
|
40
65
|
|
|
@@ -115,39 +140,69 @@ timer.total_time
|
|
|
115
140
|
```ruby
|
|
116
141
|
require 'monotonic.rb'
|
|
117
142
|
|
|
118
|
-
|
|
143
|
+
measurement = Monotonic::Timer.time do
|
|
119
144
|
i = 0
|
|
120
145
|
1_000_000.times{puts i += 1}
|
|
121
146
|
end
|
|
122
|
-
|
|
123
|
-
# => 6.
|
|
147
|
+
measurement.to_s
|
|
148
|
+
# => "6.97582 s"
|
|
124
149
|
```
|
|
125
150
|
|
|
126
151
|
### Monotonic::Timer with a block and block variable
|
|
127
152
|
|
|
128
153
|
```ruby
|
|
129
154
|
require 'monotonic.rb'
|
|
130
|
-
|
|
155
|
+
|
|
156
|
+
measurement = Monotonic::Timer.time do |timer|
|
|
131
157
|
i = 0
|
|
132
158
|
500_000.times{puts i += 1}
|
|
133
159
|
p timer.total_time
|
|
134
160
|
500_000.times{puts i += 1}
|
|
135
161
|
end
|
|
136
|
-
|
|
137
|
-
# => 6.
|
|
162
|
+
measurement.to_s
|
|
163
|
+
# => "6.97582 s"
|
|
138
164
|
```
|
|
139
165
|
|
|
140
166
|
### Monotonic::Timer with a block on a timer instance
|
|
141
167
|
|
|
142
168
|
```ruby
|
|
143
169
|
require 'monotonic.rb'
|
|
170
|
+
|
|
144
171
|
timer = Monotonic::Timer.new
|
|
145
|
-
|
|
172
|
+
measurement = timer.time do
|
|
146
173
|
i = 0
|
|
147
174
|
1_000_000.times{puts i += 1}
|
|
148
175
|
end
|
|
149
|
-
|
|
150
|
-
# => 7.
|
|
176
|
+
measurement.to_s
|
|
177
|
+
# => "7.03313 s"
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
### Monotonic::Measurement arithmetic
|
|
182
|
+
|
|
183
|
+
```ruby
|
|
184
|
+
require 'monotonic.rb'
|
|
185
|
+
|
|
186
|
+
a = Monotonic::Timer.time{sleep 0.001}
|
|
187
|
+
b = Monotonic::Timer.time{sleep 0.002}
|
|
188
|
+
|
|
189
|
+
(a + b).to_s
|
|
190
|
+
# => "3.01543 ms"
|
|
191
|
+
|
|
192
|
+
(a * 3).to_s
|
|
193
|
+
# => "3.04629 ms"
|
|
194
|
+
|
|
195
|
+
a + Duration::Microseconds.new(500)
|
|
196
|
+
# => #<Monotonic::Measurement 1.51543 ms>, a duration being exact
|
|
197
|
+
|
|
198
|
+
b / a
|
|
199
|
+
# => Measurand(1.97, 0.00011), dimensionless
|
|
200
|
+
|
|
201
|
+
a * b
|
|
202
|
+
# => TypeError: there is no unit of time squared
|
|
203
|
+
|
|
204
|
+
a + 5
|
|
205
|
+
# => TypeError: expected an interval or a duration
|
|
151
206
|
```
|
|
152
207
|
|
|
153
208
|
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# Monotonic/Measurement.rb
|
|
2
|
+
# Monotonic::Measurement
|
|
3
|
+
|
|
4
|
+
require 'duration.rb'
|
|
5
|
+
require 'measurand'
|
|
6
|
+
|
|
7
|
+
module Monotonic
|
|
8
|
+
# An elapsed interval together with what it is worth. The count alone says
|
|
9
|
+
# nothing of how much of itself is real, so #to_s shows only as many digits as
|
|
10
|
+
# the uncertainty supports. Nothing is capped: a day resolved to a hundred
|
|
11
|
+
# nanoseconds prints every figure it has, which looks absurd and is — the
|
|
12
|
+
# absurdity being the mismatch between what the instrument resolves and what
|
|
13
|
+
# was asked of it, and better seen than rounded away.
|
|
14
|
+
#
|
|
15
|
+
# The doubt is a Measurand's business and the unit is a Duration's; what is
|
|
16
|
+
# left here is the ladder between them and the string at the end of it.
|
|
17
|
+
class Measurement
|
|
18
|
+
include Comparable
|
|
19
|
+
|
|
20
|
+
# Powers of a thousand, and no further. The scheme is a decimal-places one,
|
|
21
|
+
# so minutes and hours have no place in it: 90s is plainer than 1.5min, and
|
|
22
|
+
# a run of a day reads as 86400s rather than reaching for a unit which does
|
|
23
|
+
# not divide by ten.
|
|
24
|
+
UNITS = [[1, 'ns'], [1_000, 'us'], [1_000_000, 'ms'], [1_000_000_000, 's']]
|
|
25
|
+
|
|
26
|
+
class << self
|
|
27
|
+
# Built from a measurand rather than from a floor, for what comes back
|
|
28
|
+
# from arithmetic: its uncertainty has been propagated rather than
|
|
29
|
+
# measured, so it is neither an instrument's floor nor has a drift left to
|
|
30
|
+
# apply a second time.
|
|
31
|
+
def from(measurand)
|
|
32
|
+
allocate.tap{|measurement| measurement.send(:build, measurand)}
|
|
33
|
+
end
|
|
34
|
+
end # class << self
|
|
35
|
+
|
|
36
|
+
attr_reader :nanoseconds
|
|
37
|
+
attr_reader :drift
|
|
38
|
+
|
|
39
|
+
# The floor may be given as a number or as anything which answers to #call,
|
|
40
|
+
# so that measuring it can wait until somebody asks about doubt.
|
|
41
|
+
# Monotonic::Timer hands over its .floor method rather than its value, and a
|
|
42
|
+
# caller which only wants a number never sets the thousand null measurements
|
|
43
|
+
# going.
|
|
44
|
+
def floor
|
|
45
|
+
@floor = @floor.respond_to?(:call) ? @floor.call : @floor
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# The floor is absolute and tells upon short intervals; drift is relative
|
|
49
|
+
# and tells upon long ones, being the rate at which the clock's own
|
|
50
|
+
# oscillator wanders. Combining them is not addition — they are independent,
|
|
51
|
+
# so they go in quadrature — which is why the arithmetic is Measurand's and
|
|
52
|
+
# not done here.
|
|
53
|
+
def measurand
|
|
54
|
+
@measurand ||= (
|
|
55
|
+
absolute = Measurand.new(@nanoseconds, floor)
|
|
56
|
+
@drift ? absolute * Measurand.relative(1, @drift) : absolute
|
|
57
|
+
)
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
def uncertainty
|
|
61
|
+
measurand.uncertainty
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# The arithmetic is Measurand's throughout — this only decides what may be
|
|
65
|
+
# combined with what, and hands back the right kind of thing. Two intervals
|
|
66
|
+
# add and subtract to an interval, their uncertainties going in quadrature.
|
|
67
|
+
def +(addend)
|
|
68
|
+
self.class.from(measurand + as_measurand(addend, :add))
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def -(subtrahend)
|
|
72
|
+
self.class.from(measurand - as_measurand(subtrahend, :subtract))
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Scaled by a number it stays an interval, the uncertainty scaling with it.
|
|
76
|
+
# Multiplied by another interval it would be time squared, which has no unit
|
|
77
|
+
# here, so it is refused as Duration::Common refuses it.
|
|
78
|
+
def *(multiplier)
|
|
79
|
+
if interval?(multiplier)
|
|
80
|
+
raise TypeError, "can't multiply #{self.class} by #{multiplier.class}: there is no unit of time squared"
|
|
81
|
+
end
|
|
82
|
+
self.class.from(measurand * multiplier)
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Divided by a number it stays an interval. Divided by another interval the
|
|
86
|
+
# units cancel and a Measurand is left — dimensionless, but still knowing how
|
|
87
|
+
# well it is known, which is what a speedup or a rate is.
|
|
88
|
+
def /(divisor)
|
|
89
|
+
return measurand / divisor.measurand if divisor.respond_to?(:measurand)
|
|
90
|
+
self.class.from(measurand / divisor)
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
def unit
|
|
94
|
+
@unit ||= UNITS.reverse.find{|scale, _| @nanoseconds.abs >= scale} || UNITS.first
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
def scale
|
|
98
|
+
unit.first
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
def unit_name
|
|
102
|
+
unit.last
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# The least significant digit worth showing is the one the uncertainty
|
|
106
|
+
# reaches, which Measurand settles by the Particle Data Group convention and
|
|
107
|
+
# reports as #place, a power of ten. Rendering in a coarser unit moves it
|
|
108
|
+
# along by however many tens that unit is worth. A measurand with no
|
|
109
|
+
# uncertainty has no last real digit, and answers nil.
|
|
110
|
+
def decimals
|
|
111
|
+
@decimals ||= (
|
|
112
|
+
place = measurand.place
|
|
113
|
+
place ? [Math.log10(scale) - place, 0].max.to_i : Math.log10(scale).to_i
|
|
114
|
+
)
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
def to_duration
|
|
118
|
+
Duration::Nanoseconds.new(@nanoseconds)
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Both answer in nanoseconds, this measurement's own unit, as
|
|
122
|
+
# Duration::Minutes answers 5 rather than 300. Every other unit comes from
|
|
123
|
+
# #to_duration, which names the one it is asked for. A number handed out
|
|
124
|
+
# without its unit stated must at least always mean the same thing.
|
|
125
|
+
def to_i
|
|
126
|
+
@nanoseconds
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
def to_f
|
|
130
|
+
@nanoseconds.to_f
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
def to_s
|
|
134
|
+
format("%.#{decimals}f #{unit_name}", @nanoseconds.to_f / scale)
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# Against another measurement only. A bare number has no unit, and comparing
|
|
138
|
+
# against one would have to assume which was meant, so nil is returned and ==
|
|
139
|
+
# is false, as Duration::Common does.
|
|
140
|
+
def <=>(other)
|
|
141
|
+
return nil unless other.is_a?(Monotonic::Measurement)
|
|
142
|
+
@nanoseconds <=> other.nanoseconds
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
def inspect
|
|
146
|
+
"#<#{self.class} #{self} (#{measurand} ns)>"
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
private
|
|
150
|
+
|
|
151
|
+
def initialize(nanoseconds, floor:, drift: nil)
|
|
152
|
+
@nanoseconds = nanoseconds
|
|
153
|
+
@floor = floor
|
|
154
|
+
@drift = drift
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# An interval is anything which knows its own doubt, or any duration, which
|
|
158
|
+
# is exact. A bare number is neither: it has no unit, so there is nothing to
|
|
159
|
+
# add it to.
|
|
160
|
+
def as_measurand(other, verb)
|
|
161
|
+
return other.measurand if other.respond_to?(:measurand)
|
|
162
|
+
return Measurand.new(other.to_nanoseconds.to_i) if other.respond_to?(:to_nanoseconds)
|
|
163
|
+
raise TypeError, "can't #{verb} #{other.class} #{verb == :add ? "to" : "from"} #{self.class}: expected an interval or a duration"
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
def interval?(other)
|
|
167
|
+
other.respond_to?(:measurand) || other.respond_to?(:to_nanoseconds)
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
def build(measurand)
|
|
171
|
+
@nanoseconds = measurand.value.round
|
|
172
|
+
@measurand = measurand
|
|
173
|
+
@floor = measurand.uncertainty
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
data/lib/Monotonic/Timer.rb
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
# Monotonic::Timer
|
|
3
3
|
|
|
4
4
|
require 'duration.rb'
|
|
5
|
+
require_relative './Measurement'
|
|
5
6
|
|
|
6
7
|
module Monotonic
|
|
7
8
|
class Timer
|
|
@@ -20,6 +21,10 @@ module Monotonic
|
|
|
20
21
|
# rigidity: a method call would be a measurable part of what it measures.
|
|
21
22
|
CLOCK = Process.const_get(CLOCK_NAMES.find{|name| Process.const_defined?(name)})
|
|
22
23
|
|
|
24
|
+
# How many measurements of nothing .floor takes, and which of them it keeps.
|
|
25
|
+
SAMPLES = 1_000
|
|
26
|
+
PERCENTILE = 0.95
|
|
27
|
+
|
|
23
28
|
class << self
|
|
24
29
|
def clock_name
|
|
25
30
|
@clock_name ||= CLOCK_NAMES.find{|name| Process.const_defined?(name)}
|
|
@@ -36,6 +41,24 @@ module Monotonic
|
|
|
36
41
|
def resolution
|
|
37
42
|
Process.clock_getres(CLOCK, :nanosecond)
|
|
38
43
|
end
|
|
44
|
+
|
|
45
|
+
# What it costs to measure at all, in nanoseconds, measured by timing
|
|
46
|
+
# measurements of nothing. The clock's tick is not the limit: two readings
|
|
47
|
+
# must be taken, and taking them takes time, so an interval near this
|
|
48
|
+
# figure is mostly the measuring.
|
|
49
|
+
#
|
|
50
|
+
# It is a floor and not an error bar. The typical cost is a tick or two;
|
|
51
|
+
# the tail is unbounded and one-sided, since the scheduler may take the
|
|
52
|
+
# processor away between the two readings and no single measurement can
|
|
53
|
+
# detect that it did. A high percentile is taken rather than a median, so
|
|
54
|
+
# that the ordinary case is covered rather than merely the best one.
|
|
55
|
+
# Repeat and take a robust statistic if the tail matters.
|
|
56
|
+
def floor
|
|
57
|
+
@floor ||= (
|
|
58
|
+
samples = SAMPLES.times.map{timer = new; timer.start; timer.stop; timer.total_nanoseconds}.sort
|
|
59
|
+
samples[(samples.length * PERCENTILE).to_i]
|
|
60
|
+
)
|
|
61
|
+
end
|
|
39
62
|
end # class << self
|
|
40
63
|
|
|
41
64
|
# Where the instants come from. Nothing supplied means the clock is read
|
|
@@ -87,6 +110,22 @@ module Monotonic
|
|
|
87
110
|
to_duration.to_seconds.to_f
|
|
88
111
|
end
|
|
89
112
|
|
|
113
|
+
# The elapsed interval together with what it is worth. Not memoized: a timer
|
|
114
|
+
# which has not been stopped is still running, and so is its measurement.
|
|
115
|
+
# The floor is handed over as a method rather than a figure, so that a caller
|
|
116
|
+
# which only ever wants a number never sets the thousand null measurements
|
|
117
|
+
# going.
|
|
118
|
+
def measurement(drift: nil)
|
|
119
|
+
Monotonic::Measurement.new(total_nanoseconds, floor: self.class.method(:floor), drift: drift)
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
def to_s
|
|
123
|
+
measurement.to_s
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# A Monotonic::Measurement rather than a bare Float, so that what comes back
|
|
127
|
+
# says how much of itself is real. #total_time and #total_nanoseconds are
|
|
128
|
+
# still there for a number.
|
|
90
129
|
def time
|
|
91
130
|
start
|
|
92
131
|
begin
|
|
@@ -94,7 +133,7 @@ module Monotonic
|
|
|
94
133
|
ensure
|
|
95
134
|
stop
|
|
96
135
|
end
|
|
97
|
-
|
|
136
|
+
measurement
|
|
98
137
|
end
|
|
99
138
|
|
|
100
139
|
private
|
data/lib/Monotonic/VERSION.rb
CHANGED
data/monotonic.rb.gemspec
CHANGED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
require_relative '../../lib/monotonic.rb'
|
|
2
|
+
|
|
3
|
+
require 'minitest/autorun'
|
|
4
|
+
require 'minitest-spec-context'
|
|
5
|
+
|
|
6
|
+
describe Monotonic::Measurement do
|
|
7
|
+
def measurement(nanoseconds, floor: 84, drift: nil)
|
|
8
|
+
Monotonic::Measurement.new(nanoseconds, floor: floor, drift: drift)
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
describe "the unit" do
|
|
12
|
+
it "is the largest which leaves a mantissa of at least one" do
|
|
13
|
+
_(measurement(999).unit_name).must_equal('ns')
|
|
14
|
+
_(measurement(1_000).unit_name).must_equal('us')
|
|
15
|
+
_(measurement(1_265_625).unit_name).must_equal('ms')
|
|
16
|
+
_(measurement(1_000_000_000).unit_name).must_equal('s')
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
it "stops at seconds, the ladder being powers of a thousand" do
|
|
20
|
+
_(measurement(86_400_000_000_000).unit_name).must_equal('s')
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
it "is nanoseconds for nothing at all" do
|
|
24
|
+
_(measurement(0).to_s).must_equal('0 ns')
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
describe "the digits" do
|
|
29
|
+
it "reach as far as the uncertainty does and no further" do
|
|
30
|
+
_(measurement(1_265_625).to_s).must_equal('1.26562 ms')
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
it "are fewer upon a coarser instrument" do
|
|
34
|
+
_(measurement(1_265_625, floor: 100_000).to_s).must_equal('1.27 ms')
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
it "are none where the interval is near the floor" do
|
|
38
|
+
_(measurement(999).to_s).must_equal('999 ns')
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
it "are not capped, a day resolved to a hundred nanoseconds saying so" do
|
|
42
|
+
_(measurement(86_400_000_000_000).to_s).must_equal('86400.00000000 s')
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
describe "the uncertainty" do
|
|
47
|
+
it "is the floor alone when no drift is supplied" do
|
|
48
|
+
_(measurement(1_000_000).uncertainty).must_equal(84)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
it "combines a drift in quadrature rather than by addition" do
|
|
52
|
+
combined = measurement(1_000_000_000, drift: 1e-6).uncertainty
|
|
53
|
+
_(combined).must_be_close_to(Math.sqrt(84**2 + 1_000**2), 0.01)
|
|
54
|
+
_(combined).wont_be_close_to(84 + 1_000, 1)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
it "takes digits away as it grows" do
|
|
58
|
+
_(measurement(7_166_559_999, drift: 20e-6).decimals) \
|
|
59
|
+
.must_be(:<, measurement(7_166_559_999).decimals)
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
it "comes from a Measurand, which owns the arithmetic" do
|
|
63
|
+
_(measurement(1_000_000).measurand).must_be_instance_of(Measurand)
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
describe "the floor" do
|
|
68
|
+
it "may be a number" do
|
|
69
|
+
_(measurement(1_000_000, floor: 84).floor).must_equal(84)
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
it "may be something callable, and is not called until doubt is asked about" do
|
|
73
|
+
called = false
|
|
74
|
+
subject = Monotonic::Measurement.new(1_000_000, floor: ->{called = true; 84})
|
|
75
|
+
subject.to_i
|
|
76
|
+
subject.to_duration
|
|
77
|
+
_(called).must_equal(false)
|
|
78
|
+
subject.uncertainty
|
|
79
|
+
_(called).must_equal(true)
|
|
80
|
+
_(subject.floor).must_equal(84)
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
describe "comparison" do
|
|
85
|
+
it "orders one measurement against another" do
|
|
86
|
+
_(measurement(999)).must_be(:<, measurement(1_000))
|
|
87
|
+
_([measurement(1_000), measurement(999)].sort.map(&:nanoseconds)).must_equal([999, 1_000])
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
it "is nil against a bare number, which has no unit" do
|
|
91
|
+
_(measurement(999) <=> 999).must_be_nil
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
it "is therefore not equal to a bare number" do
|
|
95
|
+
_(measurement(999) == 999).must_equal(false)
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
describe "arithmetic" do
|
|
100
|
+
it "adds two intervals to an interval, the doubt going in quadrature" do
|
|
101
|
+
sum = measurement(1_000_000) + measurement(2_000_000)
|
|
102
|
+
_(sum).must_be_instance_of(Monotonic::Measurement)
|
|
103
|
+
_(sum.nanoseconds).must_equal(3_000_000)
|
|
104
|
+
_(sum.uncertainty).must_be_close_to(Math.sqrt(84**2 + 84**2), 0.0001)
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
it "subtracts likewise, the doubt growing rather than cancelling" do
|
|
108
|
+
difference = measurement(2_000_000) - measurement(1_000_000)
|
|
109
|
+
_(difference.nanoseconds).must_equal(1_000_000)
|
|
110
|
+
_(difference.uncertainty).must_be_close_to(Math.sqrt(84**2 + 84**2), 0.0001)
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
it "takes a duration as exact, it having no doubt of its own" do
|
|
114
|
+
sum = measurement(1_000_000) + Duration::Microseconds.new(500)
|
|
115
|
+
_(sum.nanoseconds).must_equal(1_500_000)
|
|
116
|
+
_(sum.uncertainty).must_equal(84)
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
it "refuses a bare number, which has no unit to add" do
|
|
120
|
+
_{measurement(1_000_000) + 5}.must_raise(TypeError)
|
|
121
|
+
_{measurement(1_000_000) - 5}.must_raise(TypeError)
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
it "scales by a number, the uncertainty scaling with it" do
|
|
125
|
+
product = measurement(1_000_000) * 3
|
|
126
|
+
_(product.nanoseconds).must_equal(3_000_000)
|
|
127
|
+
_(product.uncertainty).must_equal(252)
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
it "refuses to multiply two intervals, there being no unit of time squared" do
|
|
131
|
+
_{measurement(1_000_000) * measurement(2_000_000)}.must_raise(TypeError)
|
|
132
|
+
_{measurement(1_000_000) * Duration::Seconds.new(1)}.must_raise(TypeError)
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
it "divides by a number and stays an interval" do
|
|
136
|
+
quotient = measurement(1_000_000) / 2
|
|
137
|
+
_(quotient).must_be_instance_of(Monotonic::Measurement)
|
|
138
|
+
_(quotient.nanoseconds).must_equal(500_000)
|
|
139
|
+
_(quotient.uncertainty).must_equal(42)
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
describe "the ratio of two intervals" do
|
|
144
|
+
it "is dimensionless, the units having cancelled" do
|
|
145
|
+
ratio = measurement(9_579_583) / measurement(10_900_458)
|
|
146
|
+
_(ratio).must_be_instance_of(Measurand)
|
|
147
|
+
_(ratio.value.to_f).must_be_close_to(0.878824, 0.000001)
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
it "divides exactly rather than as integers, which measurand 0.1.2 settled" do
|
|
151
|
+
_((measurement(1_000_000) / measurement(3_000_000)).value).must_equal(Rational(1, 3))
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
it "carries the doubt of both, which is what a speedup is worth knowing" do
|
|
155
|
+
ratio = measurement(9_579_583) / measurement(10_900_458)
|
|
156
|
+
_(ratio.uncertainty).must_be_close_to(1.026e-05, 1e-8)
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
describe "#to_duration" do
|
|
161
|
+
it "hands the interval to duration.rb, whose business the units are" do
|
|
162
|
+
_(measurement(1_500_000_000).to_duration).must_be_instance_of(Duration::Nanoseconds)
|
|
163
|
+
_(measurement(1_500_000_000).to_duration.to_seconds.to_f).must_equal(1.5)
|
|
164
|
+
end
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
describe "#to_i and #to_f" do
|
|
168
|
+
it "both answer in nanoseconds, the measurement's own unit" do
|
|
169
|
+
_(measurement(1_274_625).to_i).must_equal(1_274_625)
|
|
170
|
+
_(measurement(1_274_625).to_f).must_equal(1_274_625.0)
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
it "agree with one another, and with #nanoseconds" do
|
|
174
|
+
subject = measurement(1_274_625)
|
|
175
|
+
_(subject.to_f).must_equal(subject.to_i.to_f)
|
|
176
|
+
_(subject.to_i).must_equal(subject.nanoseconds)
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
@@ -9,7 +9,7 @@ describe Monotonic::Timer do
|
|
|
9
9
|
block_time = Monotonic::Timer.time do |timer|
|
|
10
10
|
sleep 3
|
|
11
11
|
end
|
|
12
|
-
expect(block_time.round).must_equal(3)
|
|
12
|
+
expect(block_time.to_duration.to_seconds.to_f.round).must_equal(3)
|
|
13
13
|
end
|
|
14
14
|
|
|
15
15
|
# Test introduced in 0.6.5 to demonstrate that the bug had been fixed.
|
|
@@ -18,7 +18,7 @@ describe Monotonic::Timer do
|
|
|
18
18
|
sleep 3
|
|
19
19
|
4
|
|
20
20
|
end
|
|
21
|
-
expect(block_time.round).must_equal(3)
|
|
21
|
+
expect(block_time.to_duration.to_seconds.to_f.round).must_equal(3)
|
|
22
22
|
end
|
|
23
23
|
|
|
24
24
|
# Test introduced in 0.6.7 to demonstrate that the bug had been fixed.
|
|
@@ -51,7 +51,7 @@ describe Monotonic::Timer do
|
|
|
51
51
|
timer.start
|
|
52
52
|
sleep 1
|
|
53
53
|
end
|
|
54
|
-
expect(block_time.round).must_equal(1)
|
|
54
|
+
expect(block_time.to_duration.to_seconds.to_f.round).must_equal(1)
|
|
55
55
|
end
|
|
56
56
|
end
|
|
57
57
|
|
|
@@ -88,7 +88,7 @@ describe Monotonic::Timer do
|
|
|
88
88
|
expect(timer.total_time.round).must_equal(0)
|
|
89
89
|
sleep 1
|
|
90
90
|
end
|
|
91
|
-
expect(time.round).must_equal(1)
|
|
91
|
+
expect(time.to_duration.to_seconds.to_f.round).must_equal(1)
|
|
92
92
|
expect(timer.total_time.round).must_equal(1)
|
|
93
93
|
end
|
|
94
94
|
|
data/test/gemspec_test.rb
CHANGED
|
@@ -19,7 +19,17 @@ describe 'monotonic.rb.gemspec' do
|
|
|
19
19
|
end
|
|
20
20
|
|
|
21
21
|
it "declares its runtime dependencies" do
|
|
22
|
-
_(spec.runtime_dependencies.map(&:name).sort).must_equal(%w{duration.rb sys-uptime})
|
|
22
|
+
_(spec.runtime_dependencies.map(&:name).sort).must_equal(%w{duration.rb measurand sys-uptime})
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# The minimum is what makes a dependency true, and naming the gem alone does
|
|
26
|
+
# not say that it will work. 0.9.0 constrained measurand to >= 0.1.0, where
|
|
27
|
+
# #place became public; #/ then became load-bearing at 0.1.2 without the
|
|
28
|
+
# constraint following it, and Measurement#/ returned 0 against a version the
|
|
29
|
+
# gemspec called satisfactory.
|
|
30
|
+
it "declares a minimum version for each runtime dependency" do
|
|
31
|
+
_(spec.runtime_dependencies.to_h{|dependency| [dependency.name, dependency.requirement.to_s]}) \
|
|
32
|
+
.must_equal({'duration.rb' => '>= 0.4.0', 'measurand' => '>= 0.1.2', 'sys-uptime' => '>= 0'})
|
|
23
33
|
end
|
|
24
34
|
|
|
25
35
|
it "declares its development dependencies" do
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: monotonic.rb
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.10.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- thoran
|
|
@@ -23,6 +23,20 @@ dependencies:
|
|
|
23
23
|
- - ">="
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
25
|
version: 0.4.0
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: measurand
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - ">="
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: 0.1.2
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - ">="
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: 0.1.2
|
|
26
40
|
- !ruby/object:Gem::Dependency
|
|
27
41
|
name: sys-uptime
|
|
28
42
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -89,11 +103,13 @@ files:
|
|
|
89
103
|
- Gemfile
|
|
90
104
|
- README.md
|
|
91
105
|
- Rakefile
|
|
106
|
+
- lib/Monotonic/Measurement.rb
|
|
92
107
|
- lib/Monotonic/Time.rb
|
|
93
108
|
- lib/Monotonic/Timer.rb
|
|
94
109
|
- lib/Monotonic/VERSION.rb
|
|
95
110
|
- lib/monotonic.rb
|
|
96
111
|
- monotonic.rb.gemspec
|
|
112
|
+
- test/Monotonic/Measurement_test.rb
|
|
97
113
|
- test/Monotonic/Time_test.rb
|
|
98
114
|
- test/Monotonic/Timer_test.rb
|
|
99
115
|
- test/Monotonic/VERSION_test.rb
|