measurand 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77e11fd475e1104e6ff1b26e9d0528c9e6918a0340832106b58eefe09b46da1e
-  data.tar.gz: ca6538ff0f68ec369df90ced58ab97aa8ed4083680a3c4f4f555f5af80b7ee63
+  metadata.gz: 4caf91e22da69c556702463204bf65ea9eec1c52b6dcaf05552fc0c91405af22
+  data.tar.gz: be7b0a5d116588a0aad0dac6f9aa7b7eda71eeedb0efb0f45d4ab8d0768a15bb
 SHA512:
-  metadata.gz: 48bf9b4e4110cede8150f8abd1521d39e9e39c701d3db7cd0e9697fef8e59aba0e2ac21dd60590b8b71be8d6845bc14212ecc896f1a3085c45cb85ca433dc19e
-  data.tar.gz: 99f5e0811d117c252c0d703b144f30f1283f72d47ffb65b2b07e27d603357f7ac6cc4aa4c4413e1754c54d9734a2f7e9cf7db3abf754c89eb74fae73dc233762
+  metadata.gz: 7644fba9dd884b911bb436af4fadfbea172195baa51b57b15c20f6f0ae9e7c2c7a499e8ef6ad815e918df430cfbfac9cddc2abb768eb3ce1f6d48deefe431973
+  data.tar.gz: 945f167c52db919848a324a81585f9c0b747c2676bf3361eeac76044080b09139af5d406e28d51799cdcaf6a0a535bb974c459594e2a15f11f4b21ec991a344c

data/CHANGELOG

@@ -0,0 +1,44 @@
+# CHANGELOG
+
+## 20260815
+
+0.1.0: + Measurand#place, Measurand#rounded_uncertainty.
+
+1. + Measurand#place: the power of ten of the least significant digit worth showing, negative for digits after the point, and nil where the measurand is exact — every digit being real and there being no last one. It is what a caller wants in order to render a quantity in a unit of its own choosing rather than take #to_s, and monotonic.rb was reaching into Measurand::Format to get at it.
+2. + Measurand#rounded_uncertainty: the uncertainty as #to_s shows it, rounded by the Particle Data Group convention, and zero where the measurand is exact.
+3. ~ Measurand#to_s and #to_parenthetic: built upon the two above rather than calling Measurand::Format themselves, so that what is published and what is rendered cannot drift apart.
+4. + test/Measurand/Format_test.rb: #place and #rounded_uncertainty, including the exact case and that #place agrees with the digits #to_s renders.
+5. ~ lib/Measurand/Format.rb --> lib/measurand.rb: #place, #rounded_uncertainty, #to_s, #to_parenthetic, #inspect and the private #fixed, which are Measurand's and not Format's. The file is named for the module and now holds only it, as Monotonic/Time.rb holds Monotonic::Time. Naming them by the file they sat in was already a mistake waiting to be made.
+6. + CHANGELOG, and - CHANGELOG.md. Both were present at 0.0.0 and only the .md shipped; the gem is what is immutable, so 0.0.0 has been rewritten to carry the .md alone and the change of file belongs here. CHANGELOG is what every other gem here is spelt.
+7. ~ measurand.gemspec: /CHANGELOG.md/CHANGELOG/, following the above.
+8. ~ README.md: + #place and #rounded_uncertainty to the Presentation section.
+9. ~ Measurand::VERSION: /0.0.0/0.1.0/
+
+
+## 20260715
+
+0.0.0: + Measurand: measured values with uncertainty and GUM-conformant error propagation.
+
+1. + Measurand: Measured values with uncertainty and GUM-conformant error propagation, forward-mode automatic differentiation over a {Source => partial} map; the uncertainty is derived from the partials, not stored, so shared sources correlate (x - x is exactly 0 ± 0).
+2. + Measurand construction methods: .new, .relative, .cast, .cast\_relative, .from\_samples (mean ± standard error of the mean), .derived.
+3. + Measurand arithmetic methods: +, -, \*, /, \*\*, -@, abs, apply — chain-rule propagation; independent uncertainties combine in quadrature; scalars are exact.
+4. + Measurand comparison methods: ==/eql?/hash (exact: value and uncertainty), <=> (by value, Comparable), consistent\_with?, overlaps?, coerce (scalar-on-the-left arithmetic).
+5. + Measurand reader methods: value, uncertainty, relative\_uncertainty, exact?
+6. + Measurand::Format: Uncertainty-driven, PDG-rounded to\_s (ascii: keyword emits +/- instead of ±), to\_parenthetic, inspect (full precision).
+7. + Measurand::Math: Measurand::Math.sqrt, exp, log, log10, sin, cos, tan — chain-rule propagation with no Math monkey-patching.
+8. + Measurand::Numeric: opt-in Numeric#pm / #± and Enumerable#pm (separate require, so nothing is monkey-patched unless asked).
+9. + Measurand::Parse: Measurand.parse for ±, +/-, parenthetic (10), relative %, and exact forms; raises ArgumentError rather than returning nil.
+10. + Measurand::Source: Opaque per-source identity carrying its own uncertainty; deliberately no ==/eql?/hash, so shared sources correlate and independently-constructed ones never collapse.
+11. + Measurand::VERSION: 0.0.0
+12. + measurand.gemspec
+13. + Gemfile
+14. + LICENSE
+15. + Rakefile
+16. + README.md
+17. + test/test_helper.rb
+18. + test/Measurand/Format_test.rb
+19. + test/Measurand/Measurand_test.rb
+20. + test/Measurand/Math_test.rb
+21. + test/Measurand/Numeric_test.rb
+22. + test/Measurand/Parse_test.rb
+23. + test/Measurand/Source_test.rb

