pretty_round 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 715c35c7f940f136ab635fefb6f253f72ce4e712
+  data.tar.gz: 6ff79a9c50c397001a2f12ac00d7076d03316162
+SHA512:
+  metadata.gz: 6987805eeb0bb0183f77ef2a5605d8da58e5dcf5bc030548681269ddc36d93f9cb491de404d66626f5228100a321cef8c70c7c24fb8fe192d5ca696517deed77
+  data.tar.gz: c4e508d1aaec2a2fa399ad5fdf597088d1d7407b5640ff852bb06237a48b1f97de66848725b9f643cb0bb4ab689f248d540e544ee94ce2ec9b90bfea49f91aa3

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 diaphragm
+
+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.md

@@ -0,0 +1,70 @@
+ruby-pretty-round
+================
+This gem add useful numerical rounding methods to `Numeric` class as shown below...
+- round to nearest multiple
+- round with significant digits
+
+Install
+================
+`$ gem install pretty_round`
+
+Usage
+================
+```rb
+require "pretty_round"
+
+x = 123.456
+
+# round with precision
+x.round(2) #=> 123.46 (ruby built-in)
+x.roundup(2) #=> 123.46
+x.rounddown(2) #=> 123.45
+
+# round to nearest multiple
+x.mroundup(10) #=> 130
+x.mrounddown(0.01) #=> 123.45
+x.mround(50) #=> 100
+x.mround(0.02) #=> 123.46
+
+# round with significant digit
+x.sround(2) #=> 120
+x.sround(4) #=> 123.5
+```
+
+Rounding direction
+================
+
+`#roundup`, `#mroundup`
+----------------
+These methods round up to the positive infinity direction.
+```rb
+ 1.9.mroundup(1) #=> 2
+ 1.1.mroundup(1) #=> 2
+-1.1.mroundup(1) #=> -1
+-1.9.mroundup(1) #=> -1
+```
+
+`#rounddown`, `#mrounddown`
+----------------
+These methods round down to the negative infinity direction.
+```rb
+ 1.9.mrounddown(1) #=> 1
+ 1.1.mrounddown(1) #=> 1
+-1.1.mrounddown(1) #=> -2
+-1.9.mrounddown(1) #=> -2
+```
+
+`#mround`, `#sround`
+----------------
+These methods round off the absolute value, dos not round even.
+```rb
+ 1.9.mround(1) #=> 2
+ 1.1.mround(1) #=> 1
+-1.1.mround(1) #=> -1
+-1.9.mround(1) #=> -2
+```
+
+----
+Also, try to run `examples/example.rb`
+
+

data/examples/example.rb

@@ -0,0 +1,39 @@
+
+require "pretty_round"
+
+xs = %w[2.1 2.5 2.9 -2.1 -2.5 -2.9].map(&:to_r)
+ns = %w[0.1 0.2 1 2 -0.1 -0.2 -1 -2].map(&:to_r)
+
+header = " "*6  + "|" + ns.map{|x| x.to_f.to_s.rjust(6)}.join + "\n" + "-"*(6+1+6*ns.size)
+
+puts "#mroundup"
+puts header
+xs.each do |x|
+  puts ("%6.1f"%x) + "|" + ns.map{|n| x.mroundup(n)}.map{|n| ("%6.1f"%n)}.join
+end
+puts
+
+puts "#mrounddown"
+puts header
+xs.each do |x|
+  puts ("%6.1f"%x) + "|" + ns.map{|n| x.mrounddown(n)}.map{|n| ("%6.1f"%n)}.join
+end
+puts
+
+puts "#mround"
+puts header
+xs.each do |x|
+  puts ("%6.1f"%x) + "|" + ns.map{|n| x.mround(n)}.map{|n| ("%6.1f"%n)}.join
+end
+puts
+
+
+puts "#sround"
+xs = [0.1234, 12.34, 1234, -0.1234, -12.34, -1234]
+ns = [*-1..5]
+puts " "*10  + "|" + ns.map{|x| x.to_s.center(10)}.join
+puts "-"*(10+1+10*ns.size)
+xs.each do |x|
+  puts ("% 10.4f"%x) + "|" + ns.map{|n| x.sround(n)}.map{|n| ("% 10.4f"%n)}.join
+end
+

data/lib/pretty_round.rb

@@ -0,0 +1,49 @@
+
+class Numeric
+  # Ceiling with given precision.
+  def roundup(d=0)
+    x = 10**(-d)
+    self.quo(x).ceil * x
+  end
+
+  # Flooring with given precision.
+  def rounddown(d=0)
+    x = 10**(-d)
+   self.quo(x).floor * x
+  end
+  
+  
+  # Return nearest multiple of given number that is equal to or greater than self.
+  # This method round up to the positive infinity direction.
+  def mroundup(num)
+    div, mod = divmod(num)
+    x = num * div; y = x + (mod.zero? ? 0 : num)
+    [x, y].max
+  end
+  
+  # Return nearest multiple of given number that is equal to or less than self.
+  # This method round down to the negative infinity direction.
+  def mrounddown(num)
+    div, mod = divmod(num)
+    x = num * div; y = x + (mod.zero? ? 0 : num)
+    [x, y].min
+  end
+  
+  # Retuen nearest multiple of given number.
+  # When self is median of multiple of given number, return the multiple that have greater absolute.
+  def mround(num)
+    div, mod = divmod(num)
+    x = num * div; y = x + (mod.zero? ? 0 : num)
+    if mod.quo(num).abs * 2 == 1
+      [x, y].max_by(&:abs)
+    else
+      [x, y].min_by{|t| (t - self).abs}
+    end
+  end
+  
+  # Rounding with given significant digit.
+  def sround(digit, base=10)
+    numdigit = Math.log(abs, base).floor + 1
+    mround(base**(numdigit-digit))
+  end
+end

