annealing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f897b42e638f2f0f3d951ef0ad9c159352758d120d0978cc522867c2049c0e45
+  data.tar.gz: de092114cab627c60484995e8c22f87a9eca73b5965bd90de57f0f177efebadb
+SHA512:
+  metadata.gz: 5fc76aa32422d56ed36193cab617bafc6ffa0c72c6f3328dc5d48c691caf1385984e682fecde729b4c8c3f033a48b666b03ea9a4918ae9575ff6146f1382e157
+  data.tar.gz: 0e21c28aa803232597f46cd26b6a5167df07ce044d77425e9caeba07181e1cfd4ac0de1709d895f7fe1acac5eeecde6e2eaabb805d11b6f84626a600001407a5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/AbcSize:
+  Max: 25
+Metrics/MethodLength:
+  Max: 15
+Layout/LineLength:
+  Max: 120
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-06-15 23:46:36 -0500 using RuboCop version 0.81.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'test/**/*'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ing.ezcurdia@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in annealing.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    annealing (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  annealing!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Luis Ezcurdia
+
+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,117 @@
+# Annealing
+
+Find the optimal solution in a complex problem through a simulated annealing implementation for enumerable objects. Where the energy of each object can be measured by a distance method between two elements or a lambda function where the total energy is calculated in the objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'annealing'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install annealing
+
+## Usage
+
+To use this gem, you must have an object that implements a `distance` method or a lambda function where you calculate the total energy of an enumerable object.
+
+Lets solve the traveling salesman, for that we will need an object with a distance method
+to mesure the distance between two locations.
+
+```ruby
+Location = Struct.new(:x, :y) do
+  def inspect
+    "(#{x},#{y})"
+  end
+
+  def distance(location)
+    dx = (x - location.x).abs
+    dy = (y - location.y).abs
+    Math.sqrt(dx**2 + dy**2)
+  end
+end
+```
+
+Now we can create an array of the locations
+
+```ruby
+locations = [
+  Location.new(60, 200),
+  Location.new(180, 200),
+  Location.new(40, 120),
+  Location.new(100, 120),
+  Location.new(20, 40)
+]
+```
+
+Now we can just pass the locations argumen.
+
+```ruby
+puts Annealing.simulate(locations)
+[(20,40), (40,120), (100,120), (60,200), (180,200)]
+```
+
+This will run the simulation with the default parameters and it could take a while to finish.
+But if you want to iterate with other parameters you can send the parameters `temperature` and `cooling_rate`.
+
+```ruby
+simulator = Annealing::Simulator.new(temperature: 10_000, cooling_rate: 0.5)
+solution = simulator.run(locations)
+solution.energy
+351.901234
+solution.collection
+[(20,40), (40,120), (100,120), (60,200), (180,200)]
+```
+
+You can also configure the default parameters
+
+```ruby
+Annealing.configure do |c|
+  c.temperature  = 10_000.0
+  c.cooling_rate = 0.003
+end
+```
+
+### Custom total energy calculator
+
+You can set a lambda function to customize the total energy in a collection by setting in the default parameters
+
+```ruby
+Annealing.configure do |c|
+  c.total_energy_calculator = lambda do |enumerable|
+    enumerable.each_cons(2).sum { |a, b| a.distance(b) }
+  end
+end
+```
+
+or in the simulator as a parameter
+
+```ruby
+calc = lambda do |enumerable|
+  enumerable.each_cons(2).sum { |a, b| a.distance(b) }
+end
+solution = simulator.run(locations, energy_calculator: calc).collection
+[(20,40), (40,120), (100,120), (60,200), (180,200)]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/3zcurdia/annealing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/3zcurdia/annealing/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Annealing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/3zcurdia/annealing/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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/annealing.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/annealing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'annealing'
+  spec.version       = Annealing::VERSION
+  spec.authors       = ['Luis Ezcurdia Razo']
+  spec.email         = ['ing.ezcurdia@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Simulated Annealing algoritm'
+  spec.description   = 'Simulated Annealing algoritm implementation.'
+  spec.homepage      = 'https://github.com/3zcurdia/annealing'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/3zcurdia/annealing'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'annealing'
+
+# 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/annealing.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'annealing/version'
+require 'annealing/configuration'
+require 'annealing/pool'
+require 'annealing/simulator'
+
+# Simulated Annealing algoritm
+# https://en.wikipedia.org/wiki/Simulated_annealing
+module Annealing
+  # Default error class
+  class Error < StandardError; end
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.simulate(collection)
+    return [] if collection.empty?
+
+    simulator = Simulator.new
+    simulator.run(collection).collection
+  end
+
+  def self.logger
+    configuration.logger
+  end
+end

data/lib/annealing/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Annealing
+  # It enables the gem configuration
+  class Configuration
+    attr_accessor :temperature, :cooling_rate, :total_energy_calculator, :logger
+
+    def initialize
+      @temperature  = 10_000.0
+      @cooling_rate = 0.0003
+      @total_energy_calculator = lambda do |enumerable|
+        enumerable.each_cons(2).sum do |value_a, value_b|
+          value_a.distance(value_b)
+        end
+      end
+      @logger = Logger.new(STDOUT)
+    end
+  end
+end

data/lib/annealing/pool.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Annealing
+  # It manages the total energy of a given collection
+  class Pool
+    attr_reader :collection
+
+    def initialize(collection, energy_calculator: nil)
+      @collection = collection.dup
+      @energy_calculator = energy_calculator || Annealing.configuration.total_energy_calculator
+    end
+
+    def energy
+      @energy ||= energy_calculator.call(collection)
+    end
+
+    def better_than?(pool)
+      energy < pool.energy
+    end
+
+    def solution_at(temperature)
+      move = self.next
+      energy_delta = energy - move.energy
+      if energy_delta.positive? || (Math::E**(energy_delta / temperature)) > rand
+        move
+      else
+        self
+      end
+    end
+
+    def to_s
+      format('%<energy>.4f:%<value>s', energy: energy, value: collection)
+    end
+
+    private
+
+    attr_reader :energy_calculator
+
+    def next
+      Pool.new(swap_collection, energy_calculator: energy_calculator)
+    end
+
+    def swap_collection
+      swapped = collection.dup
+      idx_a = rand(size)
+      idx_b = rand(size)
+      swapped[idx_b], swapped[idx_a] = swapped[idx_a], swapped[idx_b]
+      swapped
+    end
+
+    def size
+      collection.size
+    end
+  end
+end

data/lib/annealing/simulator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Annealing
+  # It runs simulated annealing
+  class Simulator
+    attr_reader :temperature, :cooling_rate
+
+    def initialize(temperature: nil, cooling_rate: nil)
+      @temperature = temperature || Annealing.configuration.temperature
+      @cooling_rate = cooling_rate || Annealing.configuration.cooling_rate
+
+      raise 'Invalid initial temperature' if @temperature.negative?
+
+      normalize_cooling_rate
+    end
+
+    def run(collection, energy_calculator: nil)
+      best = current = Pool.new(collection.shuffle, energy_calculator: energy_calculator)
+      Annealing.logger.debug(" Original: #{current}")
+      cool_down do |temp|
+        current = current.solution_at(temp)
+        best = current if current.better_than?(best)
+      end
+      Annealing.logger.debug("Optimized: #{best}")
+      best
+    end
+
+    private
+
+    def cool_down
+      (temperature..0).step(cooling_rate).each { |temp| yield temp }
+    end
+
+    def normalize_cooling_rate
+      @cooling_rate = -1.0 * cooling_rate if cooling_rate.positive?
+    end
+  end
+end

data/lib/annealing/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Annealing
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: annealing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luis Ezcurdia Razo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-17 00:00:00.000000000 Z
+dependencies: []
+description: Simulated Annealing algoritm implementation.
+email:
+- ing.ezcurdia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- annealing.gemspec
+- bin/console
+- bin/setup
+- lib/annealing.rb
+- lib/annealing/configuration.rb
+- lib/annealing/pool.rb
+- lib/annealing/simulator.rb
+- lib/annealing/version.rb
+homepage: https://github.com/3zcurdia/annealing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/3zcurdia/annealing
+  source_code_uri: https://github.com/3zcurdia/annealing
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key:
+specification_version: 4
+summary: Simulated Annealing algoritm
+test_files: []