zig-fsrs

This is an implementation of FSRS-4.5 in Zig.
This project is on zig 0.13.0

const std = @import("std");
const fsrs = @import("zig-fsrs");
const Card = fsrs.Card;

pub fn main() !void {
    var f = fsrs.FSRS.init(.{});
    const initial_card = fsrs.Card.init();
    var now = std.time.timestamp();

    // schedule the initial card
    var s = f.schedule(initial_card, now);

    // good was selected on new card
    const updated_card = s.select(.Good).card;

    std.debug.print("initial card:\n{}\n\n", .{initial_card});
    std.debug.print("after first rep (good):\n{}\n\n", .{updated_card});
}

Getting Started

1. Add zig-fsrs to your own zig project:

Fetch zig-fsrs:

zig fetch --save git+https://github.com/egegungordu/zig-fsrs

2. Add zig-fsrs to your build.zig file:

const zig_fsrs = b.dependency("zig-fsrs", .{});
exe.root_module.addImport("zig-fsrs", zig_fsrs.module("zig-fsrs"));

Now you can import zig-fsrs in your code:

const fsrs = @import("zig-fsrs");

Basic Usage

1. Create a new FSRS instance

var f = fsrs.FSRS.init(.{});

The parameters are optional. The parameters are:

2. Create a new card

const initial_card = fsrs.Card.init();

3. Schedule the card

const review_time = std.time.timestamp();
var scheduled_cards = f.schedule(initial_card, review_time);

schedule() will return a ScheduledCards struct which contains the possible cards given the rating. To select a card, use the select method, which will return a ReviewedCard struct.

const good = scheduled_cards.select(.Good);
const new_card = good.card;

Card fields

Examples

To run the examples:

zig build example -Dexample=example_name

Check out the examples directory for more examples.

Development

git clone https://github.com/egegungordu/zig-fsrs.git
cd zig-fsrs

To run the tests:

zig build test --summary all