Skip to content

make protocol functions data type specific #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 5, 2019
Merged

make protocol functions data type specific #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ public protocol TimerHandler: AnyObject {

```swift
public protocol RecorderHandler: AnyObject {
func record<DataType: BinaryInteger>(_ value: DataType)
func record<DataType: BinaryFloatingPoint>(_ value: DataType)
func record(_ value: Int64)
func record(_ value: Double)
}
```

Expand All @@ -120,7 +120,7 @@ class SimpleMetricsLibrary: MetricsFactory {
}

func makeRecorder(label: String, dimensions: [(String, String)], aggregate: Bool) -> RecorderHandler {
let maker:(String, [(String, String)]) -> Recorder = aggregate ? ExampleRecorder.init : ExampleGauge.init
let maker: (String, [(String, String)]) -> RecorderHandler = aggregate ? ExampleRecorder.init : ExampleGauge.init
return maker(label, dimensions)
}

Expand All @@ -133,9 +133,15 @@ class SimpleMetricsLibrary: MetricsFactory {

let lock = NSLock()
var value: Int64 = 0
func increment<DataType: BinaryInteger>(_ value: DataType) {
func increment(_ value: Int64) {
self.lock.withLock {
self.value += Int64(value)
self.value += value
}
}

func reset() {
self.lock.withLock {
self.value = 0
}
}
}
Expand All @@ -145,20 +151,18 @@ class SimpleMetricsLibrary: MetricsFactory {

private let lock = NSLock()
var values = [(Int64, Double)]()
func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.record(Double(value))
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
// this may loose precision, but good enough as an example
let v = Double(value)
func record(_ value: Double) {
// TODO: sliding window
lock.withLock {
values.append((Date().nanoSince1970, v))
values.append((Date().nanoSince1970, value))
self._count += 1
self._sum += v
if 0 == self._min || v < self._min { self._min = v }
if 0 == self._max || v > self._max { self._max = v }
self._sum += value
self._min = Swift.min(self._min, value)
self._max = Swift.max(self._max, value)
}
}

Expand Down Expand Up @@ -188,13 +192,12 @@ class SimpleMetricsLibrary: MetricsFactory {

let lock = NSLock()
var _value: Double = 0
func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.record(Double(value))
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
// this may loose precision but good enough as an example
self.lock.withLock { _value = Double(value) }
func record(_ value: Double) {
self.lock.withLock { _value = value }
}
}

Expand Down
24 changes: 12 additions & 12 deletions Sources/CoreMetrics/Metrics.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

/// This is the Counter protocol a metrics library implements. It must have reference semantics
public protocol CounterHandler: AnyObject {
func increment<DataType: BinaryInteger>(_ value: DataType)
func increment(_ value: Int64)
func reset()
}

Expand All @@ -35,7 +35,7 @@ public class Counter {

@inlinable
public func increment<DataType: BinaryInteger>(_ value: DataType) {
self.handler.increment(value)
self.handler.increment(Int64(value))
}

@inlinable
Expand All @@ -58,8 +58,8 @@ public extension Counter {

/// This is the Recorder protocol a metrics library implements. It must have reference semantics
public protocol RecorderHandler: AnyObject {
func record<DataType: BinaryInteger>(_ value: DataType)
func record<DataType: BinaryFloatingPoint>(_ value: DataType)
func record(_ value: Int64)
func record(_ value: Double)
}

// This is the user facing Recorder API. Its behavior depends on the `RecorderHandler` implementation
Expand All @@ -81,12 +81,12 @@ public class Recorder {

@inlinable
public func record<DataType: BinaryInteger>(_ value: DataType) {
self.handler.record(value)
self.handler.record(Int64(value))
}

@inlinable
public func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
self.handler.record(value)
self.handler.record(Double(value))
}
}

Expand Down Expand Up @@ -225,7 +225,7 @@ public final class MultiplexMetricsHandler: MetricsFactory {
self.counters = factories.map { $0.makeCounter(label: label, dimensions: dimensions) }
}

func increment<DataType: BinaryInteger>(_ value: DataType) {
func increment(_ value: Int64) {
self.counters.forEach { $0.increment(value) }
}

Expand All @@ -240,11 +240,11 @@ public final class MultiplexMetricsHandler: MetricsFactory {
self.recorders = factories.map { $0.makeRecorder(label: label, dimensions: dimensions, aggregate: aggregate) }
}

func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.recorders.forEach { $0.record(value) }
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
func record(_ value: Double) {
self.recorders.forEach { $0.record(value) }
}
}
Expand Down Expand Up @@ -278,9 +278,9 @@ public final class NOOPMetricsHandler: MetricsFactory, CounterHandler, RecorderH
return self
}

public func increment<DataType: BinaryInteger>(_: DataType) {}
public func increment(_: Int64) {}
public func reset() {}
public func record<DataType: BinaryInteger>(_: DataType) {}
public func record<DataType: BinaryFloatingPoint>(_: DataType) {}
public func record(_: Int64) {}
public func record(_: Double) {}
public func recordNanoseconds(_: Int64) {}
}
27 changes: 12 additions & 15 deletions Sources/Examples/ExampleMetricsLibrary.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,27 +138,25 @@ class ExampleRecorder: RecorderHandler, CustomStringConvertible {

private let lock = NSLock()
var values = [(Int64, Double)]()
func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.record(Double(value))
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
// this may loose precision, but good enough as an example
let v = Double(value)
func record(_ value: Double) {
// TODO: sliding window
lock.withLock {
values.append((Date().nanoSince1970, v))
self.lock.withLock {
values.append((Date().nanoSince1970, value))
}
options.forEach { option in
self.options.forEach { option in
switch option {
case .count:
self.count += 1
case .sum:
self.sum += v
self.sum += value
case .min:
if 0 == self.min || v < self.min { self.min = v }
self.min = Swift.min(self.min, value)
case .max:
if 0 == self.max || v > self.max { self.max = v }
self.max = Swift.max(self.max, value)
case .quantiles(let items):
self.computeQuantiles(items)
}
Expand Down Expand Up @@ -224,7 +222,7 @@ class ExampleRecorder: RecorderHandler, CustomStringConvertible {
self.lock.withLock {
self._quantiels.removeAll()
items.forEach { item in
if let result = Sigma.quantiles.method1(self.values.map { Double($0.1) }, probability: Double(item)) {
if let result = Sigma.quantiles.method1(self.values.map { $0.1 }, probability: Double(item)) {
self._quantiels[item] = result
}
}
Expand All @@ -242,13 +240,12 @@ class ExampleGauge: RecorderHandler, CustomStringConvertible {

let lock = NSLock()
var _value: Double = 0
func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.record(Double(value))
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
// this may loose precision but good enough as an example
self.lock.withLock { _value = Double(value) }
func record(_ value: Double) {
self.lock.withLock { _value = value }
}

var description: String {
Expand Down
27 changes: 12 additions & 15 deletions Sources/Examples/SimpleMetricsLibrary.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ class SimpleMetricsLibrary: MetricsFactory {

let lock = NSLock()
var value: Int64 = 0
func increment<DataType: BinaryInteger>(_ value: DataType) {
func increment(_ value: Int64) {
self.lock.withLock {
self.value += Int64(value)
self.value += value
}
}

Expand All @@ -56,20 +56,18 @@ class SimpleMetricsLibrary: MetricsFactory {

private let lock = NSLock()
var values = [(Int64, Double)]()
func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.record(Double(value))
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
// this may loose precision, but good enough as an example
let v = Double(value)
func record(_ value: Double) {
// TODO: sliding window
lock.withLock {
values.append((Date().nanoSince1970, v))
self.lock.withLock {
values.append((Date().nanoSince1970, value))
self._count += 1
self._sum += v
self._min = Swift.min(self._min, v)
self._max = Swift.max(self._max, v)
self._sum += value
self._min = Swift.min(self._min, value)
self._max = Swift.max(self._max, value)
}
}

Expand Down Expand Up @@ -99,13 +97,12 @@ class SimpleMetricsLibrary: MetricsFactory {

let lock = NSLock()
var _value: Double = 0
func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.record(Double(value))
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
// this may loose precision but good enough as an example
self.lock.withLock { _value = Double(value) }
func record(_ value: Double) {
self.lock.withLock { _value = value }
}
}

Expand Down
9 changes: 5 additions & 4 deletions Tests/MetricsTests/TestMetrics.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ internal class TestCounter: CounterHandler, Equatable {
self.dimensions = dimensions
}

func increment<DataType: BinaryInteger>(_ value: DataType) {
func increment(_ value: Int64) {
self.lock.withLock {
self.values.append((Date(), Int64(value)))
self.values.append((Date(), value))
}
print("adding \(value) to \(self.label)")
}
Expand All @@ -71,6 +71,7 @@ internal class TestCounter: CounterHandler, Equatable {
self.lock.withLock {
self.values = []
}
print("reseting \(self.label)")
}

public static func == (lhs: TestCounter, rhs: TestCounter) -> Bool {
Expand All @@ -94,11 +95,11 @@ internal class TestRecorder: RecorderHandler, Equatable {
self.aggregate = aggregate
}

func record<DataType: BinaryInteger>(_ value: DataType) {
func record(_ value: Int64) {
self.record(Double(value))
}

func record<DataType: BinaryFloatingPoint>(_ value: DataType) {
func record(_ value: Double) {
self.lock.withLock {
// this may loose precision but good enough as an example
values.append((Date(), Double(value)))
Expand Down