annealing 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b20378dea6d3ebcee0d0adca58d721576605d17c34c91a1828f887733c5fc5e
-  data.tar.gz: 62935118c575c16e8e0efaaf58224845fc8e975f230ac58b81da41cf66a9c08c
+  metadata.gz: c5435b7e34667fdfd63782d895080435f7f2dffb685b2a918bba83bf6781f432
+  data.tar.gz: 82bfb71e31afed6d53e0649b35c373fc5ea27bcc19e6b72ae8522983df1d4734
 SHA512:
-  metadata.gz: 4916ea9c5c854ce9891b9264d7dfe117f56da58fb906735f2afb015f2a0acf08757702991d988ed82096910225cca25794b78e135635d03b41dcf51496543a72
-  data.tar.gz: f3c74cb98d4b45512fd78bf6e18dfc751550ba33f6ccfa4ab80720d01dcdf4a1a0ec7215387033523792a503876e4abd6bc7b017330539a8367bed3da3a23741
+  metadata.gz: 54dd58f3c4c2007aa0c6cd0ca264dc9a53ddb9680a354ea2808ff3c7a8ebcae5fc032aefb70f9cdbb6fe023cd23d0dff014254c99a577e2119172597cefd5202
+  data.tar.gz: 21c78d1a11bc7ddf2e9b02e916f3bb94986944ad37ceb08cddf5a70178b82477be414e8478d1d51f26220a147f8442f5594667152bce496b7b98897204ec221f

data/.github/workflows/ruby.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6']
+        ruby-version: ['3.0']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -32,7 +32,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['3.0', '3.1', '3.2']
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -6,7 +6,7 @@ require:
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   NewCops: enable
   DefaultFormatter: progress
   DisplayCopNames: true

data/.rubocop_todo.yml

@@ -1,42 +1,54 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-02-18 23:32:32 UTC using RuboCop version 1.23.0.
+# on 2022-12-12 19:04:19 UTC using RuboCop version 1.23.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: 9
+# Offense count: 7
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
-    - 'test/annealing/configuration/configurator_test.rb'
+    - 'lib/annealing/configuration.rb'
+    - 'test/annealing/configuration_test.rb'
     - 'test/annealing/metal_test.rb'
     - 'test/annealing/simulator_test.rb'
     - 'test/annealing_test.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: CountComments, Max, CountAsOne.
 Metrics/ClassLength:
   Exclude:
-    - 'test/annealing/configuration/configurator_test.rb'
-    - 'test/annealing/metal_test.rb'
+    - 'test/annealing/configuration_test.rb'
     - 'test/annealing/simulator_test.rb'
 
-# Offense count: 13
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/annealing/configuration.rb'
+
+# Offense count: 11
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Exclude:
     - 'lib/annealing/configuration.rb'
-    - 'lib/annealing/simulator.rb'
-    - 'test/annealing/configuration/configurator_test.rb'
+    - 'test/annealing/configuration_test.rb'
     - 'test/annealing/metal_test.rb'
     - 'test/annealing/simulator_test.rb'
     - 'test/annealing_test.rb'
 
-# Offense count: 8
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/annealing/configuration.rb'
+
+# Offense count: 5
 # Configuration parameters: Max.
 Minitest/MultipleAssertions:
   Exclude:
-    - 'test/annealing/configuration/configurator_test.rb'
+    - 'test/annealing/configuration/terminators_test.rb'
     - 'test/annealing/configuration_test.rb'
+    - 'test/annealing/simulator_test.rb'

data/Gemfile

@@ -7,8 +7,8 @@ gemspec
 
 gem "debug", ">= 1.0.0", require: false
 gem "minitest", "~> 5.0"
-gem "rake", "~> 13.0", ">= 13.0.6"
-gem "rubocop", "~> 1.23"
-gem "rubocop-minitest", "~> 0.17.0"
-gem "rubocop-performance", "~> 1.12"
+gem "rake", "~> 13.0.0", ">= 13.0.6"
+gem "rubocop", "~> 1.48.0"
+gem "rubocop-minitest", "~> 0.29.0"
+gem "rubocop-performance", "~> 1.16.0"
 gem "rubocop-rake", "~> 0.6.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    annealing (0.2.0)
+    annealing (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,40 +10,42 @@ GEM
     debug (1.4.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
-    io-console (0.5.11)
-    irb (1.4.1)
+    io-console (0.6.0)
+    irb (1.6.3)
       reline (>= 0.3.0)
-    minitest (5.14.4)
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
-    reline (0.3.1)
+    regexp_parser (2.7.0)
+    reline (0.3.2)
       io-console (~> 0.5)
     rexml (3.2.5)
-    rubocop (1.23.0)
+    rubocop (1.48.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.14.0)
-      parser (>= 3.0.1.1)
-    rubocop-minitest (0.17.0)
-      rubocop (>= 0.90, < 2.0)
-    rubocop-performance (1.12.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.29.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    ruby-prof (1.4.3)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+    ruby-prof (1.6.1)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
@@ -52,12 +54,12 @@ DEPENDENCIES
   annealing!
   debug (>= 1.0.0)
   minitest (~> 5.0)
-  rake (~> 13.0, >= 13.0.6)
-  rubocop (~> 1.23)
-  rubocop-minitest (~> 0.17.0)
-  rubocop-performance (~> 1.12)
+  rake (~> 13.0.0, >= 13.0.6)
+  rubocop (~> 1.48.0)
+  rubocop-minitest (~> 0.29.0)
+  rubocop-performance (~> 1.16.0)
   rubocop-rake (~> 0.6.0)
-  ruby-prof (~> 1.4, >= 1.4.3)
+  ruby-prof (~> 1.6, >= 1.6.1)
 
 BUNDLED WITH
-   2.1.4
+   2.4.4

data/README.md

@@ -102,12 +102,26 @@ The annealer supports a number of configuration options. See the [configuration
 
 ### `cool_down`
 
-By default, the simulation will decrease the `temperature` linearly by `cooling_rate` on each step of the annealing process. In some cases you may wish to override this to use a different cooling algorithm. To do so, you can specify a custom `cool_down` function. The function can be any object that responds to `#call` and accepts three arguments: the `energy` calculation of the current object, the current `temperature` of the annealer, the `cooling_rate` for the simulation, and the number of `steps` the annealer has taken so far. It should return the new temperature as a Float.
+By default, the simulation will decrease the `temperature` linearly by `cooling_rate` on each step of the annealing process. In some cases you may wish to override this to use a different cooling algorithm. To do so, you can use one of the other built-in cooling functions or you can specify a custom `cool_down` function. Custom functions can be any object that responds to `#call` and accepts four arguments: the `energy` calculation of the current object, the current `temperature` of the annealer, the `cooling_rate` for the simulation, and the number of `steps` the annealer has taken so far. It should return the new temperature as a Float.
 
 ```ruby
-Annealing.configuration.cool_down = lambda do |_energy, temperature, cooling_rate, steps|
-  # Reduce temperature exponentially
-  temperature - (cooling_rate * (steps**2))
+# Use the built-in linear cool-down function (the default)
+Annealing.configuration.cool_down = Annealing::Configuration::Coolers.linear
+
+# Use the built-in exponential cool-down function
+Annealing.configuration.cool_down = Annealing::Configuration::Coolers.exponential
+
+# Use the built-in geometric cool-down function with a custom ratio (default ratio is 2)
+Annealing.configuration.cool_down = Annealing::Configuration::Coolers.exponential(1.5)
+
+# Use a custom cool down function
+Annealing.configuration.cool_down = lambda do |energy, temperature, cooling_rate, steps|
+  # Reduce temperature exponentially when the temperature is above 500, then linearly
+  if temperature > 500
+    Annealing::Configuration::Coolers.exponential.call(energy, temperature, cooling_rate, steps)
+  else
+    Annealing::Configuration::Coolers.linear.call(energy, temperature, cooling_rate, steps)
+  end
 end
 ```
 
@@ -161,16 +175,6 @@ calculator = PotentialSalesCalculator.new(8)
 Annealing.configuration.energy_calculator = calculator.method(:energy)
 ```
 
-### `logger`
-
-The default logger is a standard Ruby Logger that writes to stdout. You can specify a different `logger` if you wish.
-
-```ruby
-logger = Logger.new('logfile.log')
-logger.level = Logger::DEBUG
-Annealing.configuration.logger = logger
-```
-
 ### `state_change`
 
 As with `energy_calculator`, you must specify a `state_change` function in order to run any simulations; no default function is provided. The function can be any object that responds to `#call` and accepts a single argument: the `state` representing the current state that should be changed. It should return the changed state.
@@ -193,12 +197,19 @@ Annealing.configuration.state_change = instance.method(:state_change)
 
 ### `termination_condition`
 
-By default, a simulation will run until the temperature reaches 0. In some cases, you might want to specify a termination condition that will stop the annealing process as soon as some other condition is met regardless of the current temperature. You can define a custom `termination_condition` function, which can be any object that responds to `#call` and accepts three arguments: the current `state` of the object, the `energy` calculation of the current object, and the current `temperature` of the simulation. It should return a boolean value where `true` indicates the simulation should stop.
+By default, a simulation will run until the temperature reaches 0. In some cases, you might want to specify a termination condition that will stop the annealing process as soon as some other condition is met regardless of the current temperature. To do so, you can use one of the other built-in termination condition functions or you can specify a custom one. Custom `termination_condition` functions can be any object that responds to `#call` and accepts three arguments: the current `state` of the object, the `energy` calculation of the current object, and the current `temperature` of the simulation. It should return a boolean value where `true` indicates the simulation should stop.
 
 ```ruby
+# Use the built-in zero-temperature termination condition function
+Annealing.configuration.termination_condition = Annealing::Configuration::Terminators.temp_is_zero?
+
+# Use the built-in zero-energy termination condition function
+Annealing.configuration.termination_condition = Annealing::Configuration::Terminators.energy_or_temp_is_zero?
+
+# Use a custom termination condition function
 Annealing.configuration.termination_condition = lambda do |_state, energy, temperature|
-  # Stop early if we encounter any 0-energy state
-  energy == 0 || temperature <= 0.0
+  # Stop if the energy is below 500 and the temperature is below 100, or the temperature is already 0
+  temperature <= 0 || (energy <= 500 && temperature <= 500)
 end
 ```
 

data/annealing.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Simulated Annealing"
   spec.description   = "Simulated Annealing algoritm implementation."
   spec.homepage      = "https://github.com/3zcurdia/annealing"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "ruby-prof", "~> 1.4", ">= 1.4.3"
+  spec.add_development_dependency "ruby-prof", "~> 1.6", ">= 1.6.1"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

data/bin/run

@@ -39,20 +39,19 @@ state_change = lambda do |state|
   swapped
 end
 
-Annealing.configuration.logger.level = Logger::DEBUG
 simulator = Annealing::Simulator.new(temperature: 10_000, cooling_rate: 0.01)
 solution = simulator.run(locations,
                          energy_calculator: energy_calculator,
                          state_change: state_change)
 
 puts "\nInitial itinerary:"
-locations.each_cons(2).each_with_index do |(location1, location2), index|
+locations.each_cons(2).with_index do |(location1, location2), index|
   puts "Stop ##{index + 1}: #{location1.name} -> #{location2.name} (#{location1.distance(location2)})"
 end
 puts "-------\nEnergy: #{energy_calculator.call(locations)}"
 
 puts "\nAnnealed itinerary:"
-solution.state.each_cons(2).each_with_index do |(location1, location2), index|
+solution.state.each_cons(2).with_index do |(location1, location2), index|
   puts "Stop ##{index + 1}: #{location1.name} -> #{location2.name} (#{location1.distance(location2)})"
 end
 puts "-------\nEnergy: #{solution.energy}"

data/lib/annealing/configuration/coolers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Annealing
+  class Configuration
+    # Built-in cool down functions
+    module Coolers
+      module_function
+
+      # Reduce temperature linearly by the cooling rate
+      def linear
+        lambda { |_energy, temperature, cooling_rate, _steps|
+          temperature - cooling_rate
+        }
+      end
+
+      # Reduce temperature exponentially on each step by the cooling rate
+      def exponential
+        lambda { |_energy, temperature, cooling_rate, steps|
+          temperature - (Math.exp(steps - 1) * cooling_rate)
+        }
+      end
+
+      # Reduce temperature geometrically at a given ratio by the cooling rate
+      def geometric(ratio = 2)
+        unless ratio.positive?
+          raise(Annealing::Configuration::ConfigurationError,
+                "geometric ratio must be positive")
+        end
+
+        lambda { |_energy, temperature, cooling_rate, steps|
+          temperature - (cooling_rate * (ratio**(steps - 1)))
+        }
+      end
+    end
+  end
+end

data/lib/annealing/configuration/terminators.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Annealing
+  class Configuration
+    # Built-in termination condition check functions
+    module Terminators
+      module_function
+
+      # Returns true when the temperature is at or below zero
+      def temp_is_zero?
+        lambda { |_state, _energy, temperature|
+          temperature <= 0
+        }
+      end
+
+      # Returns true if a 0-energy state is detected, or when the temperature
+      # is at or below zero
+      def energy_or_temp_is_zero?
+        lambda { |state, energy, temperature|
+          energy <= 0 || temp_is_zero?.call(state, energy, temperature)
+        }
+      end
+    end
+  end
+end

data/lib/annealing/configuration.rb

@@ -3,28 +3,70 @@
 module Annealing
   # It enables the gem configuration
   class Configuration
+    DEFAULT_COOLING_RATE = 0.0003
+    DEFAULT_INITIAL_TEMPERATURE = 10_000.0
+
+    class ConfigurationError < Annealing::Error; end
+
     attr_accessor :cool_down,
                   :cooling_rate,
                   :energy_calculator,
-                  :logger,
                   :state_change,
                   :temperature,
                   :termination_condition
 
-    def initialize
-      @cool_down = lambda do |_energy, temperature, cooling_rate, _steps|
-        # Reduce the temperature linearly by default
-        temperature - cooling_rate
-      end
-      @cooling_rate = 0.0003
-      @energy_calculator = nil
-      @logger = Logger.new($stdout, level: Logger::INFO)
-      @state_change = nil
-      @temperature  = 10_000.0
-      @termination_condition = lambda do |_state, _energy, temperature|
-        # Terminate the simulation as soon as the temperature reaches 0
-        temperature <= 0.0
-      end
+    def initialize(config_hash = {})
+      @cool_down = config_hash.fetch(:cool_down, Coolers.linear)
+      @cooling_rate = config_hash.fetch(:cooling_rate,
+                                        DEFAULT_COOLING_RATE).to_f
+      @energy_calculator = config_hash.fetch(:energy_calculator, nil)
+      @state_change = config_hash.fetch(:state_change, nil)
+      @temperature  = config_hash.fetch(:temperature,
+                                        DEFAULT_INITIAL_TEMPERATURE).to_f
+      @termination_condition = config_hash.fetch(:termination_condition,
+                                                 Terminators.temp_is_zero?)
+    end
+
+    # Return new configuration that merges new attributes with current
+    def merge(config_hash)
+      self.class.new(attributes.merge(config_hash))
+    end
+
+    def validate!
+      message = if !callable?(cool_down)
+                  "Missing cool down function"
+                elsif cooling_rate.negative?
+                  "Cooling rate cannot be negative"
+                elsif !callable?(energy_calculator)
+                  "Missing energy calculator function"
+                elsif !callable?(state_change)
+                  "Missing state change function"
+                elsif temperature.negative?
+                  "Initial temperature cannot be negative"
+                elsif !callable?(termination_condition)
+                  "Missing termination condition function"
+                end
+      raise(ConfigurationError, message) if message
+    end
+
+    private
+
+    def attributes
+      {
+        cool_down: cool_down,
+        cooling_rate: cooling_rate,
+        energy_calculator: energy_calculator,
+        state_change: state_change,
+        temperature: temperature,
+        termination_condition: termination_condition
+      }
+    end
+
+    def callable?(attribute)
+      attribute.respond_to?(:call)
     end
   end
 end
+
+require "annealing/configuration/coolers"
+require "annealing/configuration/terminators"

data/lib/annealing/metal.rb

@@ -3,28 +3,23 @@
 module Annealing
   # It manages the total energy of a given collection
   class Metal
-    include Configuration::Configurator
-    attr_reader :state, :temperature
+    attr_reader :configuration, :state, :temperature
 
-    def initialize(current_state, current_temperature, **config)
-      init_configuration(config)
+    def initialize(current_state, current_temperature, configuration = nil)
+      @configuration = configuration || Annealing.configuration.merge({})
       @state = current_state
       @temperature = current_temperature
-
-      raise(ArgumentError, "Missing energy calculator function") unless energy_calculator.respond_to?(:call)
-
-      raise(ArgumentError, "Missing state change function") unless state_change.respond_to?(:call)
     end
 
     def energy
-      @energy ||= energy_calculator.call(state)
+      @energy ||= configuration.energy_calculator.call(state)
     end
 
     # This method is not idempotent!
     # It relies on random probability to select the next state
     def cool!(new_temperature)
       cooled_metal = cool(new_temperature)
-      if better_than?(cooled_metal)
+      if prefer?(cooled_metal)
         cooled_metal
       else
         @temperature = new_temperature
@@ -32,32 +27,21 @@ module Annealing
       end
     end
 
-    def to_s
-      format("%<temperature>.4f:%<energy>.4f:%<value>s",
-             temperature: temperature,
-             energy: energy,
-             value: state)
-    end
-
     private
 
-    def energy_calculator
-      current_config_for(:energy_calculator)
-    end
-
-    def state_change
-      current_config_for(:state_change)
-    end
+    # True if cooled_metal.energy is lower than current energy, otherwise let
+    # probability determine if we should accept a higher value over a lower
+    # value
+    def prefer?(cooled_metal)
+      return true if cooled_metal.energy < energy
 
-    def better_than?(cooled_metal)
       energy_delta = energy - cooled_metal.energy
-      energy_delta.positive? ||
-        (Math::E**(energy_delta / cooled_metal.temperature)) > rand
+      (Math::E**(energy_delta / cooled_metal.temperature)) > rand
     end
 
     def cool(new_temperature)
-      next_state = state_change.call(state)
-      Metal.new(next_state, new_temperature, **configuration_overrides)
+      next_state = configuration.state_change.call(state)
+      Metal.new(next_state, new_temperature, configuration)
     end
   end
 end

data/lib/annealing/simulator.rb

@@ -3,68 +3,50 @@
 module Annealing
   # It runs simulated annealing
   class Simulator
-    include Configuration::Configurator
+    attr_reader :configuration
 
-    def initialize(**config)
-      init_configuration(config)
+    def initialize(config_hash = {})
+      @configuration = Annealing.configuration.merge(config_hash)
     end
 
     def run(initial_state, config_hash = {})
-      with_configuration_overrides(config_hash) do
-        validate_configuration!
-        current = Metal.new(initial_state, temperature,
-                            **configuration_overrides)
-        Annealing.logger.debug("Original: #{current}")
+      with_runtime_config(config_hash) do |runtime_config|
+        initial_temperature = runtime_config.temperature
+        current = Metal.new(initial_state, initial_temperature, runtime_config)
         steps = 0
-        until termination_condition_met?(termination_condition, current)
+        until termination_condition_met?(current, runtime_config)
           steps += 1
-          current = reduce_temperature(cool_down, current, steps)
+          current = reduce_temperature(current, steps, runtime_config)
         end
-        Annealing.logger.debug("Optimized: #{current}")
         current
       end
     end
 
     private
 
-    def cool_down
-      current_config_for(:cool_down)
-    end
-
-    def cooling_rate
-      current_config_for(:cooling_rate).to_f
-    end
-
-    def logger
-      current_config_for(:logger)
-    end
-
-    def temperature
-      current_config_for(:temperature).to_f
-    end
-
-    def termination_condition
-      current_config_for(:termination_condition)
-    end
-
-    def reduce_temperature(cool_down, metal, steps)
-      new_temperature = cool_down.call(metal.energy, metal.temperature,
-                                       cooling_rate, steps)
+    # Wrapper for public methods that may use a custom configuration
+    def with_runtime_config(config_hash)
+      runtime_config = if config_hash.is_a?(Hash) && config_hash.any?
+                         configuration.merge(config_hash)
+                       else
+                         configuration
+                       end
+      runtime_config.validate!
+      yield(runtime_config)
+    end
+
+    def reduce_temperature(metal, steps, config)
+      new_temperature = config.cool_down.call(metal.energy,
+                                              metal.temperature,
+                                              config.cooling_rate,
+                                              steps)
       metal.cool!(new_temperature)
     end
 
-    def termination_condition_met?(termination_condition, metal)
-      termination_condition.call(metal.state, metal.energy, metal.temperature)
-    end
-
-    def validate_configuration!
-      raise(ArgumentError, "Invalid initial temperature") if temperature.negative?
-
-      raise(ArgumentError, "Invalid initial cooling rate") if cooling_rate.negative?
-
-      raise(ArgumentError, "Missing cool down function") unless cool_down.respond_to?(:call)
-
-      raise(ArgumentError, "Missing termination condition function") unless termination_condition.respond_to?(:call)
+    def termination_condition_met?(metal, config)
+      config.termination_condition.call(metal.state,
+                                        metal.energy,
+                                        metal.temperature)
     end
   end
 end

data/lib/annealing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Annealing
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/annealing.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-require "logger"
-require "annealing/version"
-require "annealing/configuration"
-require "annealing/configuration/configurator"
-require "annealing/metal"
-require "annealing/simulator"
-
 # Simulated Annealing algoritm
 # https://en.wikipedia.org/wiki/Simulated_annealing
 module Annealing
@@ -23,13 +16,15 @@ module Annealing
 
   def self.configure
     yield(configuration)
+    configuration
   end
 
   def self.simulate(initial_state, config_hash = {})
     Simulator.new.run(initial_state, config_hash).state
   end
-
-  def self.logger
-    configuration.logger
-  end
 end
+
+require "annealing/configuration"
+require "annealing/metal"
+require "annealing/simulator"
+require "annealing/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annealing
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Luis Ezcurdia
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-prof
@@ -17,20 +17,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: 1.6.1
 description: Simulated Annealing algoritm implementation.
 email:
 - ing.ezcurdia@gmail.com
@@ -56,7 +56,8 @@ files:
 - bin/setup
 - lib/annealing.rb
 - lib/annealing/configuration.rb
-- lib/annealing/configuration/configurator.rb
+- lib/annealing/configuration/coolers.rb
+- lib/annealing/configuration/terminators.rb
 - lib/annealing/metal.rb
 - lib/annealing/simulator.rb
 - lib/annealing/version.rb
@@ -76,14 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Simulated Annealing

data/lib/annealing/configuration/configurator.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Annealing
-  class Configuration
-    # Configuration mixin
-    module Configurator
-      def self.included(base)
-        base.send :include, InstanceMethods
-      end
-
-      # Mixin methods
-      module InstanceMethods
-        def init_configuration(config_hash = {})
-          @instance_configuration = config_hash
-          @temporary_configuration = {}
-        end
-
-        def with_configuration_overrides(local_config_hash = {})
-          @temporary_configuration = local_config_hash
-          yield
-        ensure
-          @temporary_configuration = {}
-        end
-
-        def configuration_overrides
-          instance_configuration.merge(temporary_configuration)
-        end
-
-        private
-
-        attr_accessor :instance_configuration, :temporary_configuration
-
-        def current_config_for(config)
-          temporary_configuration[config] ||
-            instance_configuration[config] ||
-            Annealing.configuration.public_send(config)
-        end
-      end
-    end
-  end
-end