mhl 0.1.0 → 0.2.0

data/lib/mhl/quantum_particle.rb

@@ -1,8 +1,8 @@
-require 'matrix'
 require 'securerandom'
 
 require 'mhl/generic_particle'
 
+
 module MHL
   class QuantumParticle < GenericParticle
     attr_reader :position
@@ -10,7 +10,6 @@ module MHL
     # move particle using QPSO - Type II algorithm
     def move(alpha, mean_best, swarm_attractor)
       raise 'Particle attractor is nil!' if @attractor.nil?
-      # raise 'Swarm attractor is nil!' if swarm_attractor.nil?
 
       dimension = @position.size
 
@@ -18,21 +17,41 @@ module MHL
       phi = Array.new(dimension) { SecureRandom.random_number }
 
       # p_i represents the p_{i,n} parameter in [SUN11], formulae 4.82 and 4.83
-      p_i =
-        Vector[*phi.zip(@attractor[:position]).map {|phi_j,p_j| phi_j * p_j }] +
-        Vector[*phi.zip(swarm_attractor[:position]).map {|phi_j,g_j| (1.0 - phi_j) * g_j }]
+      p_i = phi.zip(@attractor[:position], swarm_attractor[:position]).map do |phi_j,p_j,g_j|
+        phi_j * p_j + (1.0 - phi_j) * g_j
+      end
 
       # delta represents the displacement for the current position.
       # See [SUN11], formula 4.82
-      delta =
-        @position.zip(mean_best).map {|x,y| alpha * (x-y).abs }.  # \alpha * | X_{i,n} - C_n |
-        map {|x| x * Math.log(1.0 / SecureRandom.random_number) } # log(\frac{1}{u_{i,n+1}})
+      delta = @position.zip(mean_best).map do |x_n,c_n| 
+        # \alpha * | X_{i,n} - C_n | * log(\frac{1}{u_{i,n+1}})
+        alpha * (x_n - c_n).abs * Math.log(1.0 / SecureRandom.random_number)
+      end
 
       # update position
       if SecureRandom.random_number < 0.5
-        @position = p_i + Vector[*delta]
+        @position = p_i.zip(delta).map {|p_in,delta_n| p_in + delta_n }
       else
-        @position = p_i - Vector[*delta]
+        @position = p_i.zip(delta).map {|p_in,delta_n| p_in - delta_n }
+      end
+
+      @position
+    end
+
+    # implement confinement à la SPSO 2011. for more information, see equations
+    # 3.14 of [CLERC12].
+    def remain_within(constraints)
+      @position = @position.map.with_index do |x_j,j|
+        d_max = constraints[:max][j]
+        d_min = constraints[:min][j]
+        if x_j > d_max
+          # puts "resetting #{j}-th position component #{x_j} to #{d_max}"
+          x_j = d_max
+        elsif x_j < d_min
+          # puts "resetting #{j}-th position component #{x_j} to #{d_min}"
+          x_j = d_min
+        end
+        x_j
       end
     end
 

data/lib/mhl/quantum_particle_swarm_optimization_solver.rb

@@ -1,7 +1,5 @@
 require 'concurrent'
-require 'facter'
 require 'logger'
-require 'matrix'
 require 'securerandom'
 
 require 'mhl/qpso_swarm'
@@ -16,18 +14,20 @@ module MHL
   # Classical and Quantum Perspectives", CRC Press, 2011
   class QuantumPSOSolver
 
+    DEFAULT_SWARM_SIZE = 40
+
     def initialize(opts={})
-      @swarm_size = opts[:swarm_size].to_i
-      unless @swarm_size
-        raise ArgumentError, 'Swarm size is a required parameter!'
-      end
+      @swarm_size = opts[:swarm_size].try(:to_i) || DEFAULT_SWARM_SIZE
+
+      @constraints = opts[:constraints]
 
       @random_position_func = opts[:random_position_func]
 
       @start_positions = opts[:start_positions]
+
       @exit_condition  = opts[:exit_condition]
 
-      @pool = Concurrent::FixedThreadPool.new(Facter.value(:processorcount).to_i * 4)
+      @pool = Concurrent::FixedThreadPool.new(Concurrent::processor_count * 4)
 
       case opts[:logger]
       when :stdout
@@ -51,26 +51,40 @@ module MHL
     # object) that accepts the genotype as argument (that is, the set of
     # parameters) and returns the phenotype (that is, the function result)
     def solve(func, params={})
-      # setup swarm
-      if @start_positions.nil?
-        swarm = QPSOSwarm.new(@swarm_size,
-                              Array.new(@swarm_size) { Vector[*@random_position_func.call] },
-                              params)
+      # initialize particle positions
+      init_pos = if @start_positions
+        # start positions have the highest priority
+        @start_positions
+      elsif @random_position_func
+        # random_position_func has the second highest priority
+        Array.new(@swarm_size) { @random_position_func.call }
+      elsif @constraints
+        # constraints were given, so we use them to initialize particle
+        # positions. to this end, we adopt the SPSO 2006-2011 random position
+        # initialization algorithm [CLERC12].
+        Array.new(@swarm_size) do
+          min = @constraints[:min]
+          max = @constraints[:max]
+          # randomization is independent along each dimension
+          random_pos = min.zip(max).map do |min_i,max_i|
+            min_i + SecureRandom.random_number * (max_i - min_i)
+          end
+        end
       else
