plusminus 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "nio"
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    flt (1.3.0)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    nio (0.2.5)
+      flt (>= 1.0.0)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  nio
+  rcov
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Bernát Kalló
+
+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/README.rdoc

@@ -0,0 +1,33 @@
+= plusminus
+
+This gem provides a way to calculate uncertainties of measurements. 
+
+    5.129213.pm(0.01).to_s    #=> "5.13"
+
+You can access the +value+ and +delta+ fields:
+
+    5.129213.pm(0.01).value   #=> 5.129213
+    5.129213.pm(0.01).delta   #=> 0.01
+
+Error propagation is handled for operations
+
+    3.2.pm(0.1) + 4.5.pm(0.1)
+    # => 7.7.pm(0.2)
+    3.2.pm(0.1) * 4.5.pm(0.1)
+    # => 14.4.pm(0.77)
+
+
+
+
+== Contributing to plusminus
+ 
+* Fork
+* Branch
+* Commit
+* Pull request
+
+== Copyright
+
+Copyright (c) 2012 Bernát Kalló. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "plusminus"
+  gem.homepage = "http://github.com/cie/plusminus"
+  gem.license = "MIT"
+  gem.summary = %Q{A library that provides uncertainty and error propagation calculations for floats}
+  gem.description = %Q{A library that provides uncertainty and error propagation calculations for floats. It displays the appropriate number of digits when a number is outputted, can convert to latex using different formats.}
+  gem.email = "kallo.bernat@gmail.com"
+  gem.authors = ["Bernát Kalló"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "plusminus #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/plusminus.rb

@@ -0,0 +1,38 @@
+require "nio"
+
+module Plusminus
+end
+
+class Numeric
+  def pm delta
+    Plusminus::PlusminusFloat.new self, delta
+  end
+
+  def pm_rel rel
+    Plusminus::PlusminusFloat.new self, abs*rel
+  end
+
+  def to_pm
+    Plusminus::PlusminusFloat.new self, 0
+  end
+
+  def delta
+    0
+  end
+end
+
+
+class Float
+  def to_pm
+    Plusminus::PlusminusFloat.new self, 10.0**-Float::DIG
+  end
+
+  def delta
+    10**-Float::DIG
+  end
+end
+
+
+
+require File.expand_path File.dirname(__FILE__) + "/plusminus/plusminus_float.rb"
+

data/lib/plusminus/plusminus_float.rb

@@ -0,0 +1,160 @@
+class Plusminus::PlusminusFloat < Numeric
+
+  DEFAULT_FMT = Nio::Fmt.default.dup
+
+  def initialize value, delta
+    @value = value.to_f
+    @delta = delta.to_f.abs
+  end
+
+  attr_reader :value, :delta
+
+  def to_pm
+    self
+  end
+
+  def to_f
+    @value
+  end
+
+  def hash
+    @value.hash
+  end
+
+  def coerce other
+    case other
+    when Numeric
+      return other.to_pm, self
+    else
+      raise ArgumentError "#{other} cannot be coerced to #{self.class}"
+    end
+  end
+
+  def + other
+    other = other.to_pm
+    (@value + other.value).pm(@delta + other.delta)
+  end
+
+  def - other
+    other = other.to_pm
+    (@value - other.value).pm(@delta + other.delta)
+  end
+
+  def * other
+    other = other.to_pm
+    (self.value * other.value).pm(other.value.abs * self.delta + self.value.abs * other.delta)
+  end
+  
+  def / other
+    other = other.to_pm
+    (self.value / other.value).pm(self.delta / other.value.abs + other.delta * self.value.abs / other.value.abs**2)
+  end
+  
+  def ** other
+    return 1 if other == 0
+    return 0 if self == 0
+    other = other.to_pm
+    res = self.value ** other.value
+    res.pm(
+      (Math.log(self.value.abs) * res).abs * other.delta +
+      (other.value * res / self.value).abs * self.delta
+    )
+  end
+
+  def -@
+    (-@value).pm @delta
+  end
+
+  def abs
+    @value.abs
+  end
+
+  def == other
+    @value == other
+  end
+
+  def eql? other
+    return false unless other.is_a? self.class
+    self.value == other.value and self.delta == other.delta
+  end
+
+  def <=> other
+    self.value <=> other.to_pm.value
+  end
+
+  def === other
+    other = other.to_pm.value
+    @value-@delta < other and other < @value+@delta
+  end
+
+  # returns the Nio::Fmt to be used with the number. The returned object can be
+  # modified with Nio::Fmt's bang methods 
+  def fmt
+    unless defined? @fmt
+      @fmt = DEFAULT_FMT.dup
+      digits = sig_digits
+      case @value
+      when -0.01 ... 0.01 then 
+        @fmt.mode!(:sci, sig_digits)
+      else 
+        @fmt.mode!(:sig, sig_digits)
+      end
+    end
+
+    @fmt
+  end
+
+  # returns the number of significant digits
+  def sig_digits 
+    return 0 if @value == 0
+    return Float::DIG if @delta == 0
+    Math.log(@value.abs,10).floor + 1.9999 - Math.log(@delta*2,10)
+  end
+
+  # produces a string of the number with the appropriate number of decimal
+  # digits
+  def nio_write fmt=nil
+    @value.nio_write(fmt || self.fmt)
+  end
+
+  def to_s
+    @value.to_s
+  end
+
+  def inspect
+    "#{@value.inspect}.pm(#{delta.inspect})"
+  end
+
+  def to_latex fmt = nil
+    fmt ||= self.fmt
+    s = @value.nio_write(fmt || self.fmt)
+    percent = s =~ /%\z/
+    s.sub!(/%\z/, "")
+    mantissa, exponent = s.split(/e/i)
+    if exponent
+      exponent.sub!(/\A-0*/, "-").sub!(/\A0*/, "")
+      res = "#{mantissa}\\cdot 10^{#{exponent}}"
+    else
+      res = mantissa
+    end
+    res << "\\%" if percent
+    res.respond_to?(:latex!) ? res.latex! : res
+  end
+
+  def to_latex_pm
+    res = "#{to_latex} \\pm #{@delta.pm_rel(0.1).to_latex}"
+    res.respond_to?(:latex!) ? res.latex! : res
+  end
+
+  def to_latex_math_pm
+    res = "$#{to_latex_pm}$"
+    res.respond_to?(:latex!) ? res.latex! : res
+  end
+
+end
+
+# modified version of sqrt that uses **, to be able to coerce PlusminusFloat
+#
+def Math.sqrt x
+  x ** 0.5
+end

data/plusminus.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "plusminus"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bern\u{e1}t Kall\u{f3}"]
+  s.date = "2012-03-26"
+  s.description = "A library that provides uncertainty and error propagation calculations for floats. It displays the appropriate number of digits when a number is outputted, can convert to latex using different formats."
+  s.email = "kallo.bernat@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "a",
+    "lib/plusminus.rb",
+    "lib/plusminus/plusminus_float.rb",
+    "plusminus.gemspec",
+    "spec/plusminus_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/cie/plusminus"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "A library that provides uncertainty and error propagation calculations for floats"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nio>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<nio>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nio>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/plusminus_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Plusminus::PMFloat" do
+  specify "#nio_write" do
+    25.0. pm(1.0    /2).nio_write.should == "25"
+    25.5. pm(0.5    /2).nio_write.should == "25.5"
+    25.4. pm(0.2    /2).nio_write.should == "25.4"
+    25.4. pm(0.1    /2).nio_write.should == "25.4"
+    25.45.pm(0.05   /2).nio_write.should == "25.45"
+    25.44.pm(0.02   /2).nio_write.should == "25.44"
+    25.43.pm(0.01   /2).nio_write.should == "25.43"
+    25.435.pm(0.005 /2).nio_write.should == "25.435"
+    25.436.pm(0.002 /2).nio_write.should == "25.436"
+    25.435.pm(0.001 /2).nio_write.should == "25.435"
+    25.435.pm(0.0005/2).nio_write.should == "25.4350"
+    25.435.pm(0.0002/2).nio_write.should == "25.4350"
+    25.435.pm(0.0001/2).nio_write.should == "25.4350"
+    5.0. pm(1.0     /2).nio_write.should == "5"
+    5.5. pm(0.5     /2).nio_write.should == "5.5"
+    5.4. pm(0.2     /2).nio_write.should == "5.4"
+    5.4. pm(0.1     /2).nio_write.should == "5.4"
+    5.45.pm(0.05    /2).nio_write.should == "5.45"
+    5.44.pm(0.02    /2).nio_write.should == "5.44"
+    5.43.pm(0.01    /2).nio_write.should == "5.43"
+    5.435.pm(0.005  /2).nio_write.should == "5.435"
+    5.436.pm(0.002  /2).nio_write.should == "5.436"
+    5.435.pm(0.001  /2).nio_write.should == "5.435"
+    5.435.pm(0.0005 /2).nio_write.should == "5.4350"
+    5.435.pm(0.0002 /2).nio_write.should == "5.4350"
+    5.435.pm(0.0001 /2).nio_write.should == "5.4350"
+    0.5. pm(0.5     /2).nio_write.should == "0.5"
+    0.4. pm(0.2     /2).nio_write.should == "0.4"
+    0.4. pm(0.1     /2).nio_write.should == "0.4"
+    0.45.pm(0.05    /2).nio_write.should == "0.45"
+    0.44.pm(0.02    /2).nio_write.should == "0.44"
+    0.43.pm(0.01    /2).nio_write.should == "0.43"
+    0.435.pm(0.005  /2).nio_write.should =="0.435"
+    0.436.pm(0.002  /2).nio_write.should =="0.436"
+    0.435.pm(0.001  /2).nio_write.should =="0.435"
+    0.435.pm(0.0005 /2).nio_write.should =="0.4350"
+    0.435.pm(0.0002 /2).nio_write.should =="0.4350"
+    0.435.pm(0.0001 /2).nio_write.should =="0.4350"
+    0.05.pm(0.05    /2).nio_write.should == "0.05"
+    0.04.pm(0.02    /2).nio_write.should == "0.04"
+    0.03.pm(0.01    /2).nio_write.should == "0.03"
+    0.035.pm(0.005  /2).nio_write.should =="0.035"
+    0.036.pm(0.002  /2).nio_write.should =="0.036"
+    0.035.pm(0.001  /2).nio_write.should =="0.035"
+    0.035.pm(0.0005 /2).nio_write.should =="0.0350"
+    0.035.pm(0.0002 /2).nio_write.should =="0.0350"
+    0.035.pm(0.0001 /2).nio_write.should =="0.0350"
+  end
+
+  specify "#pm_rel" do
+    (5.43.pm_rel 0.1).delta.should == 0.543
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'plusminus'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: plusminus
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Bernát Kalló
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nio
+  requirement: &82980140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *82980140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &82979800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *82979800
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &82979370 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *82979370
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &82979050 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *82979050
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &82978510 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *82978510
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &82978150 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82978150
+description: A library that provides uncertainty and error propagation calculations
+  for floats. It displays the appropriate number of digits when a number is outputted,
+  can convert to latex using different formats.
+email: kallo.bernat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- a
+- lib/plusminus.rb
+- lib/plusminus/plusminus_float.rb
+- plusminus.gemspec
+- spec/plusminus_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cie/plusminus
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -573010513
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A library that provides uncertainty and error propagation calculations for
+  floats
+test_files: []