matholroyd-supermemo 0.1.0

data/README.rdoc

@@ -0,0 +1,38 @@
+= SuperMemo
+
+Ruby gem that implements the SM-2 algorithm of SuperMemo. See http://www.supermemo.com/english/ol/sm2.htm for more details.
+
+== Install
+
+  gem install supermemo --sorce http://gems.github.com
+  
+== Usage
+
+=== Variables used
+
+q - the Quality of the recall (i.e.. was the item recalled or forgotten), as an integer between 0-5. 
+0-2 represent "completely unknown (0)" to "almost remembered (2)" 
+3-5 represent "barely remembered (3)" to "instantly remembered (5)"
+
+ef - The Easiness Factor of the item being recalled. The smaller the number the harder the item is to remember. For new items this should be set to 2.5.
+
+i - The scheduled Interval for the item to be recalled, in days. That is, how many days until the item should be recalled to retain it. 
+
+n - The nth iteration of the recall. An integer, starting at 1 for the first time the item is recalled. 
+
+For more background on these variables, see http://www.supermemo.com/english/ol/sm2.htm
+
+=== Code
+
+  i, ef, n = SuperMemo::SM2.i_and_ef_and_n(n, q, prev_i, prev_ef = 2.5)
+
+This is the main algorithm. Use it to figure out the next interval until the item should be recalled (i), the change in the easiness factor (ef), and new value for n.
+
+  do_repeat = SuperMemo::SM2.should_repeat_today(q)
+
+As described in the SM-2 algorithm, anything that is not recalled or recalled with difficulty should be repeated again at the end of the day's learning session. This method takes the q value of an item and returns whether it should be repeated.
+
+== Notes
+
+Currently this gem only includes the SM-2 version of the SuperMemo algorithm. Although more recent versions of the SuperMemo algorithm exist, some popular open source and commercial alternatives to SuperMemo (such as Mnemosyne) base their algorithms on the SM-2 algorithm, as they judge it a superior algorithm to the more recent iterations.  The author of Mnemosyne (the leading open source alternative) makes the point that there is a conflict of interest underlying commercial products like SuperMemo, in that companies have a vested interest in claiming the newer algorithms are better regardless of whether they actually are.  
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('supermemo', '0.1.0') do |p|
+  p.description = 'The SuperMemo (version SM-2) algorithm in ruby'
+  p.url = 'http://github.com/matholroyd/supermemo'
+  p.author = 'Mat Holroyd'
+  p.email = 'matholroyd+supermemo@gmail.com'
+  p.ignore_pattern = ['tmp/*', 'script/*']
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/sm2.rb

@@ -0,0 +1,43 @@
+module SuperMemo
+  
+  # This class includes the algorithms as used by SuperMemo 2 (typically referred to
+  # as SM2).  See the README for more information.
+  class SM2
+    
+    # This is the main algorithm, used to calculate the new i, ef, and n factors. 
+    #  Note that EF defaults to 2.5 (for items that are new)
+    def self.i_and_ef_and_n(n, q, prev_i, prev_ef = 2.5)
+      if q < 3    
+        n = 1 
+        ef = prev_ef
+      else
+        n += 1
+        ef = new_ef(prev_ef, q)
+      end
+      
+      case n
+      when 1
+        i = 1
+      when 2
+        i = 6
+      else
+        i = prev_i * ef
+      end
+    
+      [i, ef, n]
+    end
+  
+    # Items that were forgotten or almost forgotten (scored a grade < 4) should be recalled on the 
+    # current day until the grade goes to 4 or more.
+    def self.should_repeat_today(q)
+      q < 4
+    end
+    
+    private 
+    
+    def self.new_ef(ef_old, q)
+      ef = ef_old - 0.8 + (0.28*q) - (0.02*q*q)
+      ef < 1.3 ? 1.3 : ef
+    end
+  end
+end

data/supermemo.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{supermemo}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mat Holroyd"]
+  s.date = %q{2009-04-07}
+  s.description = %q{The SuperMemo (version SM-2) algorithm in ruby}
+  s.email = %q{matholroyd+supermemo@gmail.com}
+  s.extra_rdoc_files = ["lib/sm2.rb", "README.rdoc"]
+  s.files = ["lib/sm2.rb", "Manifest", "Rakefile", "README.rdoc", "supermemo.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/matholroyd/supermemo}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Supermemo", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{supermemo}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{The SuperMemo (version SM-2) algorithm in ruby}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: matholroyd-supermemo
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mat Holroyd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: The SuperMemo (version SM-2) algorithm in ruby
+email: matholroyd+supermemo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/sm2.rb
+- README.rdoc
+files: 
+- lib/sm2.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- supermemo.gemspec
+has_rdoc: true
+homepage: http://github.com/matholroyd/supermemo
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Supermemo
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: supermemo
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: The SuperMemo (version SM-2) algorithm in ruby
+test_files: []
+