-        raise 'Unimplemented yet!'
-        # particles = @start_positions.map do |pos|
-        #   { position: Vector[*pos] }
-        # end
+        raise ArgumentError, "Not enough information to initialize particle positions!"
       end
 
+      swarm = QPSOSwarm.new(@swarm_size, init_pos,
+                            params.merge(constraints: @constraints))
+
       # initialize variables
-      gen = 0
+      iter = 0
       overall_best = nil
 
       # default behavior is to loop forever
       begin
-        gen += 1
-        @logger.info "QPSO - Starting generation #{gen}" if @logger
+        iter += 1
+        @logger.info "QPSO - Starting iteration #{iter}" if @logger
 
         # create latch to control program termination
         latch = Concurrent::CountDownLatch.new(@swarm_size)
@@ -91,7 +105,7 @@ module MHL
         swarm_attractor = swarm.update_attractor
 
         # print results
-        puts "> gen #{gen}, best: #{swarm_attractor[:position]}, #{swarm_attractor[:height]}" unless @quiet
+        puts "> iter #{iter}, best: #{swarm_attractor[:position]}, #{swarm_attractor[:height]}" unless @quiet
 
         # calculate overall best (that plays the role of swarm attractor)
         if overall_best.nil?
@@ -103,7 +117,7 @@ module MHL
         # mutate swarm
         swarm.mutate
 
-      end while @exit_condition.nil? or !@exit_condition.call(gen, overall_best)
+      end while @exit_condition.nil? or !@exit_condition.call(iter, overall_best)
 
       overall_best
     end

data/lib/mhl/version.rb

@@ -1,3 +1,3 @@
 module MHL
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/mhl.gemspec

@@ -19,10 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'bitstring'
-  spec.add_dependency 'concurrent-ruby', '~> 0.5'
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
   spec.add_dependency 'erv'
-  spec.add_dependency 'facter'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 end

data/test/mhl/multiswarm_qpso_solver_test.rb

@@ -4,11 +4,12 @@ describe MHL::MultiSwarmQPSOSolver do
 
   it 'should solve a 2-dimension parabola in real space' do
     solver = MHL::MultiSwarmQPSOSolver.new(
-      :swarm_size           => 20,
       :num_swarms           => 4,
-      :random_position_func => lambda { Array.new(2) { rand(20).to_f } },
-      :random_velocity_func => lambda { Array.new(2) { rand(10).to_f } },
-      :exit_condition       => lambda {|generation,best_sample| best_sample[:height].abs < 0.001 },
+      :constraints          => {
+        :min => [ -100, -100 ],
+        :max => [  100,  100 ],
+      },
+      :exit_condition       => lambda {|iteration,best| best[:height].abs < 0.001 },
       :logger               => :stdout,
       :log_level            => ENV['DEBUG'] ? Logger::DEBUG : Logger::WARN,
     )

data/test/mhl/particle_swarm_optimization_solver_test.rb

@@ -4,10 +4,11 @@ describe MHL::ParticleSwarmOptimizationSolver do
 
   it 'should solve a 2-dimension parabola in real space' do
     solver = MHL::ParticleSwarmOptimizationSolver.new(
-      :swarm_size           => 40,
-      :random_position_func => lambda { Array.new(2) { rand(20) } },
-      :random_velocity_func => lambda { Array.new(2) { rand(10) } },
-      :exit_condition       => lambda {|generation,best_sample| best_sample[:height].abs < 0.001 },
+      :constraints          => {
+        :min => [ -100, -100 ],
+        :max => [  100,  100 ],
+      },
+      :exit_condition       => lambda {|iteration,best| best[:height].abs < 0.001 },
       :logger               => :stderr,
       :log_level            => ENV['DEBUG'] ? Logger::DEBUG : Logger::WARN,
     )

data/test/mhl/quantum_particle_swarm_optimization_solver_test.rb

@@ -4,9 +4,11 @@ describe MHL::QuantumPSOSolver do
 
   it 'should solve a 2-dimension parabola in real space' do
     solver = MHL::QuantumPSOSolver.new(
-      :swarm_size           => 40,
-      :random_position_func => lambda { Array.new(2) { rand(20) } },
-      :exit_condition       => lambda {|generation,best_sample| best_sample[:height].abs < 0.001 },
+      :constraints          => {
+        :min => [ -100, -100 ],
+        :max => [  100,  100 ],
+      },
+      :exit_condition       => lambda {|iteration,best| best[:height].abs < 0.001 },
       :logger               => :stderr,
       :log_level            => ENV['DEBUG'] ? Logger::DEBUG : Logger::WARN,
     )

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: mhl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mauro Tortonesi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: bitstring
@@ -21,27 +21,27 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
   name: concurrent-ruby
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: erv
@@ -49,41 +49,27 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: facter
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
   name: bundler
   prerelease: false
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: rake
@@ -91,7 +77,7 @@ dependencies:
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby Metaheuristics library
@@ -137,17 +123,17 @@ 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.1.9
+rubygems_version: 2.6.4
 signing_key:
 specification_version: 4
 summary: A scientific library for Ruby that provides several metaheuristics