differentiation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f77d01605afbbd8c64d7a36c2f0f88540846c4c103a3bd97b98d493abded3cf
+  data.tar.gz: 2049debc4169d0b1f214517475e5864775932afa6e3a02aad27029be0ee97483
+SHA512:
+  metadata.gz: 11ee0a83cf38b016b79004723a966d82651b24bb459d7fe4dfd55e1fe3a18c9a80d58155ce8cfe2e84870467833c6e5d01edb4bd0cb6707822df113dafef86b2
+  data.tar.gz: 97fee6518f5abd937ec55d2361b8359b850743fee62324a3c41ab817bbf7c6dadfa91c6eb8e639fe243a261e250d02e8ce905150ec0894caf755e8719d3a77fd

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in differentiation.gemspec
+gemspec
+
+gem "simplecov"
+gem "pry"

data/README.md

@@ -0,0 +1,41 @@
+# Differentiation
+
+differentiation.gem make ruby numeric Method/Proc differentiable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'differentiation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install differentiation
+
+## Usage
+
+```
+require "differentiation"
+
+differential def f(x, y)
+  (x + 1) * (y - 2)
+end
+
+
+result = f(1, 2)
+
+p result  # => -2
+
+p result.gradients(:x, :y) # => {:x=>1, :y=>0}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nagachika/differentiation.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "differentiation"
+
+# 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

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/differentiation.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'differentiation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "differentiation"
+  spec.version       = Differentiation::VERSION
+  spec.authors       = ["nagachika"]
+  spec.email         = ["nagachika@ruby-lang.org"]
+
+  spec.summary       = %q{Make Ruby Differentiable.}
+  spec.description   = %q{differentiation.gem implement a kind of Automatic differentiation algorithm. It can convert Method/Proc to differentiable version.}
+  spec.homepage      = "https://github.com/nagachika/differentiation"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+end

data/lib/differentiation/ext/kernel.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kernel
+  def differential(m)
+    if m.is_a?(Symbol)
+      f = self.method(m)
+    elsif m.is_a?(Proc) or m.is_a?(Method)
+      f = m
+    else
+      raise TypeError, "differential requires Method/Proc/Symbol argument."
+    end
+    f = Differentiation.differential(f)
+    if m.is_a?(Symbol)
+      if self.is_a?(Module)
+        self.define_method(m, f)
+      else
+        self.define_singleton_method(m, f)
+      end
+    end
+    f
+  end
+end
+

data/lib/differentiation/version.rb

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

data/lib/differentiation.rb

@@ -0,0 +1,154 @@
+# fronzen_string_literal: true
+
+module Differentiation
+
+  def self.differentiable?(o)
+    # TODO: support Vector and Matrix
+    o.is_a?(Numeric)
+  end
+
+  def self.convert_to_dual_number(o, key: nil)
+    if o.is_a?(DualNumber)
+      o
+    elsif differentiable?(o)
+      DualNumber.new(o, lambda{|_key| _key == key ? 1 : 0})
+    else
+      o
+    end
+  end
+
+  def self.differential(f)
+    unless f.is_a?(Proc) or f.is_a?(Method)
+      raise TypeError, "Only Proc or Method can be differentiable"
+    end
+
+    # [[:req, :x], [:req, :y], [:opt, :c], [:rest, :rest], [:keyreq, :k2], [:key, :k1], [:keyrest, :kw]]
+    parameters = f.parameters
+    positional = []
+    parameters.each do |tuple|
+      if [:req, :opt].include?(tuple[0])
+        positional << tuple[1]
+      elsif [:key, :keyreq, :kwrest].include?(tuple[0])
+      else
+        # TODO: support rest arguments
+        raise "rest arguments are currently not supported"
+      end
+    end
+    f_prime = lambda {|*args, **kwargs|
+      args.map!.with_index do |a, i|
+        Differentiation.convert_to_dual_number(a, key: positional[i])
+      end
+      kwargs = Hash[kwargs.map{|k,v| [k, Differentiation.convert_to_dual_number(v, key: k)] }]
+      if kwargs.empty?
+        f.call(*args)
+      else
+        f.call(*args, **kwargs)
+      end
+    }
+  end
+
+  class DualNumber
+    def initialize(n, diff=lambda{|_| 0})
+      @n = n
+      @diff = diff
+    end
+
+    attr_reader :n, :diff
+
+    def derivative(key)
+      @diff.call(key)
+    end
+
+    def gradients(*keys)
+      keys.each_with_object({}) do |k, o|
+        o[k] = @diff.call(k)
+      end
+    end
+
+    def to_i
+      @n.to_i
+    end
+
+    def to_int
+      @n.to_int
+    end
+
+    def to_f
+      @n.to_f
+    end
+
+    def coerce(other)
+      if Differentiation.differentiable?(other)
+        [DualNumber.new(other), self]
+      else
+        super
+      end
+    end
+
+    def +(other)
+      if other.is_a?(DualNumber)
+        n = @n + other.n
+        diff = ->(key) { @diff.call(key) + other.diff.call(key) }
+      else
+        n = @n + other
+        diff = @diff
+      end
+      DualNumber.new(n, diff)
+    end
+
+    def -(other)
+      if other.is_a?(DualNumber)
+        n = @n - other.n
+        diff = ->(key) { @diff.call(key) - other.diff.call(key) }
+      else
+        n = @n - other
+        diff = @diff
+      end
+      DualNumber.new(n, diff)
+    end
+
+    def *(other)
+      if other.is_a?(DualNumber)
+        n = @n * other.n
+        diff = ->(key) { @n * other.diff.call(key) + @diff.call(key) * other.n }
+      else
+        n = @n * other
+        diff = ->(key) { @diff.call(key) * other }
+      end
+      DualNumber.new(n, diff)
+    end
+
+    def /(other)
+      if other.is_a?(DualNumber)
+        n = @n / other.n
+        diff = ->(key) { (@diff.call(key) / other) + (@n * other.diff.call(key)) / (other.n ** 2) }
+      else
+        n = @n / other
+        diff = ->(key) { @diff.call(key) / other }
+      end
+      DualNumber.new(n, diff)
+    end
+
+    def **(other)
+      if other.is_a?(DualNumber)
+        n = @n ** other.n
+        diff = ->(key) { (@n ** other.n) * (other.diff(key) * Math.log(@n) + (other.n / @n)) }
+      else
+        n = @n ** other
+        diff = ->(key) { (@n ** (other-1)) * other }
+      end
+      DualNumber.new(n, diff)
+    end
+
+    def inspect
+      if $DEBUG
+        "<DualNumber: #{@n} >"
+      else
+        @n.inspect
+      end
+    end
+  end
+end
+
+require "differentiation/ext/kernel"
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: differentiation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nagachika
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-17 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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'
+description: differentiation.gem implement a kind of Automatic differentiation algorithm.
+  It can convert Method/Proc to differentiable version.
+email:
+- nagachika@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- differentiation.gemspec
+- lib/differentiation.rb
+- lib/differentiation/ext/kernel.rb
+- lib/differentiation/version.rb
+homepage: https://github.com/nagachika/differentiation
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Make Ruby Differentiable.
+test_files: []