simulated_annealing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 165dcea541b3a3de2fd9c11aa8f6dcd96a31e722
+  data.tar.gz: 1fefbbba2bdd60a98633daf65057fbb988b99149
+SHA512:
+  metadata.gz: 438fbb5ae64d723ad135249bb02e9e47edb5322c1ec6641dc57d11248dbf7f0c8d3831250afeb300af46364303b3653fd62f4f7b353721d62e499b18efebc16b
+  data.tar.gz: a4810590db9fff6fd1b904e1810748988cd447d3f5e937d26d002aaaa138799f10084cb9b359f34f4320d9ef2e0ff53044e817332992d7089d36063606a4b6c9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jiangzhi.xie
+
+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,78 @@
+SA
+========
+
+A simple SA(Simulated Annealing) framework
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simulated_annealing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simulated_annealing
+
+## Usage
+
+```
+require 'simulated_annealing'
+or 
+# require 'sa'
+
+class Unit
+  include SA
+
+  attr_accessor :state
+
+  def initialize
+    @state = 8.times.map { rand(2) }
+  end
+
+  def energy
+    val = @state.join.to_i(2)
+    val * Math.sin(val)
+  end
+
+  def sa_iterator(ctx, temp)
+    @state.length.times do
+      i = rand(state.length)
+      state[i] = 1 - state[i]
+
+      unless ctx.transfer(self.energy, self.state)
+        # recover
+        state[i] = 1 - state[i] 
+      end
+    end
+  end
+end
+
+Unit.simulated_annealing({
+  temp: 100,
+  cool: Proc {|t| t * 0.95 }
+  stop_temp: 0.001
+})
+```
+
+## 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/[USERNAME]/sa.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "sa"
+
+# 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/sa.rb

@@ -0,0 +1,17 @@
+require "sa/version"
+require 'sa/context'
+
+module SA
+  def self.included(cls)
+    cls.extend(SA::ClassMethods)
+  end
+
+  module ClassMethods
+    def simulated_annealing(unit, options)
+      opts = options.each_with_object({}) {|kv, r| r[kv.first.to_sym] = kv.last }
+      ctx = SA::Context.new
+      ctx.annealing(unit, opts[:temp], opts[:stop_temp], opts[:cool])
+      return unit
+    end
+  end
+end

data/lib/sa/context.rb

@@ -0,0 +1,46 @@
+module SA
+  class Context
+    attr_accessor :best_state, :best_energy
+
+    # options:
+    #   temp: Int or Float
+    #   cool: Proc, return new Temp
+    #   stop_temp: Int or Float, stop annealing when temp < stop_temp
+    def annealing(unit, temp, stop_temp, cool_proc)
+      @best_state = unit.state
+      @best_energy = unit.energy
+
+      @current_energy = unit.energy
+      @current_temp = temp.to_f
+
+      while @current_temp > stop_temp do
+        unit.sa_iteration(self, @current_temp)
+        @current_temp = cool_proc.call(@current_temp).to_f
+      end
+
+      unit.state = @best_state if @best_energy < unit.energy
+      unit
+    end
+
+    def transfer(energy, state)
+      if energy <= @current_energy
+        @current_energy = energy
+        if energy < best_energy
+          @best_energy = energy
+          @best_state = state.dup
+        end
+        true
+      else
+        p = Math::E ** -((energy - @current_energy) / @current_temp)
+        v = Kernel.rand
+        if v < p
+          @current_energy = energy
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end
+

data/lib/sa/version.rb

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

data/lib/simulated_annealing.rb

@@ -0,0 +1 @@
+require 'sa'

data/sa.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simulated_annealing"
+  spec.version       = Sa::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["xiejiangzhi@gmail.com"]
+
+  spec.summary       = %q{Simple Simnulated Annealing framework}
+  spec.description   = %q{Simple Simnulated Annealing framework}
+  spec.homepage      = "https://github.com/xjz19901211/simulated_annealing"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: simulated_annealing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Simple Simnulated Annealing framework
+email:
+- xiejiangzhi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sa.rb
+- lib/sa/context.rb
+- lib/sa/version.rb
+- lib/simulated_annealing.rb
+- sa.gemspec
+homepage: https://github.com/xjz19901211/simulated_annealing
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Simple Simnulated Annealing framework
+test_files: []