uncertain 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 / 2007-01-17
+
+* Beta release
+* Still needs lots of tests
+* doesn't handle trig math yet

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/uncertain
+lib/uncertain.rb
+lib/math.rb
+lib/numeric.rb
+lib/object.rb
+lib/string.rb
+test/test_uncertain.rb
+test/test_numeric.rb
+test/test_object.rb
+test/test_string.rb
+test/test_uncertain.rb

data/README.txt

@@ -0,0 +1,50 @@
+    by Kevin Olbrich, Ph.D. (kevin.olbrich@gmail.com)
+    http://www.sciwerks.com 
+    http://rubyforge.org/projects/uncertain
+
+== DESCRIPTION:
+  
+'Uncertain' adds a Numeric class that encapsulates and handles numbers with uncertainty (e.g., 1.0 +/- 0.2).
+
+== FEATURES/PROBLEMS:
+  
+* Properly performs math on uncertain numbers (except for trig functions)
+* Plays well with 'ruby-units'... just create a unit like '1 +/- 0.1 mm'.unit
+
+== SYNOPSIS:
+
+  Uncertain(1,0.1)        #=> 1 +/- 0.1 
+  1.to_uncertain(0.1)     #=> 1 +/- 0.1
+
+== REQUIREMENTS:
+
+* 'ruby-units' is optional
+
+== INSTALL:
+
+* sudo gem install uncertain
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Kevin Olbrich
+
+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.

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/uncertain.rb'
+
+Hoe.new('uncertain', Uncertain::VERSION) do |p|
+  p.name = 'uncertain'
+  p.author = ['Kevin Olbrich']
+  p.email = 'kevin.olbrich@gmail.com'
+  p.summary = p.paragraphs_of('README.txt', 1).join("\n\n")
+  p.description = "'Uncertain' adds a Numeric class that encapsulates and handles numbers with uncertainty (e.g., 1.0 +/- 0.2)."
+  p.url = "http://rubyforge.org/projects/uncertain/"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/lib/math.rb

@@ -0,0 +1,37 @@
+module Math
+  alias uncertain_exp exp
+  def exp(n)
+    if Uncertain === n
+      x = uncertain_exp(n.value)
+      Uncertain.new(x,n.uncertainty*x)
+    else
+      uncertain_exp(n)
+    end
+  end
+  
+  alias uncertain_log log
+  def log(n)
+    if Uncertain == n
+      Uncertain.new(uncertain_log(n.value),n.uncertainty/n.value)
+    else
+      uncertain_log(n)
+    end
+  end
+  
+  alias uncertain_sqrt sqrt
+  def sqrt(n)
+    if Uncertain === n
+      n**(0.5)
+    else
+      uncertain_sqrt(n)
+    end
+  end
+  
+  module_function :uncertain_sqrt
+  module_function :sqrt
+  module_function :uncertain_exp
+  module_function :exp
+  module_function :uncertain_log
+  module_function :log
+  
+end

data/lib/numeric.rb

@@ -0,0 +1,6 @@
+class Numeric
+  def to_uncertain(uncertainty = 0)
+    Uncertain.new(self, uncertainty)
+  end
+  alias :uncertain :to_uncertain
+end

data/lib/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def Uncertain(v,u=0)
+    Uncertain.new(v,u)
+  end
+end

data/lib/string.rb

@@ -0,0 +1,11 @@
+class String
+  alias :uncertain_format :%
+  
+  def %(*args)
+    if Uncertain === args[0]
+      args[0].to_s(self)
+    else
+      uncertain_format(*args)
+    end
+  end
+end

data/lib/uncertain.rb

