Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edubkendo/supermemo
An Elixir implementation of the Supermemo 2 algorithm
https://github.com/edubkendo/supermemo
Last synced: 2 months ago
JSON representation
An Elixir implementation of the Supermemo 2 algorithm
- Host: GitHub
- URL: https://github.com/edubkendo/supermemo
- Owner: edubkendo
- License: mit
- Created: 2014-11-27T06:53:36.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-02-05T02:31:30.000Z (almost 5 years ago)
- Last Synced: 2024-11-01T06:34:28.138Z (2 months ago)
- Language: Elixir
- Size: 13.7 KB
- Stars: 18
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - An Elixir implementation of the [Supermemo 2 algorithm](https://www.supermemo.com/english/ol/sm2.htm). (Algorithms and Data structures)
- fucking-awesome-elixir - supermemo - An Elixir implementation of the [Supermemo 2 algorithm](https://www.supermemo.com/english/ol/sm2.htm). (Algorithms and Data structures)
- awesome-elixir - supermemo - An Elixir implementation of the [Supermemo 2 algorithm](https://www.supermemo.com/english/ol/sm2.htm). (Algorithms and Data structures)
README
Supermemo
=========A library for calculating the next time a flashcard should be shown.
Based on the Supermemo 2 algorithm described [here](http://www.supermemo.com/english/ol/sm2.htm) and the Ruby implementation of it used in [dpwright/srs](https://github.com/dpwright/srs).
## Install
Add Supermemo to your mix.exs:
```elixir
def deps do
[ {:supermemo, "~> 1.0.0"} ]
end
```## Usage
```elixir
# Initial reprep = Supermemo.rep(1)
# %Supermemo.Rep{due: %Timex.DateTime{calendar: :gregorian, day: 29, hour: 5,
# minute: 45, month: 11, ms: 0, second: 18,
# timezone: %Timex.TimezoneInfo{dst_abbreviation: "UTC", dst_end_day: :undef,
# dst_end_time: {0, 0}, dst_name: "UTC", dst_start_day: :undef,
# dst_start_time: {0, 0}, full_name: "UTC", gmt_offset_dst: 0,
# gmt_offset_std: 0, standard_abbreviation: "UTC", standard_name: "UTC"},
# year: 2014}, e_factor: 2.6, interval: 1, iteration: 1, repeat: false}# Do a rep with the card and get a new score.
rep = Supermemo.rep(1, rep)
# %Supermemo.Rep{due: %Timex.DateTime{calendar: :gregorian, day: 4, hour: 5,
# minute: 45, month: 12, ms: 0, second: 23,
# timezone: %Timex.TimezoneInfo{dst_abbreviation: "UTC", dst_end_day: :undef,
# dst_end_time: {0, 0}, dst_name: "UTC", dst_start_day: :undef,
# dst_start_time: {0, 0}, full_name: "UTC", gmt_offset_dst: 0,
# gmt_offset_std: 0, standard_abbreviation: "UTC", standard_name: "UTC"},
# year: 2014}, e_factor: 2.7, interval: 6, iteration: 2, repeat: false}# Another rep
third_rep = Supermemo.rep(0.8, rep)
# ...
```