rubylabs 0.6.4 → 0.7.0

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.7.0

data/lib/randomlab.rb

@@ -274,255 +274,174 @@ module RandomLab
   end # class Card
 
 =begin rdoc
-  Visualization helpers (private):
-		make_canvas				create a new blank canvas (same one used for all tests)
 	Visualization methods called by students to test a PRNG object:
-		view(type,*args)	initialize canvas for a visualization of the specified type
-		tick_mark(i)			add a tick mark at location i on the number line
-  State vars maintained by the visualization methods:
-		@@drawing					initially nil, set to a Draw object when canvas has been created
-		@@tkroot					top level Tk application that manages the canvas (should never be used)
-		@@visual					set to :line, :histogram, or :dot_plot when drawing initialized
-		@@endpoint				last point on number line (value of n passed to init_line)
+
+		view_numberline(n)	      make a number line for integers between 0 and n-1
+		tick_mark(i)			        draw a tick mark at location i on the number line
+
+    view_histogram(n, max)    make a histogram with n bins for value from 0 to max
+    view_histogram(a)         make a histogram with one bin for each item in a
+    update_bin(x)             add 1 to the count of items in bin x
+    get_counts                get a copy of the bins (array of counts)
+    
+    view_dotplot(n)           initialize an n x n dotplot
+    plot_point(x,y)           add a dot at (x,y) to the dotplot
 =end
 
-  def make_canvas
-    require 'tk'
-  
-    if ! defined? @@tkroot
-    	@@tkroot = TkRoot.new { title "RandomLab" }
-  	end
-	
-  	if @@drawing == nil
-    	@@drawing = Draw.new(@tkroot) 
-    	@@threads = []
-    	@@threads << Thread.new() do
-    		Tk.mainloop
-    	end
-  	end
+  def view_numberline(npoints, userOptions = {})
+    Canvas.init(500, 100, "RandomLab::NumberLine")
+    options = @@numberLineOptions.merge(userOptions)
+    line = Canvas.line(0, 70, 500, 70, :width => options[:lineThickness], :fill => options[:lineColor])
+    @@drawing = NumberLine.new(line, npoints, options)
+    return true
   end
 
-	def view(*args)
-    kind = args.shift
-		if ! @@views.include?(kind)
-			puts "view type must be one of #{@@views.join(', ')}"
-		else
-			@@visual = kind
-			case kind
-				when :line
-          @@npoints = args[0]
-          if @@npoints.kind_of? Numeric
-      			make_canvas if @@drawing.nil?
-						@@drawing.new_line(@@npoints)
-					else
-						puts "usage: view(:line, npoints)"
-					end
-				when :dotplot
-          @@max = args[0]
-          if @@max.kind_of? Numeric
-      			make_canvas if @@drawing.nil?
-						@@drawing.new_dotplot(@@max)
-					else
-						puts "usage: view(:dotplot, max)"
-					end
-				when :histogram
-          if args[0].class == Array
-            @@keys = args[0]
-            @@nbins = @@max = @@keys.length
-            @@counts = Hash.new
-            @@keys.each { |k| @@counts[k] = 0 }
-          else
-            @@nbins, @@max = args
-            @@max = @@nbins if @@max.nil?
-            @@keys = nil
-          end
-          if [@@nbins, @@max].all? { |x| x.kind_of? Numeric }
-      			make_canvas if @@drawing.nil?  
-						@@drawing.new_histogram(@@nbins, @@max)
-					else
-						puts "usage: view(:histogram, nbins, max) or view(:histogram, keys)"
-					end
-			end
-		end
-	end
-
 	def tick_mark(i)
-		if @@visual != :line
-			puts "call 'view(:line,n)' to make a number line of size n'"
-		elsif i < 0 || i >= @@npoints
-			puts "tick_mark: 0 <= i < #{@@npoints}"
+		if @@drawing.class != NumberLine
+			puts "call view_numberline to initialize the number line"
+		elsif i < 0 || i >= @@drawing.npoints
+			puts "tick_mark: 0 <= i < #{@@drawing.npoints}"
 		else
-			@@drawing.add_tick(i)
+		  x0, y0, x1, y1 = @@drawing.line.coords
+			tx = (i.to_f / @@drawing.npoints) * (x1-x0)
+			ty = y0 - @@drawing.options[:tickHeight]
+			Canvas.line(tx, y0, tx, ty, :width => @@drawing.options[:tickWidth], :fill => @@drawing.options[:tickColor])
 			sleep(@@delay)
 		end
-		return nil
+		return true
 	end
-
-  def update_bin(x)
-    if @@visual != :histogram
-      puts "call view(:histogram, n, max) to initialize a histogram with n bins"
-    else
-      i = @@keys ? @@keys.index(x) : x
-      if i.nil?
-        puts "unknown item: #{x}"
-      elsif i < 0 || i >= @@max
-        puts "count: 0 <= i < #{@@max}"
+	
+  def view_histogram(*args)
+    begin
+      if args[0].class == Array
+        userOptions = args.length > 1 ? args[1] : { }
+        raise "usage:  view_histogram(keys, options)" unless userOptions.class == Hash
+        keys = args[0]
+        nbins = max = keys.length
       else
-			  @@drawing.add_hist(i)
-        @@counts[x] += 1 if @@keys
-			  sleep(@@delay) 
-      end     
+        userOptions = args.length > 2 ? args[2] : { }
+        raise "usage:  view_histogram(nbins, max, options)" unless userOptions.class == Hash
+        nbins = args[0]
+        max = args.length > 1 ? args[1] : nbins
+        keys = nil
+      end
+    rescue Exception => e
+      puts e
+      return false
+    end
+    
+    Canvas.init(500, 300, "RandomLab::Histogram")
+    counts = Hash.new(0)
+    options = @@histogramOptions.merge(userOptions)
+    bins = []
+    binHeight = 3
+    binBorder = 2
+    binWidth = (500/(nbins+1))
+    binTop = 280
+    nbins.times do |i| 
+      x = i * binWidth + binWidth/2
+      bins << Canvas.rectangle( x + binBorder, binTop, x + binWidth - binBorder, binTop + binHeight, :outline => options[:binColor], :fill => options[:binColor] ) 
     end
-    return nil
-  end
 
-  def get_counts
-    return @@counts
-  end
+    @@drawing = Histogram.new(bins, max.to_f, keys, counts, binTop, options)
 
-  def plot_point(x,y)
-    if @@visual != :dotplot
-      puts "call view(:dotplot, max) to initialize a dot plot"
-		elsif x < 0 || x >= @@max || y < 0 || y >= @@max
-			puts "plot_point: 0 <= x, y < #{@@max}"
-		else
-			@@drawing.add_point(x,y)
-			sleep(@@delay)
-		end
-		return nil
+    return true  
   end
-
-
-=begin rdoc
-  Make a window to display dot plots and histograms
-=end
 	
-	class Draw 
-
-		attr_accessor :canvas, :ticks, :bins
-
-		@@canvasWidth = @@canvasHeight = 500
-  	@@tickHeight = 20
-  	@@tickWidth = 1
-  	@@traceSize = 10
-  	@@tickColor = 'blue'
-    @@histColor = '#000080'
-    @@dotSize = 2
-    @@dotColor = '#000080'
-
-  	def new_line(nticks)
-      self.erase_objects
-			@title = TkcText.new(@@drawing.canvas, 100, 10, :text => "Number Line")
-			@endpoint = nticks
-			y = @@canvasHeight / 2
-			@line = TkcLine.new( @canvas, 0, y, @@canvasWidth, y, :width => 3, :fill => '#777777' )
-			return nil
-  	end
-
-		def add_tick(i)
-			x = (i.to_f / @endpoint) * @@canvasWidth
-			y = @@canvasHeight / 2
-			@ticks << TkcLine.new( @canvas, x, y, x, y-@@tickHeight, :width => @@tickWidth, :fill => @@tickColor )			
-			@ticks.last(@@traceSize).each_with_index { |t,i| t['fill'] = @palette[i] }
-		end
 
-    def new_histogram(nbins, max)
-      self.erase_objects
-			@title = TkcText.new(@@drawing.canvas, 100, 10, :text => "Histogram")
-			@nbins, @max = nbins, max
-  		@baseline = @@canvasHeight / 2
-      w = @@canvasWidth / @nbins
-      @nbins.times do |i| 
-        x = i * w
-        @bins[i] = TkcRectangle.new( @canvas, x, @baseline, x+w, @baseline-3, :outline => "#CCCCCC", :fill => @@histColor ) 
-      end
-      @dy = 8.0
-      @yt = 50
+  def update_bin(x)
+    if @@drawing.class != Histogram
+      puts "call view_histogram to initialize a histogram"
       return nil
     end
-
-    def add_hist(x)
-      i = (x.to_f / @max) * @nbins
-      rect = @bins[i]
-      x1, y1, x2, y2 = rect.coords
-      y1 = y1 - @dy
-      rect.coords = [x1, y1, x2, y2]
-      if y1 < @yt
-        @bins.each do |rect|
-          x1, y1, x2, y2 = rect.coords
-          y1 =  @baseline - ((@baseline - y1) / 2)
-          rect.coords = [x1, y1, x2, y2]
-        end
-        @dy = @dy / 2
+    if @@drawing.keys
+      i = @@drawing.keys.index(x)
+      if i.nil?
+        puts "unknown bin: #{x}"
+        return nil
       end
+    else
+      xmax = @@drawing.max
+      nb = @@drawing.bins.length
+      if x < 0 || x >= xmax
+        puts "x must be between 0 and #{xmax-1}"
+        return nil
+      end
+      i = ((x / xmax) * nb).to_i
     end
