minimization 0.1.0 → 0.1.1

data/History.txt

@@ -1,4 +1,8 @@
-=== 1.0.0 / 2010-02-24
+=== 0.1.1 / 2010-03-19
+
+* New Minimization#minimize convenience method
+
+=== 0.1.0 / 2010-02-24
 
 * Golden Section and Brent Algorithm
 

data/Rakefile

@@ -8,7 +8,7 @@ Hoe.spec 'minimization' do
 	self.version=Minimization::VERSION
 	self.rubyforge_name = 'ruby-statsample' # if different than 'minimization'
 	self.developer('Claudio Bustos', 'clbustos_AT_gmail.com')
-	self.remote_rdoc_dir = 'minimizer'
+	self.remote_rdoc_dir = 'minimization'
 end
 
 # vim: syntax=ruby

data/lib/minimization.rb

@@ -18,8 +18,10 @@
 #
 
 module Minimization
-	VERSION="0.1.0"
-	# Base class for unidimensional minimizers
+
+	VERSION="0.1.1"
+	FailedIteration=Class.new(Exception)
+  # Base class for unidimensional minimizers
 	class Unidimensional
 		# Default value for error
 		EPSILON=1e-6
@@ -45,10 +47,20 @@ module Minimization
 			@epsilon=EPSILON
 			@iterations=0
 			@log=""
-
-		end
-	def f(x)
-        @proc.call(x)
+    end
+    # Convenience method to minimize
+    # Usage:
+    #   minimizer=Minimization::GoldenSection.minimize(-1000, 1000) {|x|
+    #             x**2 }
+    #
+    def self.minimize(lower,upper,expected=nil,&block)
+      minimizer=new(lower,upper,block)
+      minimizer.expected=expected unless expected.nil?
+      raise FailedIteration unless minimizer.iterate
+      minimizer
+    end
+	  def f(x)
+      @proc.call(x)
     end
 	end
     # = Golden Section Minimizer.
@@ -61,9 +73,9 @@ module Minimization
 	#  min.x_minimum
 	#  min.f_minimum
 	#  min.log
-    class GoldenSection < Unidimensional
+  class GoldenSection < Unidimensional
 	  attr_accessor :expected
-      def initialize(lower,upper, proc)
+    def initialize(lower,upper, proc)
 		  super
 	  end
       # Start the iteration

data/test/test_minimization.rb

@@ -3,16 +3,26 @@ require "test/unit"
 require "minimization"
 
 class TestMinimization < Test::Unit::TestCase
+  def setup
+    @p1=rand(100)
+    @p2=rand(100)
+    @func=lambda {|x| (x-@p1)**2+@p2}
+  end
+  def test_facade
+    min=Minimization::GoldenSection.minimize(-1000,1000) {|x| (x-@p1)**2+@p2}
+    assert_in_delta(@p1,min.x_minimum, min.epsilon)
+    assert_in_delta(@p2,min.f_minimum, min.epsilon)
+  end
   def test_golden
-	  min=Minimization::GoldenSection.new(-1000,1000, proc {|x| (x-10)**2})
+	  min=Minimization::GoldenSection.new(-1000,1000, @func)
 	  min.iterate
-	  assert_in_delta(10, min.x_minimum, min.epsilon)
-	  assert_in_delta(0, min.f_minimum, min.epsilon)
+	  assert_in_delta(@p1, min.x_minimum, min.epsilon)
+	  assert_in_delta(@p2, min.f_minimum, min.epsilon)
 	end
   def test_brent
-	  min=Minimization::Brent.new(-1000,1000, proc {|x| (x-10)**2})
+	  min=Minimization::Brent.new(-1000,1000, @func)
 	  min.iterate
-	  assert_in_delta(10, min.x_minimum, min.epsilon)
-	  assert_in_delta(0, min.f_minimum, min.epsilon)
+	  assert_in_delta(@p1, min.x_minimum, min.epsilon)
+	  assert_in_delta(@p2, min.f_minimum, min.epsilon)
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: minimization
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Claudio Bustos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-24 00:00:00 -03:00
+date: 2010-03-19 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency