amor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9946bfd005825741713196a3110508269ffa7a9
+  data.tar.gz: be143fbccb12ad889d1d38a7258e09aa72ca7000
+SHA512:
+  metadata.gz: b531b2c9eef38a50945bec9c88b7bb2a49f7caeb6a2d53e3479fbb8ca6566d7079c837a2435247a86869a95b9833f4ca263cd03136171dc28e4deb81db2846bd
+  data.tar.gz: f46962ea18edfd428084acdfe9b9b4474cee93bf3d9f3afead1f03c7d94bb6b6a70155bb08175b62c0cfdeeeca6d608607de876ab2375d07fe1fdafc67f9587f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Florian Dahms
+
+MIT License
+
+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,29 @@
+# AMoR: Amazing Modelling with Ruby
+
+The modelling language you will fall in love with.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'amor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/philosophus/amor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/amor.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amor"
+  spec.version       = Amor::VERSION
+  spec.authors       = ["Florian Dahms"]
+  spec.email         = ["me@fdahms.com"]
+  spec.summary       = "A versatile, yet simple modelling language for mathematical programming"
+  spec.description   = "AMoR is a Ruby DSL for mathematical programming. It allows to simply define a mathematical program, but gives you all the features from Ruby for more complex projects"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "require_all"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
+end

data/amor.sublime-project

@@ -0,0 +1,14 @@
+{
+	"folders":
+	[
+		{
+			"follow_symlinks": true,
+			"path": "."
+		}
+	],
+  "settings": {
+    "tab_size": 2,
+    "translate_tabs_to_spaces": true,
+    "trim_trailing_white_space_on_save": true
+  }
+}

data/bin/amor

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'amor'
+
+Amor::Model.from_file(ARGV[0])

data/lib/amor/constraint.rb

@@ -0,0 +1,37 @@
+module Amor
+  class Constraint
+    attr_reader :lhs, :rhs, :relation
+
+    def initialize(lhs, relation, rhs)
+      @lhs = Expression.new(lhs)
+      @rhs = Expression.new(rhs)
+      @relation = relation
+    end
+
+    def lp_string
+      temp_lhs = (@lhs - @rhs).simplified
+      relation_string = case @relation
+        when :greater_equal
+          ">="
+        when :lesser_equal
+          "<="
+        else
+          "="
+        end
+
+      "#{temp_lhs.remove_constants.lp_string} #{relation_string} #{-temp_lhs.constant_factor}"
+    end
+
+    def to_s
+      relation_string = case @relation
+        when :greater_equal
+          ">="
+        when :lesser_equal
+          "<="
+        else
+          "=="
+        end
+      "#{@lhs} #{relation_string} #{@rhs}"
+    end
+  end
+end

data/lib/amor/expression.rb

@@ -0,0 +1,92 @@
+module Amor
+  class Expression
+
+    attr_reader :factors
+
+    def initialize(value)
+      if value.is_a? Array
+        @factors = value
+      elsif value.is_a? Expression
+        @factors = value.factors
+      elsif value.is_a? Variable
+        @factors = [[1, value]]
+      elsif value.is_a? Numeric
+        @factors = [[value, :constant]]
+      end
+    end
+
+    def +(value)
+      Expression.new(self.factors + Expression.new(value).factors)
+    end
+
+    def -(value)
+      self + -value
+    end
+
+    def -@
+      return Expression.new(self.factors.map{|factor| [-factor[0], factor[1]]})
+    end
+
+    def hash
+      @factors.hash
+    end
+
+    def eql? value
+      self.hash == value.hash
+    end
+
+    def == value
+      Constraint.new(self, :equal, value)
+    end
+
+    def <= value
+      Constraint.new(self, :lesser_equal, value)
+    end
+
+    def >= value
+      Constraint.new(self, :greater_equal, value)
+    end
+
+    def simplified
+      summed_scalars = Hash.new
+      @factors.each do |factor|
+        summed_scalars[factor[1]] = (summed_scalars[factor[1]] || 0) + factor[0]
+      end
+      Expression.new(summed_scalars.map{|var, scalar| [scalar, var]}.select{|factor| !factor[0].zero? })
+    end
+
+    def remove_constants
+      Expression.new(@factors.select{|factor| factor[1].is_a?(Variable)})
+    end
+
+    def constant_factor
+      @factors.select{|factor| !factor[1].is_a?(Variable)}.inject(0) {|m, factor| m + factor[0]}
+    end
+
+    def lp_string
+      result = ''
+      factor_strings = self.simplified.factors.each_with_index.map do |factor, i|
+        scalar = factor[0]
+        if scalar < 0
+          sign = '- '
+          scalar = -scalar
+        elsif i > 0
+          sign = '+ '
+        else
+          sign = ''
+        end
+
+        if factor[1].is_a? Variable
+          "#{sign}#{scalar} x#{factor[1].internal_index+1}"
+        else
+          "#{sign}#{scalar}"
+        end
+      end
+      return factor_strings.join(' ')
+    end
+
+    def to_s
+      factors.map{|factor| factor[1].is_a?(Variable) ? "#{factor[0]} #{factor[1]}" : "#{factor[0]}"}.join(" ")
+    end
+  end
+end

data/lib/amor/model.rb