-
-    def new_dotplot(n)
-      self.erase_objects
-			@title = TkcText.new(@@drawing.canvas, 100, 10, :text => "Dot Plot")
-			@max = n.to_f
+    @@drawing.counts[i] += 1
+    rect = @@drawing.bins[i]
+    x1, y1, x2, y2 = rect.coords
+    y1 = y1 - @@drawing.options[:boxIncrement]
+    rect.coords = [x1, y1, x2, y2]
+    if y1 < @@drawing.options[:rescaleTrigger]
+      base = @@drawing.base
+      @@drawing.bins.each do |rect|
+        x1, y1, x2, y2 = rect.coords
+        y1 =  base - ((base - y1) / 2)
+        rect.coords = [x1, y1, x2, y2]
+      end
+      @@drawing.options[:boxIncrement] /= 2
     end
+    return true
+  end
 
-    def add_point(i,j)
-      x = (i.to_f / @max) * @@canvasWidth
-      y = (j.to_f / @max) * @@canvasHeight
-      @points << TkcRectangle.new( @canvas, x, y, x+@@dotSize, y+@@dotSize, :outline => @@dotColor, :fill => @@dotColor ) 
-#			@points.last(@@traceSize).each_with_index { |p,i| p[:outline] = p['fill'] = @palette[i] }
-    end
- 	
-  	def erase_objects
-      zap(@ticks)
-      zap(@bins)
-      zap(@points)
-      @title.delete if @title
-      @line.delete if @line
-			return nil
-  	end
-
-    private 
-
-    def zap(a)
-     	a.each { |x| x.delete }
-  	  a.clear
+  def get_counts
+    if @@drawing.class == Histogram
+      return @@drawing.counts
+    else
+      puts "current drawing is not a histogram"
+      return nil
     end
-  	
-  	# Make a range of colors starting from first and going to last in n steps.
-  	# First and last are expected to be 3-tuples of integer RGB values.  The
-  	# result is an array that starts with first, has n-1 intermediate colors,
-  	# and ends with last.  Example: 
-  	#    makePalette( [255,0,0], [0,0,0], 10) 
-  	# makes 11 colors starting with red and ending with black.
-
-  	def makePalette(first, last, n)
-  		d = Array.new(3)
-  		3.times { |i| d[i] = (first[i] - last[i]) / n }
-  		a = [first]
-  		(n-1).times do |i|
-  			a << a.last.clone 
-  			3.times { |j| a.last[j] -= d[j] }
-  		end
-  		a << last
-  		a.map { |c| sprintf("#%02X%02X%02X",c[0],c[1],c[2]) }
-  	end
-
-  	def initialize(parent) 
-  		content = TkFrame.new(parent)
-  		@canvas = TkCanvas.new(content, :borderwidth => 1, :width => @@canvasWidth, :height => @@canvasHeight) 
-   		@canvas.grid :column => 0, :row => 0, :columnspan => 4, :padx => 10, :pady => 10
-  		content.pack :pady => 20
-  		@palette = makePalette( [128,128,255], [32, 32, 255], @@traceSize-1 )
-			@palette << "#0000FF"
-      @ticks = Array.new
-      @bins = Array.new
-      @points = Array.new
-  	end 
-
-  end # class Draw
-    
+  end
+
+  def view_dotplot(npoints, userOptions = {})
+    Canvas.init(500, 500, "RandomLab::DotPlot")
+    options = @@dotPlotOptions.merge(userOptions)
+    @@drawing = DotPlot.new(npoints, options)
+    return true
+  end
+
+  def plot_point(x,y)
+    if @@drawing.class != DotPlot
+      puts "call view_dotplot to initialize a dot plot"
+		elsif x < 0 || x >= @@drawing.max || y < 0 || y >= @@drawing.max
+			puts "plot_point: 0 <= x, y < #{@@drawing.max}"
+		else
+      px = (x.to_f / @@drawing.max) * Canvas.width
+      py = (y.to_f / @@drawing.max) * Canvas.height
+      r = @@drawing.options[:dotRadius]
+      color = @@drawing.options[:dotColor]
+      Canvas.circle( px, py, r, :outline => color, :fill => color ) 
+		end
+		return nil
+  end
+  
+  NumberLine = Struct.new(:line, :npoints, :options)
+  Histogram = Struct.new(:bins, :max, :keys, :counts, :base, :options)
+  DotPlot = Struct.new(:max, :options)
+
+  @@numberLineOptions = { 
+    :lineThickness => 3, 
+    :lineColor => '#777777', 
+    :tickHeight => 20, 
+    :tickWidth => 1,
+    :tickColor => '#0000FF',
+  }
+  
+  @@histogramOptions = {
+    :binColor => '#000080',
+    :boxIncrement => 8.0,
+    :rescaleTrigger => 50,
+  }
+  
+  @@dotPlotOptions = {
+    :dotColor => '#000080',
+    :dotRadius => 1.0,
+  }
+  
   @@drawing = nil
-	@@views = [:line, :dotplot, :histogram]
-  @@delay = 0.01
-  @@keys = nil
+  @@delay = 0.1
   
 end # RandomLab