einsum 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fa002f0b200d3640b0498fe7723dc99f41acfdd37f428b4d01ca0807c775add
+  data.tar.gz: 37be8a20da6001f0fd6272f6cf7868acd37ddd6f4ac484b835c07c60f2d6e5f6
+SHA512:
+  metadata.gz: a3558fe0cfca9c10b9aed8ec0c8e5683c683bc0df1d0ae793f407ae150b336ceaaecf73075406c0b69a344f56ff70f47ba3df0cae90c129b58f728dc4e2a3e82
+  data.tar.gz: 7fdedaa75471458b7758c0fdf8cc3480b2709426a0297ccfcfe4aca63fb3a86b51aaf6dcaf4764c146b16630185441cd1b9e16fe567192d2615af077dcd5dd82

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.5
+Style/IfUnlessModifier:
+  Enabled: false
+Metrics:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## [v0.1.1](https://github.com/toddsundsted/einsum/tree/v0.1.1) (2019-02-10)
+
+**Initial Release**

data/Gemfile

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+ruby '2.5.1'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    einsum (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 10.0)
+  einsum!
+  pry (~> 0.12)
+  rake (~> 12.3)
+  rspec (~> 3.8)
+  rubocop (~> 0.63)
+
+RUBY VERSION
+   ruby 2.5.1p57
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Todd Sundsted
+
+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,61 @@
+# Einsum
+
+Unoptimized, pure-Ruby implementation of a subset of Numpy `einsum`.
+
+See: https://docs.scipy.org/doc/numpy/reference/generated/numpy.einsum.html
+
+## Installation
+
+Add this to your application's Gemfile:
+
+```ruby
+gem 'einsum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it manually:
+
+    $ gem install einsum
+
+## Usage
+
+Evaluates the (extended) Einstein summation convention on the operands.
+
+Operands must be `Array` like. Array elements must respond to `*` and `+`.
+
+Implicit mode:
+
+    Einsum.einsum('ij,jk', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => dot product: [[7, 10], [15, 22]]
+    Einsum.einsum('ij,kj', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => inner product: [[ 5, 11], [11, 25]]
+
+Explicit mode:
+
+    Einsum.einsum('ij,jk->ik', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => dot product: [[7, 10], [15, 22]]
+    Einsum.einsum('ij,kj->ik', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => inner product: [[ 5, 11], [11, 25]]
+    Einsum.einsum('ij,jk->', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => 54
+    Einsum.einsum('ij,kj->', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => 52
+
+## Development
+
+After checking out the repository, run `bin/setup` to install
+dependencies. Run `bin/console` for an interactive prompt. Run `rake
+spec` to run the tests.
+
+To install this gem locally, 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/toddsundsted/einsum).
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'einsum'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/einsum.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'einsum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'einsum'
+  spec.version       = Einsum::VERSION
+  spec.authors       = ['Todd Sundsted']
+  spec.email         = ['todd@sumall.com']
+
+  spec.summary       = 'Unoptimized, pure-Ruby implementation of a subset of Numpy `einsum`.'
+  spec.homepage      = 'https://github.com/toddsundsted/einsum'
+  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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0.63'
+end

data/lib/einsum.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'einsum/version'
+
+##
+# Unoptimized, pure-Ruby implementation of a subset of Numpy `einsum`.
+#
+# See: https://docs.scipy.org/doc/numpy/reference/generated/numpy.einsum.html
+#
+class Einsum
+  FormatError = Class.new(StandardError)
+
+  Label = Struct.new(:dimension, :count) do
+    def initialize(dimension, count = 0)
+      super(dimension, count)
+    end
+
+    def increment
+      self.count += 1
+    end
+  end
+
+  class << self
+    ##
+    # Evaluates the (extended) Einstein summation convention on the operands.
+    #
+    # Operands must be `Array` like. Array elements must respond to `*` and `+`.
+    #
+    # Examples:
+    #
+    #   In implicit mode:
+    #
+    #     `Einsum.einsum('ij,jk', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => dot product: [[7, 10], [15, 22]]`
+    #     `Einsum.einsum('ij,kj', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => inner product: [[ 5, 11], [11, 25]]`
+    #
+    #   In explicit mode:
+    #
+    #     `Einsum.einsum('ij,jk->ik', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => dot product: [[7, 10], [15, 22]]`
+    #     `Einsum.einsum('ij,kj->ik', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => inner product: [[ 5, 11], [11, 25]]`
+    #     `Einsum.einsum('ij,jk->', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => 54`
+    #     `Einsum.einsum('ij,kj->', [[1, 2], [3, 4]], [[1, 2], [3, 4]]) # => 52`
+    #
+    def einsum(format, *operands)
+      labels = {}
+
+      # check syntax of format string
+      unless format.match?(/\A([a-z]+(,[a-z]+)*)(->[a-z]*)?\z/)
+        raise FormatError, "invalid format: #{format}"
+      end
+
+      # chop up format string
+      inputs, explicit, output = format.partition('->')
+      inputs = inputs.split(',')
+      if operands.length != inputs.length
+        raise FormatError, "provides #{operands.length} operands for #{inputs.length} input labels strings"
+      end
+
+      # check labels and operands
+      inputs.zip(operands).each.with_index do |(input, operand), pos|
+        input.split('').each.with_index do |label, axis|
+          unless (dim = dim(operand, axis))
+            raise FormatError, "no axis in operand #{pos} corresponds to label #{label}"
+          end
+          if labels[label] && labels[label].dimension != dim
+            raise FormatError, "inconsistent dimension for label #{label}: #{labels[label].dimension} and #{dim}"
+          end
+
+          labels[label] ||= Label.new(dim)
+          labels[label].increment
+        end
+      end
+
+      # if implicit mode, generate output labels string from all
+      # labels mentioned only once in the input labels strings
+      if explicit.empty? && (groups = labels.group_by { |_, l| l.count }[1])
+        output = groups.map(&:first).sort.join
+      end
+
+      # compute shape of the result
+      shape = []
+      output.split('').each do |label|
+        unless labels[label]
+          raise FormatError, "output label #{label} not present in input labels"
+        end
+
+        shape << labels[label].dimension
+      end
+
+      # generate template for result
+      result = 0
+      unless shape.empty?
+        result = empty(shape, result)
+      end
+
+      # generate code for the specified operations. first, loop over
+      # each output axis in the order specified by the output labels.
+      # then, loop over the remaining input axes and compute the
+      # result for each cell in the output matrix.
+
+      code = []
+      internal = inputs.join.split('').sort.uniq - output.split('')
+      external = output.split('')
+
+      external.each do |label|
+        code.push("#{labels[label].dimension}.times do |#{label}|")
+      end
+
+      internal.each do |label|
+        code.push("#{labels[label].dimension}.times do |#{label}|")
+      end
+
+      external_labels = external.map { |l| "[#{l}]" }.join
+      code.push("result#{external_labels} +=")
+
+      inputs.each.with_index do |input, i|
+        input_labels = input.split('').map { |l| "[#{l}]" }.join
+        suffix = i < inputs.length - 1 ? ' *' : ''
+        code.push("operands[#{i}]#{input_labels}#{suffix}")
+      end
+
+      internal.each do
+        code.push('end')
+      end
+
+      external.each do
+        code.push('end')
+      end
+
+      # evaluate the generated code in the current context. this would
+      # be considered dangerous, except we are in control of generated
+      # code except loop variable names, which are derived from input
+      # and output labels, which are constrained to be individual,
+      # lowercase characters, which are bound in their respective
+      # loops.
+
+      # rubocop:disable Security/Eval
+      binding.eval(code.join("\n"))
+      # rubocop:enable Security/Eval
+
+      result
+    end
+
+    private
+
+    def dim(array, axis)
+      array =
+        if axis.positive?
+          array.dig(*Array.new(axis, 0))
+        else
+          array
+        end
+      begin
+        array.length
+      rescue NoMethodError
+        nil
+      end
+    end
+
+    def clone(array)
+      if array.respond_to?(:each)
+        array.map { |item| clone(item) }
+      else
+        array
+      end
+    end
+
+    def empty(shape, seed)
+      i, *shape = shape
+      seed = empty(shape, seed) unless shape.empty?
+      Array.new(i) { clone(seed) }
+    end
+  end
+end

data/lib/einsum/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Einsum
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: einsum
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Todd Sundsted
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+description: 
+email:
+- todd@sumall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- einsum.gemspec
+- lib/einsum.rb
+- lib/einsum/version.rb
+homepage: https://github.com/toddsundsted/einsum
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Unoptimized, pure-Ruby implementation of a subset of Numpy `einsum`.
+test_files: []