@@ -0,0 +1,135 @@
+require 'lib/math'
+require 'lib/numeric'
+require 'lib/object'
+require 'lib/string'
+
+
+# Uncertain
+#
+# Handles uncertain unit math using 'propogation of errors' rules
+# see http://en.wikipedia.org/wiki/Propagation_of_uncertainty
+# 
+class Uncertain < Numeric
+  include Comparable
+
+  @@html_output = false
+  VERSION = '0.1.0'
+  
+  attr_accessor :value, :uncertainty
+  
+  # set to true to use &plusmn; instead of '+/-'
+  def Uncertain.html_output=(style)
+    @@html_output = style
+  end
+  
+  def Uncertain.html_output
+    @@html_output
+  end
+  
+  def initialize(v,u=0)
+    @value = v.to_f
+    @uncertainty = u.to_f
+    self.freeze
+  end
+  
+  # Add two uncertain numbers
+  # (A +/- dA) + (B +/- dB) = (A+B) +/- (dA**2 + db**2)**(1/2)
+  def +(other)
+    if  Uncertain === other
+      Uncertain.new(@value+other.value, Math.sqrt(@uncertainty**2+other.uncertainty**2))
+    else
+      x,y = coerce(other)
+      x + y
+    end
+  end
+  
+  # substract two uncertain numbers
+  # (A +/- dA) - (B +/- dB) = (A-B) +/- (dA**2 + db**2)**(1/2)
+  def -(other)
+     if Uncertain === other
+       Uncertain.new(@value-other.value, Math.sqrt(@uncertainty**2+other.uncertainty**2))
+     else
+       x,y = coerce(other)
+       x - y
+     end
+  end
+  
+  def -@
+    Uncertain.new(-@value,@uncertainty)
+  end
+  
+  def *(other)
+    return 0 if other.zero?
+    if Uncertain === other
+      x = @value * other.value
+      Uncertain.new(x, x*Math.sqrt((@uncertainty/@value)**2+(other.uncertainty/other.value)**2))
+    else
+      x,y = coerce(other)
+      x * y
+    end
+  end
+  
+  def **(other)
+    raise ArgumentError, "exponent may not be Uncertain" if Uncertain === other
+    x = @value**other
+    Uncertain.new(x,x*other.abs*@uncertainty/@value)
+  end
+  
+  def /(other)
+    if Uncertain === other
+      x = @value/other.value
+      Uncertain.new(x, x*Math.sqrt((@uncertainty/@value)**2+(other.uncertainty/other.value)**2))
+    else
+      x,y = coerce(other)
+      y / x
+    end
+  end
+  
+  def inspect
+    "#{@value} +/- #{@uncertainty}"
+  end
+  
+  def coerce(other)
+    if defined?(Unit) && Unit === other
+      [other, Unit.new(self)]
+     else 
+       [Uncertain.new(other), self]
+     end
+   end
+   
+   def to_s(format = '%g')
+     "#{format % @value} #{@@html_output ? '&plusmn;' : '+/-'} #{format % @uncertainty}"
+   end
+  
+  def zero?
+    @value.zero? && @uncertainty.zero?
+  end
+  
+  # Uncertain numbers only use the value part for comparisons
+  def <=>(other)
+    case other
+    when Uncertain:
+      self.value <=> other.value
+    else
+      x,y = coerce(other)
+      x <=> y
+    end
+  end
+  
+  def ===(other)
+    case other
+    when Uncertain:
+      self.value == other.value && self.uncertainty == other.uncertainty
+    else
+      x,y = coerce(other)
+      x <=> y
+    end
+  end
+  
+end
+
+
+
+
+
+

data/test/test_math.rb

@@ -0,0 +1,109 @@
+# Code Generated by ZenTest v. 3.4.3
+#                 classname: asrt / meth =  ratio%
+#                      Math:    0 /    3 =   0.00%
+
+require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+
+class TestMath < Test::Unit::TestCase
+  def test_class_acos
+    raise NotImplementedError, 'Need to write test_class_acos'
+  end
+
+  def test_class_acosh
+    raise NotImplementedError, 'Need to write test_class_acosh'
+  end
+
+  def test_class_asin
+    raise NotImplementedError, 'Need to write test_class_asin'
+  end
+
+  def test_class_asinh
+    raise NotImplementedError, 'Need to write test_class_asinh'
+  end
+
+  def test_class_atan
+    raise NotImplementedError, 'Need to write test_class_atan'
+  end
+
+  def test_class_atan2
+    raise NotImplementedError, 'Need to write test_class_atan2'
+  end
+
+  def test_class_atanh
+    raise NotImplementedError, 'Need to write test_class_atanh'
+  end
+
+  def test_class_cos
+    raise NotImplementedError, 'Need to write test_class_cos'
+  end
+
+  def test_class_cosh
+    raise NotImplementedError, 'Need to write test_class_cosh'
+  end
+
+  def test_class_erf
+    raise NotImplementedError, 'Need to write test_class_erf'
+  end
+
+  def test_class_erfc
+    raise NotImplementedError, 'Need to write test_class_erfc'
+  end
+
+  def test_class_exp
+    raise NotImplementedError, 'Need to write test_class_exp'
+  end
+
+  def test_class_frexp
+    raise NotImplementedError, 'Need to write test_class_frexp'
+  end
+
+  def test_class_hypot
+    raise NotImplementedError, 'Need to write test_class_hypot'
+  end
+
+  def test_class_ldexp
+    raise NotImplementedError, 'Need to write test_class_ldexp'
+  end
+
+  def test_class_log
+    raise NotImplementedError, 'Need to write test_class_log'
+  end
+
+  def test_class_log10
+    raise NotImplementedError, 'Need to write test_class_log10'
+  end
+
+  def test_class_sin
+    raise NotImplementedError, 'Need to write test_class_sin'
+  end
+
+  def test_class_sinh
+    raise NotImplementedError, 'Need to write test_class_sinh'
+  end
+
+  def test_class_sqrt
+    raise NotImplementedError, 'Need to write test_class_sqrt'
+  end
+
+  def test_class_tan
+    raise NotImplementedError, 'Need to write test_class_tan'
+  end
+
+  def test_class_tanh
+    raise NotImplementedError, 'Need to write test_class_tanh'
+  end
+
+  def test_class_uncertain_exp
+    raise NotImplementedError, 'Need to write test_class_uncertain_exp'
+  end
+
+  def test_class_uncertain_log
+    raise NotImplementedError, 'Need to write test_class_uncertain_log'
+  end
+
+  def test_class_uncertain_sqrt
+    raise NotImplementedError, 'Need to write test_class_uncertain_sqrt'
+  end
+end
+
+# Number of errors detected: 26