@@ -0,0 +1,65 @@
+require 'amor/objective'
+
+module Amor
+  class Model
+
+    attr_reader :objective, :constraints
+
+    def initialize
+      @variables = Array.new
+      @indices = Hash.new
+    end
+
+    # Return the variable for that index if already existing or a new one
+    def x(index)
+      @variables[@indices[index] ||= @indices.size] ||= Variable.new(self, index)
+    end
+
+    # Add a minimization objective
+    def min(expression)
+      @objective = Objective.new(:minimize, expression)
+    end
+
+    # Add a maximization objective
+    def max(expression)
+      @objective = Objective.new(:maximize, expression)
+    end
+
+    # Add a constraint
+    def st(constraint)
+      (@constraints ||= Array.new) << constraint
+      return constraint
+    end
+
+    # Create a model from a given string
+    def self.from_string(string)
+      model = Model.new
+      model.instance_eval(string)
+      return model
+    end
+
+    # Create a model from a file
+    def self.from_file(filename)
+      Model.from_string(File.read(filename))
+    end
+
+    def internal_index(index)
+      @indices[index]
+    end
+
+    def lp_string
+      result = @objective.lp_string
+      result << "\nSubject To\n"
+      result << @constraints.each_with_index.map do |constraint, i|
+        " c#{i+1}: #{constraint.lp_string}"
+      end.join("\n")
+      result << "\nEnd"
+      return result
+    end
+
+    def save_lp(filename)
+      File.open(filename, 'w') {|file| file.puts self.lp_string}
+    end
+
+  end
+end

data/lib/amor/numeric_extensions.rb

@@ -0,0 +1,57 @@
+class Fixnum
+  old_multiplication = instance_method(:'*')
+  define_method(:'*') do |value|
+    if value.is_a? Amor::Variable
+      value * self
+    else
+      old_multiplication.bind(self).(value)
+    end
+  end
+
+  old_addition = instance_method(:'+')
+  define_method(:'+') do |value|
+    if value.is_a?(Amor::Expression) || value.is_a?(Amor::Variable)
+      Amor::Expression.new(self) + Amor::Expression.new(value)
+    else
+      old_addition.bind(self).(value)
+    end
+  end
+
+  old_subtraction = instance_method(:'-')
+  define_method(:'-') do |value|
+    if value.is_a?(Amor::Expression) || value.is_a?(Amor::Variable)
+      self + -value
+    else
+      old_subtraction.bind(self).(value)
+    end
+  end
+end
+
+class Float
+  old_multiplication = instance_method(:'*')
+  define_method(:'*') do |value|
+    if value.is_a? Amor::Variable
+      value * self
+    else
+      old_multiplication.bind(self).(value)
+    end
+  end
+
+  old_addition = instance_method(:'+')
+  define_method(:'+') do |value|
+    if value.is_a?(Amor::Expression) || value.is_a?(Amor::Variable)
+      Amor::Expression.new(self) + Amor::Expression.new(value)
+    else
+      old_addition.bind(self).(value)
+    end
+  end
+
+  old_subtraction = instance_method(:'-')
+  define_method(:'-') do |value|
+    if value.is_a?(Amor::Expression) || value.is_a?(Amor::Variable)
+      self + -value
+    else
+      old_subtraction.bind(self).(value)
+    end
+  end
+end

data/lib/amor/objective.rb

@@ -0,0 +1,17 @@
+module Amor
+  class Objective
+
+    attr_reader :direction, :expression
+
+    def initialize(direction, expression)
+      @direction = direction
+      @expression = Expression.new(expression)
+    end
+
+    def lp_string
+      direction_string = (@direction == :maximize ? "Maximize" : "Minimize")
+      "#{direction_string}\n obj: #{@expression.lp_string}"
+    end
+
+  end
+end

data/lib/amor/variable.rb

@@ -0,0 +1,47 @@
+module Amor
+  class Variable
+
+    attr_reader :model, :index
+
+    def initialize(model, index)
+      @model = model
+      @index = index
+    end
+
+    def *(scalar)
+      Expression.new([[scalar, self]])
+    end
+
+    def +(value)
+      Expression.new(self) + Expression.new(value)
+    end
+
+    def -(value)
+      self + -value
+    end
+
+    def -@
+      Expression.new([[-1, self]])
+    end
+
+    def internal_index
+      @model.internal_index(self.index)
+    end
+
+    def == value
+      Constraint.new(self, :equal, value)
+    end
+
+    def <= value
+      Constraint.new(self, :lesser_equal, value)
+    end
+
+    def >= value
+      Constraint.new(self, :greater_equal, value)
+    end
+
+    def to_s
+      "x(#{index})"
+    end
+  end
+end

data/lib/amor/version.rb

@@ -0,0 +1,3 @@
+module Amor
+  VERSION = "0.0.2"
+end

data/lib/amor.rb

@@ -0,0 +1,3 @@
+require 'require_all'
+
+require_all 'lib/amor'

data/spec/amor/constraint_spec.rb

@@ -0,0 +1,35 @@
+require 'amor/constraint'
+
+module Amor
+  describe Constraint do
+    describe '.new' do
+      before(:each) do
+        @lhs = Expression.new(4)
+        @rhs = Expression.new(8)
+      end
+
+      it 'returns a Constraint with the given left hand side' do
+        expect(Constraint.new(@lhs, :lesser_equal, @rhs).lhs).to eql(@lhs)
+      end
+
+      it 'returns a Constraint with the given right hand side' do
+        expect(Constraint.new(@lhs, :lesser_equal, @rhs).rhs).to eql(@rhs)
+      end
+
+      it 'returns a Constraint with the given relation' do
+        expect(Constraint.new(@lhs, :lesser_equal, @rhs).relation).to eq(:lesser_equal)
+      end
+    end
+
+    describe '#lp_string' do
+      it 'returns a LP format ready version of the constraint' do
+        model = Model.new
+        v1 = model.x(1)
+        v2 = model.x(2)
+        v3 = model.x(3)
+        expect(Constraint.new(Expression.new([[3, v1], [-2.0, v2], [2, :constant], [2.5, v3]]), :lesser_equal, Expression.new(5)).lp_string).to eq('3 x1 - 2.0 x2 + 2.5 x3 <= 3')
+      end
+    end
+
+  end
+end