numeric_inverse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6812f73ad5b41503887625a8f56000c69998949545fe730cfe4e2f914ea656b6
+  data.tar.gz: a81ca2caa95703d0831a27e429546e7cfbb24d71b8536fb376b6a24e168a6ac7
+SHA512:
+  metadata.gz: 0dcc87bd3d88f0569b2ec72ff895b484f64eda6107dff9df584f79597465a10a3c2d1b5320913203b1043f2e740e28103b333001522f49ad58d03a20c25d0384
+  data.tar.gz: ca5d98880c6546f7ca6b89ee50535b676e584fbe3038703b21fb1a5daa264d32ae66e4be6ae264cf9cffef436ca94b13faf9b87e1145333feb45ead1b78a9664

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in numeric_inverse.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Masahiro Nomoto
+
+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,73 @@
+# NumericInverse
+
+This gem provides a method `Numeric#inverse` to get a (usual/modular) **multiplicative inverse** of a number readily.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'numeric_inverse'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install numeric_inverse
+
+## Usage
+
+The module `NumericInverse` uses "[refinements](https://docs.ruby-lang.org/en/trunk/syntax/refinements_rdoc.html)" to define `#inverse` (alias `#inv`) locally.  You should activate them with `Module#using` or `main.using`.
+
+If you want to define them globally (without refinements), please require `numeric_inverse/ext` instead.
+
+```ruby
+require "numeric_inverse"
+p Rational(7, 22).inv   #=> NoMethodError
+
+using NumericInverse
+p Rational(7, 22).inv   #=> (22/7)
+p Integer(16).inv       #=> (1/16)
+p Float(16).inv         #=> 0.0625
+p Complex(3, 4).inv     #=> ((3/25)-(4/25)*i)
+
+# arithmetic mean and harmonic mean
+a = [9, 10, 15, 18]
+p a.sum.quo(a.size)           #=> (13/1)
+p a.sum(&:inv).inv * a.size   #=> (12/1)
+```
+
+In addition, `Integer#inverse` returns its [modular multiplicative inverse](https://en.wikipedia.org/wiki/Modular_multiplicative_inverse) when a modulus is given.
+
+```ruby
+require "numeric_inverse"
+using NumericInverse
+
+# multiplicative inverse of integers
+p 63.inv        #=> (1/63)
+p 63.inv * 63   #=> (1/1)
+
+# modular multiplicative inverse
+p 63.inv(100)              #=> 27
+p 63.inv(100) * 63         #=> 1701
+p 63.inv(100) * 63 % 100   #=> 1
+
+p 64.inv(100)   #=> ArgumentError: modulus 100 is not coprime to 64
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hmmnrst/numeric_inverse.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "numeric_inverse"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/numeric_inverse/ext/integer.rb

@@ -0,0 +1,46 @@
+##
+# @!parse class Integer < Numeric; end
+#
+class Integer
+	##
+	# Returns its inverse.
+	#
+	# @overload inverse
+	#   @return [Rational] inverse
+	# @overload inverse(m)
+	#   @param m [Integer] modulus
+	#   @return [Integer] modular multiplicative inverse
+	#   @raise [ArgumentError] if +m+ is not coprime to +self+
+	#
+	# @example
+	#   63.inv        #=> (1/63)
+	#   63.inv * 63   #=> (1/1)
+	#
+	#   63.inv(100)              #=> 27
+	#   63.inv(100) * 63         #=> 1701
+	#   63.inv(100) * 63 % 100   #=> 1
+	#
+	#   64.inv(100)   #=> ArgumentError: modulus 100 is not coprime to 64
+	#
+	def inverse(m = nil)
+		return Rational(1, self) if m.nil?
+
+		# extended Euclidean algorithm
+		a, b, x, x0 = self, m, 1, 0
+		until b.zero?
+			a, (q, b) = b, a.divmod(b)
+			x, x0 = x0, x - q * x0
+		end
+
+		# x is an inverse iff self.gcd(m) == 1
+		if a.abs != 1
+			raise ArgumentError,
+			      "modulus #{m} is not coprime to #{self}"
+		end
+
+		x = -x if a < 0
+		x % m.abs   # 0 <= x < |m|
+	end
+
+	alias inv inverse
+end

data/lib/numeric_inverse/ext/numeric.rb

@@ -0,0 +1,18 @@
+class Numeric
+	##
+	# Returns its inverse.
+	#
+	# @return [Numeric] inverse
+	#
+	# @example
+	#   Rational(7, 22).inv   #=> (22/7)
+	#   Integer(16).inv       #=> (1/16)
+	#   Float(16).inv         #=> 0.0625
+	#   Complex(3, 4).inv     #=> ((3/25)-(4/25)*i)
+	#
+	def inverse
+		1.quo(self)
+	end
+
+	alias inv inverse
+end

data/lib/numeric_inverse/ext.rb

@@ -0,0 +1,2 @@
+require "numeric_inverse/ext/numeric"
+require "numeric_inverse/ext/integer"

data/lib/numeric_inverse/version.rb

@@ -0,0 +1,3 @@
+module NumericInverse
+	VERSION = "0.1.0"
+end

data/lib/numeric_inverse.rb

@@ -0,0 +1,39 @@
+require "numeric_inverse/version"
+
+##
+# Provides refinements of a method +Numeric#inverse+
+# to get a (usual/modular) multiplicative inverse of a number readily.
+#
+module NumericInverse
+	refine Numeric do
+		def inverse
+			1.quo(self)
+		end
+
+		alias inv inverse
+	end
+
+	refine Integer do
+		def inverse(m = nil)
+			return Rational(1, self) if m.nil?
+
+			# extended Euclidean algorithm
+			a, b, x, x0 = self, m, 1, 0
+			until b.zero?
+				a, (q, b) = b, a.divmod(b)
+				x, x0 = x0, x - q * x0
+			end
+
+			# x is an inverse iff self.gcd(m) == 1
+			if a.abs != 1
+				raise ArgumentError,
+				      "modulus #{m} is not coprime to #{self}"
+			end
+
+			x = -x if a < 0
+			x % m.abs   # 0 <= x < |m|
+		end
+
+		alias inv inverse
+	end
+end

data/numeric_inverse.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "numeric_inverse/version"
+
+Gem::Specification.new do |spec|
+	spec.name          = "numeric_inverse"
+	spec.version       = NumericInverse::VERSION
+	spec.authors       = ["Masahiro Nomoto"]
+	spec.email         = ["hmmnrst@users.noreply.github.com"]
+
+	spec.summary       = %q{Define `Numeric#inverse` to return its multiplicative inverse}
+	spec.description   = %q{This gem provides a method `Numeric#inverse` to get a (usual/modular) multiplicative inverse of a number readily.}
+	spec.homepage      = "https://github.com/hmmnrst/numeric_inverse"
+	spec.license       = "MIT"
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	end
+	spec.bindir        = "exe"
+	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: numeric_inverse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masahiro Nomoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem provides a method `Numeric#inverse` to get a (usual/modular)
+  multiplicative inverse of a number readily.
+email:
+- hmmnrst@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/numeric_inverse.rb
+- lib/numeric_inverse/ext.rb
+- lib/numeric_inverse/ext/integer.rb
+- lib/numeric_inverse/ext/numeric.rb
+- lib/numeric_inverse/version.rb
+- numeric_inverse.gemspec
+homepage: https://github.com/hmmnrst/numeric_inverse
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Define `Numeric#inverse` to return its multiplicative inverse
+test_files: []