tabu_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b995d10c83ee458580e2c3c7c05642c635d818c1
+  data.tar.gz: acc5fdb3cd382d56d8e465ecddffede0b6c9f3d1
+SHA512:
+  metadata.gz: 67ae26f25d00358037fcb5e6adb1c337892f1b3a3d1d84fa1f4361949c6a53fd826672483c0f76f38b2f7fcd636a80b3d80f3606a0974067f31e7b2b26c26f2f
+  data.tar.gz: 0d07e17d3b131371c4bf118bd294dbbe6e47cb4a10851ed174529163c8ce9dec58d3375eb33c11ddf7f0f7718535daf444afd0f75240b5206fa7180bf1903583

data/.gitignore

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

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 tabu_search.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,83 @@
+# TabuSearch
+
+A simple Tabu Search framework
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tabu_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tabu_search
+
+## Usage
+
+Require methods: 
+
+* `Class#genome` Support dup
+* `Class#genome=`
+* `Class#fitness` Current unit fitness, the bigger than better
+* `Class#search_neighbour(ts)` Search some neighbour units
+* `Class#step(ts, data)` Update unit and TS context
+
+Example:
+
+```
+class Unit
+  include TabuSearch
+
+  LEN = 5
+
+  attr_accessor :genome
+
+  def initialize(genome)
+    @genome = genome.dup
+  end
+
+  def fitness
+    val = genome.join.to_i(2)
+    return 0 if val > 10
+    10 * val - val * 3 + val ** 2
+  end
+
+  def step(ts, data)
+    id, index, val, new_fitness = data
+    genome[index] = val
+    ts.update(id, genome, new_fitness)
+  end
+
+  def search_neighbour(ts)
+    LEN.times.map do |i|
+      origin = genome[i]
+      new_val = 1 - origin
+      genome[i] = new_val
+      new_fitness = fitness
+      genome[i] = origin
+      ["#{i}-#{new_val}", i, new_val, new_fitness]
+    end
+  end
+end
+
+# Class.tabu_search(instance, times, tabu_size)
+Unit.tabu_search(Unit.new([1,2,3]), 10, 10)
+# or
+Unit.new_ts_ctx(10).search(Unit.new([1,2,3]), 10)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xjz19901211]/tabu_search.
+
+
+## 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 "tabu_search"
+
+# 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/tabu_search/context.rb

@@ -0,0 +1,57 @@
+require 'set'
+
+module TabuSearch
+  class Context
+    attr_accessor :best_genome, :best_fitness
+    attr_accessor :tabu_list, :tabu_set, :tabu_size
+
+    def initialize(tabu_size = 10)
+      @tabu_list = []
+      @tabu_set = Set.new
+      @tabu_size = tabu_size
+
+      @best_genome = nil
+      @best_fitness = nil
+    end
+
+    def search(unit, times)
+      @best_genome = unit.genome
+      @best_fitness = unit.fitness
+
+      times.times do
+        data = search_best_neighbour(unit)
+        unit.step(self, data)
+      end
+      unit.genome = best_genome
+      unit
+    end
+
+    def update(id, genome, fitness)
+      if fitness > best_fitness
+        self.best_genome = genome.dup
+        self.best_fitness = fitness
+      end
+
+      unless tabu_set.include?(id)
+        tabu_set << id
+        tabu_list << id
+        tabu_set.delete(tabu_list.shift) if tabu_list.length > tabu_size
+      end
+    end
+
+
+    private
+
+    def search_best_neighbour(unit)
+      actions = unit.search_neighbour(self)
+
+      sorted_actions = actions.sort_by {|data| -data[-1] }
+      return sorted_actions[0] if sorted_actions[0][-1] > best_fitness
+
+      sorted_actions.each do |data|
+        return data unless tabu_set.include?(data[0])
+      end
+      return sorted_actions.first
+    end
+  end
+end

data/lib/tabu_search/version.rb

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

data/lib/tabu_search.rb

@@ -0,0 +1,18 @@
+require "tabu_search/version"
+require "tabu_search/context"
+
+module TabuSearch
+  def self.included(cls)
+    cls.extend(TabuSearch::ClassMethods)
+  end
+
+  module ClassMethods
+    def new_ts_ctx(tabu_size)
+      TabuSearch::Context.new(tabu_size)
+    end
+
+    def tabu_search(unit, times, tabu_size)
+      new_ts_ctx(tabu_size).search(unit, times)
+    end
+  end
+end

data/tabu_search.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tabu_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tabu_search"
+  spec.version       = TabuSearch::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["xiejiangzhi@gmail.com"]
+
+  spec.summary       = %q{Simple TabuSearch framework}
+  spec.description   = %q{Simple TabuSearch framework}
+  # spec.homepage      = "https://"
+  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"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: tabu_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-30 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'
+description: Simple TabuSearch 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/tabu_search.rb
+- lib/tabu_search/context.rb
+- lib/tabu_search/version.rb
+- tabu_search.gemspec
+homepage: 
+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 TabuSearch framework
+test_files: []