data/test/test_pretty_round.rb

@@ -0,0 +1,113 @@
+require 'minitest'
+require 'pretty_round'
+
+Minitest.autorun
+
+class TEST_PrettyRound < Minitest::Test
+  def assert_ep(expect, target)
+    assert_in_epsilon(expect, target, Float::EPSILON)
+  end
+  
+  def test_roundup
+    assert_ep  2,  1.9.roundup
+    assert_ep  2,  1.1.roundup
+    assert_ep -1, -1.1.roundup
+    assert_ep -1, -1.9.roundup
+    
+    x = 123.456
+    assert_ep 124, x.roundup
+    assert_ep 123.46, x.roundup(2)
+    assert_ep 200, x.roundup(-2)
+    
+    x = -123.456
+    assert_ep -123, x.roundup
+    assert_ep -123.45, x.roundup(2)
+    assert_ep -100, x.roundup(-2)
+  end
+  
+  def test_rounddown
+    assert_ep  1,  1.9.rounddown
+    assert_ep  1,  1.1.rounddown
+    assert_ep -2, -1.1.rounddown
+    assert_ep -2, -1.9.rounddown
+    
+    x = 123.456
+    assert_ep 123, x.rounddown
+    assert_ep 123.45, x.rounddown(2)
+    assert_ep 100, x.rounddown(-2)
+    
+    x = -123.456
+    assert_ep -124, x.rounddown
+    assert_ep -123.46, x.rounddown(2)
+    assert_ep -200, x.rounddown(-2)
+  end
+  
+  def test_mroundup
+    assert_ep  2,  1.9.mroundup(1)
+    assert_ep  2,  1.1.mroundup(1)
+    assert_ep -1, -1.1.mroundup(1)
+    assert_ep -1, -1.9.mroundup(1)
+    
+    x = 123.456
+    assert_ep 124, x.mroundup(-1)
+    assert_ep 123.46, x.mroundup(-0.01)
+    assert_ep 200, x.mroundup(100)
+    
+    x = -123.456
+    assert_ep -123, x.mroundup(-1)
+    assert_ep -123.45, x.mroundup(-0.01)
+    assert_ep -100, x.mroundup(100)
+  end
+  
+  def test_mrounddown
+    assert_ep  1,  1.9.mrounddown(1)
+    assert_ep  1,  1.1.mrounddown(1)
+    assert_ep -2, -1.1.mrounddown(1)
+    assert_ep -2, -1.9.mrounddown(1)
+    
+    x = 123.456
+    assert_ep 123, x.mrounddown(-1)
+    assert_ep 123.45, x.mrounddown(-0.01)
+    assert_ep 100, x.mrounddown(100)
+    
+    x = -123.456
+    assert_ep -124, x.mrounddown(-1)
+    assert_ep -123.46, x.mrounddown(-0.01)
+    assert_ep -200, x.mrounddown(100)
+  end
+  
+  def test_mround
+    assert_ep  2,  1.9.mround(1)
+    assert_ep  1,  1.1.mround(1)
+    assert_ep -1, -1.1.mround(1)
+    assert_ep -2, -1.9.mround(1)
+    
+    x = 123.456
+    assert_ep 123, x.mround(-1)
+    assert_ep 123.46, x.mround(-0.01)
+    assert_ep 100, x.mround(100)
+    
+    x = -123.456
+    assert_ep -123, x.mround(-1)
+    assert_ep -123.46, x.mround(-0.01)
+    assert_ep -100, x.mround(100)
+  end
+  
+  def test_sround
+    x = 123.456
+    assert_ep 0, x.sround(-1)
+    assert_ep 0, x.sround(0)
+    assert_ep 100, x.sround(1)
+    assert_ep 123, x.sround(3)
+    assert_ep 123.5, x.sround(4)
+    assert_ep 123.456, x.sround(6)
+    
+    x = -123.456
+    assert_ep 0, x.sround(-1)
+    assert_ep 0, x.sround(0)
+    assert_ep -100, x.sround(1)
+    assert_ep -123, x.sround(3)
+    assert_ep -123.5, x.sround(4)
+    assert_ep -123.456, x.sround(6)
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: pretty_round
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- diaphragm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-21 00:00:00.000000000 Z
+dependencies: []
+description: This gem provide useful numerical rounding methods.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- examples/example.rb
+- lib/pretty_round.rb
+- test/test_pretty_round.rb
+homepage: https://github.com/diaphragm/ruby-pretty-round
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: pretty rounding methods library
+test_files: []