lrjew 1.0

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Default task is to run specs"
+task :default => :spec

data/bin/lrjew

@@ -0,0 +1,20 @@
+#!/bin/env ruby
+
+require 'lru'
+
+lru_size = ARGV[0] || 100_000
+
+lru = Lru.new(lru_size)
+
+hits = 0
+
+GC.disable
+
+ARGF.each_with_index do |line, idx|
+  lru.include?(line)
+  if (idx+1) % 50_000 == 0
+    puts "#{Time.now}: #{lru.inspect}"
+    GC.start
+    GC.disable
+  end
+end

data/lib/lrjew/bounded_stack.rb

@@ -0,0 +1,36 @@
+class BoundedStack
+  include Enumerable
+
+  def initialize(list, maximum_size)
+    @list = list
+    @maximum_size = maximum_size
+    @current_size = list.length
+    raise ArgumentError unless @current_size <= @maximum_size
+  end
+
+  def push(data)
+    shifted = nil
+    if @current_size == @maximum_size
+      shifted = @list.shift
+    else
+      @current_size += 1
+    end
+
+    node = @list.push(data)
+    [node, shifted]
+  end
+
+  def length
+    @current_size
+  end
+
+  alias_method :size, :length
+
+  def method_missing(method, *args, &block)
+    @list.send(method, *args, &block)
+  end
+
+  def each(&block)
+    @list.each(&block)
+  end
+end

data/lib/lrjew/indexed_bounded_stack.rb

@@ -0,0 +1,39 @@
+class IndexedBoundedStack
+  include Enumerable
+
+  def initialize(bounded_stack)
+    @bounded_stack = bounded_stack
+    @index = {}
+  end
+
+  def include?(data)
+    @index.has_key?(data)
+  end
+
+  def push(data)
+    node, shifted = @bounded_stack.push(data)
+    @index[data] = node
+    if shifted
+      @index.delete(shifted)
+    end
+    [node, shifted]
+  end
+
+  def delete(data)
+    if node = @index[data]
+      @bounded_stack.delete(node)
+      @index.delete(data)
+    end
+  end
+
+  def length
+    @indices.length
+  end
+
+  alias_method :size, :length
+
+  def each(&block)
+    @bounded_stack.each(&block)
+  end
+end
+

data/lib/lrjew/linked_list.rb

@@ -0,0 +1,82 @@
+class LinkedList
+  include Enumerable
+
+  def initialize
+    @last = Node.new(nil, nil)
+    @first = Node.new(nil, @last)
+    @last.prev = @first
+  end
+
+  def push(data)
+    case data
+    when Node
+      insert_before(@first.next, data)
+    else
+      node = @first.next.push(data)
+      @first.next = node
+      node.prev = @first
+      node
+    end
+  end
+
+  def each
+    node = @last
+    while (node = node.prev) && node.data
+      yield node.data
+    end
+  end
+
+  def delete(node)
+    node.prev.next = node.next
+    node.next.prev = node.prev
+    node.data
+  end
+
+  def insert_before(before, after)
+    after.prev.next = before
+    before.next = after
+    before.prev = after.prev
+    after.prev = before
+  end
+
+  def shift
+    delete(@last.prev) unless @last.prev == @first
+  end
+
+  def length
+    @first.next.length
+  end
+
+  alias_method :size, :length
+end
+
+class Node
+  attr_accessor :next, :prev
+  attr_reader :data
+
+  def initialize(data, _next)
+    @data = data
+    @next = _next
+  end
+
+  def length
+    if @data.nil?
+      0
+    else
+      1 + @next.length
+    end
+  end
+
+  def push(data)
+    node = Node.new(data, self)
+    self.prev = node
+    node
+  end
+
+  def inspect
+    prev_data = @prev && @prev.data || nil
+    next_data = @next && @next.data || nil
+    "#{prev_data.inspect} <- #{@data.inspect} -> #{next_data.inspect}"
+  end
+  alias_method :to_s, :inspect
+end

data/lib/lrjew/lru.rb

@@ -0,0 +1,32 @@
+class Lru
+  attr_reader :evictions, :hits, :misses, :gets
+
+  def initialize(indexed_bounded_stack)
+    @stack = indexed_bounded_stack
+    @gets = @hits = @misses = @evictions = 0
+  end
+
+  def include?(item)
+    @gets += 1
+    if included = @stack.include?(item)
+      @hits += 1
+      @stack.delete(item)
+      @stack.push(item)
+    else
+      @misses += 1
+      node, shifted = @stack.push(item)
+      @evictions += 1 if shifted
+    end
+    included
+  end
+
+  def inspect
+    [
+      "gets", @gets,
+      "hits", @hits,
+      "misses", @misses,
+      "evictions", @evictions,
+      "rate", @hits.to_f / @gets
+    ].join("\t")
+  end
+end

data/lib/lrjew.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'lru/linked_list'
+require 'lru/bounded_stack'
+require 'lru/indexed_bounded_stack'
+require 'lru/lru'

data/spec/bounded_stack_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe BoundedStack do
+  before do
+    @bounded_stack = BoundedStack.new([], 5)
+  end
+
+  describe "#push" do
+    describe "when the stack is not full" do
+      it "increments the size" do
+        @bounded_stack.push(1)
+        @bounded_stack.push(2)
+        @bounded_stack.size.should == 2
+        @bounded_stack.to_a.should == [1, 2]
+      end
+    end
+
+    describe "when the stack is full" do
+      it "truncates the list" do
+        5.times do |i|
+          @bounded_stack.push(i + 1)
+        end
+        @bounded_stack.push(6)[1].should == 1
+        @bounded_stack.size.should == 5
+        @bounded_stack.to_a.should == [2, 3, 4, 5, 6]
+      end
+    end
+  end
+end

data/spec/indexed_bounded_stack_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe IndexedBoundedStack do
+  before do
+    @indexed_stack = IndexedBoundedStack.new(BoundedStack.new(LinkedList.new, 5))
+  end
+
+  describe "#push" do
+    it "adds items" do
+      @indexed_stack.push(1)
+      @indexed_stack.push(2)
+      @indexed_stack.to_a.should == [1, 2]
+    end
+
+    it "returns items that were shifted off" do
+      5.times do |i|
+        @indexed_stack.push(i + 1)
+      end
+      node, shifted = @indexed_stack.push(6)
+      shifted.should == 1
+    end
+  end
+
+  describe "#delete" do
+    it "moves an item if it exists" do
+      @indexed_stack.push(1)
+      @indexed_stack.push(2)
+      @indexed_stack.delete(2)
+      @indexed_stack.to_a.should == [1]
+      @indexed_stack.push(2)
+      @indexed_stack.to_a.should == [1, 2]
+    end
+  end
+
+  describe "#include?" do
+    it "moves an item if it exists" do
+      @indexed_stack.push(1)
+      @indexed_stack.push(2)
+      @indexed_stack.include?(2).should be_true
+      @indexed_stack.include?(3).should be_false
+    end
+  end
+end

data/spec/linked_list_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe LinkedList do
+  before do
+    @linked_list = LinkedList.new
+  end
+
+  describe "#push" do
+    it "lets you push on multiple values" do
+      @linked_list.push(1)
+      @linked_list.push(2)
+      @linked_list.push(3)
+      @linked_list.to_a.should == [1, 2, 3]
+    end
+  end
+
+  describe "#delete" do
+    it "lets you remove an element in the middle" do
+      one = @linked_list.push(1)
+      two = @linked_list.push(2)
+      three = @linked_list.push(3)
+      @linked_list.delete(two)
+      @linked_list.to_a.should == [1, 3]
+    end
+
+    it "lets you remove the head" do
+      one = @linked_list.push(1)
+      two = @linked_list.push(2)
+      three = @linked_list.push(3)
+
+      @linked_list.delete(one)
+      @linked_list.to_a.should == [2, 3]
+    end
+
+    it "lets you remove the last" do
+      one = @linked_list.push(1)
+      two = @linked_list.push(2)
+      three = @linked_list.push(3)
+
+      @linked_list.delete(three)
+      @linked_list.to_a.should == [1, 2]
+    end
+  end
+
+  describe "#shift" do
+    it "removes the last item" do
+      @linked_list.push(1)
+      @linked_list.push(2)
+      @linked_list.push(3)
+
+      @linked_list.shift.should == 1
+      @linked_list.to_a.should == [2, 3]
+    end
+
+    it "removes from a list with one item" do
+      @linked_list.push(1)
+      @linked_list.shift.should == 1
+      @linked_list.to_a.should == []
+    end
+
+    it "shifting an empty list does nothing" do
+      @linked_list.shift.should == nil
+      @linked_list.to_a.should == []
+    end
+  end
+
+  describe "#length" do
+    it "is zero for the empty list" do
+      @linked_list.length.should == 0
+    end
+
+    it "returns the number of items in the list" do
+      @linked_list.push(1)
+      @linked_list.push(2)
+      @linked_list.length.should == 2
+    end
+
+    it "returns the number of items in the list even after a delete" do
+      @linked_list.push(1)
+      two = @linked_list.push(2)
+      @linked_list.push(3)
+      @linked_list.delete(two)
+      @linked_list.length.should == 2
+    end
+
+    it "returns zero when you remove all items" do
+      one = @linked_list.push(1)
+      @linked_list.delete(one)
+      @linked_list.length.should == 0
+    end
+  end
+end

data/spec/lru_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Lru do
+  before do
+    @lru = Lru.new(IndexedBoundedStack.new(BoundedStack.new(LinkedList.new, 5)))
+  end
+
+  describe "#include?" do
+    it "hits go up as we check inclusion of items that exist" do
+      @lru.include?(1)
+      @lru.misses.should == 1
+      @lru.hits.should == 0
+
+      @lru.include?(1)
+      @lru.misses.should == 1
+      @lru.hits.should == 1
+    end
+
+    it "increments evictions as the stack fills up" do
+      5.times do |i|
+        @lru.include?(i + 1)
+      end
+      @lru.evictions.should == 0
+      @lru.include?(6)
+      @lru.evictions.should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift "#{dir}/../lib"
+
+require 'rubygems'
+require 'spec'
+require 'lrjew'
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: lrjew
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Steve Jenson
+- Nick Kallen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: An LRU simulator
+email: 
+- stevej@twitter.com
+- nick@twitter.com
+executables: 
+- lrjew
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/lrjew/bounded_stack.rb
+- lib/lrjew/indexed_bounded_stack.rb
+- lib/lrjew/linked_list.rb
+- lib/lrjew/lru.rb
+- lib/lrjew.rb
+- bin/lrjew
+- spec/bounded_stack_spec.rb
+- spec/indexed_bounded_stack_spec.rb
+- spec/linked_list_spec.rb
+- spec/lru_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An LRU simulator
+test_files: 
+- spec/bounded_stack_spec.rb
+- spec/indexed_bounded_stack_spec.rb
+- spec/linked_list_spec.rb
+- spec/lru_spec.rb
+- spec/spec_helper.rb