data/test/test_numeric.rb

@@ -0,0 +1,14 @@
+# Code Generated by ZenTest v. 3.4.3
+#                 classname: asrt / meth =  ratio%
+#                   Numeric:    0 /    1 =   0.00%
+
+require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+
+class TestNumeric < Test::Unit::TestCase
+  def test_to_uncertain
+    assert_equal (1.to_uncertain(0.1)),Uncertain(1,0.1)
+    assert_equal (1.0.to_uncertain(0.1)),Uncertain(1.0,0.1)
+  end
+end
+
+# Number of errors detected: 22

data/test/test_object.rb

@@ -0,0 +1,17 @@
+# Code Generated by ZenTest v. 3.4.3
+#                 classname: asrt / meth =  ratio%
+#                    Object:    0 /    1 =   0.00%
+# Number of errors detected: 1
+
+require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+require 'uncertain'
+
+class TestObject < Test::Unit::TestCase
+  def test_uncertain
+    a = Uncertain(1,0.1)
+    assert a.kind_of?(Uncertain)
+    assert a.kind_of?(Numeric)
+    assert_equal a.value, 1
+    assert_equal a.uncertainty, 0.1
+  end
+end

data/test/test_string.rb

@@ -0,0 +1,16 @@
+# Code Generated by ZenTest v. 3.4.3
+#                 classname: asrt / meth =  ratio%
+#                    String:    0 /    1 =   0.00%
+
+require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+
+
+class TestString < Test::Unit::TestCase
+  
+  def test_uncertain_format
+    assert_equal "#{'%0.1f' % Uncertain(1,0.1)}", "1.0 +/- 0.1"
+  end
+
+end
+
+# Number of errors detected: 67

data/test/test_uncertain.rb

@@ -0,0 +1,69 @@
+# Code Generated by ZenTest v. 3.4.3
+#                 classname: asrt / meth =  ratio%
+#                   Numeric:    0 /    1 =   0.00%
+#                      Math:    0 /    3 =   0.00%
+#                    Object:    0 /    1 =   0.00%
+#                 Uncertain:    0 /   10 =   0.00%
+#                    String:    0 /    1 =   0.00%
+
+require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+
+
+class TestUncertain < Test::Unit::TestCase
+  
+  def test_html_output
+    assert Uncertain.html_output=true
+    assert_equal Uncertain(1,0.1).to_s, "1 &plusmn; 0.1"
+  end
+  
+  def test_compare
+    assert Uncertain(1,0.1) > Uncertain(0,0.1)
+    assert Uncertain(0,0.1) < Uncertain(1,0.1)
+  end
+
+  def test_coerce
+    raise NotImplementedError, 'Need to write test_coerce'
+  end
+
+  def test_div
+    raise NotImplementedError, 'Need to write test_div'
+  end
+
+  def test_minus
+    raise NotImplementedError, 'Need to write test_minus'
+  end
+
+  def test_plus
+    raise NotImplementedError, 'Need to write test_plus'
+  end
+
+  def test_times
+    raise NotImplementedError, 'Need to write test_times'
+  end
+
+  def test_times2
+    raise NotImplementedError, 'Need to write test_times2'
+  end
+
+  def test_unary_minus
+    raise NotImplementedError, 'Need to write test_unary_minus'
+  end
+
+  def test_uncertainty
+    raise NotImplementedError, 'Need to write test_uncertainty'
+  end
+
+  def test_uncertainty_equals
+    raise NotImplementedError, 'Need to write test_uncertainty_equals'
+  end
+
+  def test_value
+    raise NotImplementedError, 'Need to write test_value'
+  end
+
+  def test_value_equals
+    raise NotImplementedError, 'Need to write test_value_equals'
+  end
+end
+
+# Number of errors detected: 128

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: uncertain
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-01-17 00:00:00 -05:00
+summary: "== DESCRIPTION:  'Uncertain' adds a Numeric class that encapsulates and handles numbers with uncertainty (e.g., 1.0 +/- 0.2)."
+require_paths: 
+- lib
+email: kevin.olbrich@gmail.com
+homepage: http://rubyforge.org/projects/uncertain/
+rubyforge_project: uncertain
+description: "'Uncertain' adds a Numeric class that encapsulates and handles numbers with uncertainty (e.g., 1.0 +/- 0.2)."
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Kevin Olbrich
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/uncertain
+- lib/uncertain.rb
+- lib/math.rb
+- lib/numeric.rb
+- lib/object.rb
+- lib/string.rb
+- test/test_uncertain.rb
+- test/test_numeric.rb
+- test/test_object.rb
+- test/test_string.rb
+test_files: 
+- test/test_math.rb
+- test/test_numeric.rb
+- test/test_object.rb
+- test/test_string.rb
+- test/test_uncertain.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- uncertain
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: