Merge pull request #46 from SymbolicML/ext-measurements

Add extension for Measurements.jl

Author: MilesCranmer

Project.toml

@@ -12,17 +12,20 @@ Tricks = "410a4b4d-49e4-4fbc-ab6d-cb71b17b3775"
 
 [weakdeps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
 ScientificTypes = "321657f4-b219-11e9-178b-2701a2544e81"
 ScientificTypesBase = "30f210dd-8aff-4c5f-94ba-8e64358c1161"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [extensions]
 DynamicQuantitiesLinearAlgebraExt = "LinearAlgebra"
+DynamicQuantitiesMeasurementsExt = "Measurements"
 DynamicQuantitiesScientificTypesExt = ["ScientificTypes", "ScientificTypesBase"]
 DynamicQuantitiesUnitfulExt = "Unitful"
 
 [compat]
 Compat = "^3.42, 4"
+Measurements = "2"
 PackageExtensionCompat = "1"
 ScientificTypes = "3"
 ScientificTypesBase = "3"
@@ -33,6 +36,7 @@ julia = "1.6"
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
 Ratios = "c84ed2f1-dad5-54f0-aa8e-dbefe2724439"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
 SaferIntegers = "88634af6-177f-5301-88b8-7819386cfa38"
@@ -43,4 +47,16 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [targets]
-test = ["Test", "Aqua", "LinearAlgebra", "Ratios", "SaferIntegers", "SafeTestsets", "ScientificTypes", "ScientificTypesBase", "StaticArrays", "Unitful"]
+test = [
+    "Aqua",
+    "LinearAlgebra",
+    "Measurements",
+    "Ratios",
+    "SaferIntegers",
+    "SafeTestsets",
+    "ScientificTypes",
+    "ScientificTypesBase",
+    "StaticArrays",
+    "Test",
+    "Unitful"
+]

ext/DynamicQuantitiesMeasurementsExt.jl

@@ -0,0 +1,18 @@
+module DynamicQuantitiesMeasurementsExt
+
+using DynamicQuantities: AbstractQuantity, new_quantity, dimension, ustrip, DimensionError
+using Measurements: Measurements, measurement, value, uncertainty
+
+function Measurements.measurement(a::Q, b::Q) where {Q<:AbstractQuantity}
+    dimension(a) == dimension(b) || throw(DimensionError(a, b))
+    raw_measurement = measurement(ustrip(a), ustrip(b))
+    return new_quantity(Q, raw_measurement, dimension(a))
+end
+function Measurements.measurement(a::AbstractQuantity, b::AbstractQuantity)
+    return measurement(promote(a, b)...)
+end
+
+Measurements.value(q::Q) where {Q<:AbstractQuantity} = new_quantity(Q, value(ustrip(q)), dimension(q))
+Measurements.uncertainty(q::Q) where {Q<:AbstractQuantity} = new_quantity(Q, uncertainty(ustrip(q)), dimension(q))
+
+end

src/utils.jl

@@ -176,6 +176,7 @@ tryrationalize(::Type{R}, x) where {R} = isinteger(x) ? convert(R, round(Int, x)
 
 Base.showerror(io::IO, e::DimensionError) = print(io, "DimensionError: ", e.q1, " and ", e.q2, " have incompatible dimensions")
 
+# TODO: these are redundant with the constructors
 Base.convert(::Type{Q}, q::AbstractQuantity) where {Q<:AbstractQuantity} = q
 Base.convert(::Type{Q}, q::AbstractQuantity) where {T,Q<:AbstractQuantity{T}} = new_quantity(Q, convert(T, ustrip(q)), dimension(q))
 Base.convert(::Type{Q}, q::AbstractQuantity) where {T,D,Q<:AbstractQuantity{T,D}} = new_quantity(Q, convert(T, ustrip(q)), convert(D, dimension(q)))

test/runtests.jl

@@ -16,6 +16,9 @@ else
     @safetestset "ScientificTypes.jl integration tests" begin
         include("test_scitypes.jl")
     end
+    @safetestset "Measurements.jl integration tests" begin
+        include("test_measurements.jl")
+    end
     @safetestset "Unit tests" begin
         include("unittests.jl")
     end

test/test_measurements.jl

@@ -0,0 +1,15 @@
+using DynamicQuantities
+using Measurements
+using Measurements: value, uncertainty
+
+x = 1.0u"m/s" ± 0.1u"m/s"
+
+@test ustrip(x^2) == ustrip(x)^2
+@test value(x) == 1.0u"m/s"
+@test uncertainty(x) == 0.1u"m/s"
+@test dimension(x)^2 == dimension(x^2)
+@test_throws DimensionError 0.5u"m" ± 0.1u"s"
+
+# Mixed types:
+y = Quantity{Float16}(0.1u"m/s") ± Quantity{Float32}(0.1u"m/s")
+@test typeof(y) <: Quantity{Measurement{Float32}}