data/README.md

@@ -113,6 +113,17 @@ m.inspect              # => "Measurand(5.129213, 0.01)"  — full precision
 ```
 
 `to_s` emits the `±` character by default; pass `ascii: true` when writing to a
+
+Where a caller wants to render the quantity in some unit of its own rather than
+take the string here, the two figures `to_s` rests upon are readable:
+
+```ruby
+m.place                # => -3   the power of ten of the last real digit
+m.rounded_uncertainty  # => 0.01 the uncertainty as `to_s` shows it
+
+Measurand.new(5.129213).place                # => nil  exact: every digit is real
+Measurand.new(5.129213).rounded_uncertainty  # => 0
+```
 stream that isn't UTF-8. `parse` reads both forms, so either round-trips.
 
 ### Transcendentals

data/lib/Measurand/Format.rb

@@ -40,29 +40,4 @@ class Measurand
       place < 0 ? -place : 0
     end
   end
-
-  def to_s(ascii: false)
-    return @value.to_s if exact?
-    rounded_uncertainty, place = Format.round_uncertainty(uncertainty)
-    digits = Format.decimals(place)
-    "#{fixed(Format.round_to_place(@value, place), digits)} #{ascii ? '+/-' : '±'} #{fixed(rounded_uncertainty, digits)}"
-  end
-
-  def to_parenthetic
-    return @value.to_s if exact?
-    rounded_uncertainty, place = Format.round_uncertainty(uncertainty)
-    digits = Format.decimals(place)
-    parenthetic_digits = (rounded_uncertainty / 10.0 ** place).round
-    "#{fixed(Format.round_to_place(@value, place), digits)}(#{parenthetic_digits})"
-  end
-
-  def inspect
-    "Measurand(#{@value}, #{uncertainty})"
-  end
-
-  private
-
-  def fixed(number, digits)
-    format("%.#{digits}f", number)
-  end
 end

data/lib/Measurand/VERSION.rb

@@ -1,3 +1,3 @@
 class Measurand
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/lib/measurand.rb

@@ -154,6 +154,43 @@ class Measurand
     [wrap(other), self]
   end
 
+  # The power of ten of the least significant digit worth showing, by the
+  # convention above: negative for digits after the point, so a place of -3
+  # means thousandths are the last real thing. nil where the measurand is exact,
+  # every digit being real and there being no last one.
+  #
+  # This is what a caller wants in order to render a quantity in some unit of
+  # its own choosing, rather than taking the string here.
+  def place
+    return nil if exact?
+    @place ||= Format.round_uncertainty(uncertainty).last
+  end
+
+  # The uncertainty as #to_s shows it, rounded to one or two significant figures
+  # by the same convention. Zero where the measurand is exact.
+  def rounded_uncertainty
+    return 0 if exact?
+    @rounded_uncertainty ||= Format.round_uncertainty(uncertainty).first
+  end
+
+  def to_s(ascii: false)
+    return @value.to_s if exact?
+    digits = Format.decimals(place)
+    "#{fixed(Format.round_to_place(@value, place), digits)} #{ascii ? '+/-' : '±'} #{fixed(rounded_uncertainty, digits)}"
+  end
+
+  def to_parenthetic
+    return @value.to_s if exact?
+    digits = Format.decimals(place)
+    parenthetic_digits = (rounded_uncertainty / 10.0 ** place).round
+    "#{fixed(Format.round_to_place(@value, place), digits)}(#{parenthetic_digits})"
+  end
+
+  def inspect
+    "Measurand(#{@value}, #{uncertainty})"
+  end
+
+
   protected
 
   def partials
@@ -162,6 +199,10 @@ class Measurand
 
   private
 
+  def fixed(number, digits)
+    format("%.#{digits}f", number)
+  end
+
   def initialize(value, uncertainty = 0)
     @value = value
     @partials = uncertainty.zero? ? {} : {Source.new(uncertainty) => 1.0}

data/measurand.gemspec

@@ -1,3 +1,5 @@
+# measurand.gemspec
+
 require_relative './lib/Measurand/VERSION'
 
 Gem::Specification.new do |spec|
@@ -15,13 +17,14 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.5'
 
   spec.files = [
-    'measurand.gemspec',
-    'Gemfile',
     Dir['lib/**/*.rb'],
-    'CHANGELOG.md',
+    Dir['test/**/*.rb'],
+    'CHANGELOG',
+    'Gemfile',
     'LICENSE',
+    'measurand.gemspec',
     'README.md',
-    Dir['test/**/*.rb']
   ].flatten
+
   spec.require_paths = ['lib']
 end

data/test/Measurand/Format_test.rb

@@ -51,4 +51,31 @@ describe "Measurand formatting" do
       _(Measurand.new(5.129213, 0.01).inspect).must_equal "Measurand(5.129213, 0.01)"
     end
   end
+  describe "#place" do
+    it "is the power of ten of the least significant digit worth showing" do
+      _(Measurand.new(1_274_625, 84).place).must_equal(1)
+      _(Measurand.new(5.129213, 0.01).place).must_equal(-3)
+    end
+
+    it "is nil where the measurand is exact, every digit being real" do
+      _(Measurand.new(5.129213).place).must_be_nil
+    end
+
+    it "agrees with what #to_s renders" do
+      subject = Measurand.new(5.129213, 0.01)
+      _(subject.to_s.split(" ").first.split(".").last.length).must_equal(-subject.place)
+    end
+  end
+
+  describe "#rounded_uncertainty" do
+    it "is the uncertainty as #to_s shows it" do
+      _(Measurand.new(1_274_625, 84).rounded_uncertainty).must_equal(80)
+      _(Measurand.new(5.129213, 0.01).rounded_uncertainty).must_equal(0.01)
+    end
+
+    it "is zero where the measurand is exact" do
+      _(Measurand.new(5.129213).rounded_uncertainty).must_equal(0)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: measurand
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - thoran
@@ -18,7 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Measured values with uncertainty and GUM-conformant error propagation.
 test_files: []

data/CHANGELOG.md

@@ -1,27 +0,0 @@
-# CHANGELOG
-
-## [0.0.0] - 20260716
-## + Measurand: measured values with uncertainty and GUM-conformant error propagation.
-
-1. + lib/measurand.rb: Measurand — forward-mode automatic differentiation over a {Source => partial} map; the uncertainty is derived from the partials, not stored, so shared sources correlate (x - x is exactly 0 ± 0).
-2. + Measurand construction: .new, .relative, .cast, .cast\_relative, .from\_samples (mean ± standard error of the mean), .derived
-3. + Measurand arithmetic: +, -, \*, /, \*\*, -@, abs, apply — chain-rule propagation; independent uncertainties combine in quadrature; scalars are exact
-4. + Measurand comparison: ==/eql?/hash (exact: value and uncertainty), <=> (by value, Comparable), consistent\_with?, overlaps?, coerce (scalar-on-the-left arithmetic)
-5. + Measurand readers: value, uncertainty, relative\_uncertainty, exact?
-6. + lib/Measurand/Source.rb: opaque per-source identity carrying its own uncertainty; deliberately no ==/eql?/hash, so shared sources correlate and independently-constructed ones never collapse
-7. + lib/Measurand/Format.rb: uncertainty-driven, PDG-rounded to\_s (ascii: keyword emits +/- instead of ±), to\_parenthetic, inspect (full precision)
-8. + lib/Measurand/Parse.rb: Measurand.parse for ±, +/-, parenthetic (10), relative %, and exact forms; raises ArgumentError rather than returning nil
-9. + lib/Measurand/Math.rb: Measurand::Math.sqrt, exp, log, log10, sin, cos, tan — chain-rule propagation with no Math monkeypatching
-10. + lib/Measurand/Numeric.rb: opt-in Numeric#pm / #± and Enumerable#pm (separate require, so nothing is monkeypatched unless asked)
-11. + lib/Measurand/VERSION.rb
-12. + measurand.gemspec
-13. + Gemfile
-14. + LICENSE
-15. + README.md
-16. + test/test\_helper.rb, test/test\_all.rb
-17. + test/Measurand/Measurand\_test.rb
-18. + test/Measurand/Source\_test.rb
-19. + test/Measurand/Format\_test.rb
-20. + test/Measurand/Parse\_test.rb
-21. + test/Measurand/Math\_test.rb
-22. + test/Measurand/Numeric\_test.rb