review.lua (bf1d7e3) - memoire

review.lua

--[[
    stuff to help with the review mechanics
]]

--[[
    determines the delay until next review (in seconds)
    when `Prompt` `prompt` is reviewed at timestamp `revtime`
    with review success `revsucc`
]]
local function schedule(prompt, revtime, revsucc, conf)
    if revsucc and revsucc > 0 then
        local ad = revtime - (prompt.time or revtime)
        return (conf:get("DelayRatio") or 2.5) ^ revsucc * (ad + math.max(40000 - 0.5 * ad, 0))
    else
        return 15
    end
end

--[[
    manipulates `Prompt` `prompt` in-place as it should be
    when reviewed at timestamp `revtime` with review success `revsucc`
]]
local function update(prompt, revtime, revsucc, conf)
    if revsucc and revsucc > 0 then
        prompt.succ = (prompt.succ or 0) + 1
    else
        prompt.fail = (prompt.fail or 0) + 1
    end
    -- allowed random variation, as a fraction of the "optimal" duration
    local ARV = conf:get("AllowedRandomVariation") or 0.1
    prompt.delay = schedule(prompt, revtime, revsucc, conf) * ((1 - ARV) + 2 * ARV * math.random())
    prompt.time = revtime
end

--[[
    checks (returns boolean) if `Prompt` `prompt` should be reviewed now
]]
local function should(prompt)
    return os.time() - (prompt.time or 0) >= (prompt.delay or 0)
end

--[[
    returns a shuffled version of the table,
    destroying the table in-place
    adapted from
    https://stackoverflow.com/q/55192727
]]
local function shuffle(t)
    local ret = {}
    local ci = 1
    while #t > 0 do
        local ri = math.random(1, #t)
        ret[ci] = t[ri]
        table.remove(t, ri)
        ci = ci + 1
    end
    return ret
end

local function alwaystrue(x)
    return true
end

--[[
    returns a table of pairs of integers to index the deck
    to get prompts to be reviewed now;
    prompts are shuffled in order
    if a filter function is provided, filters the list accordingly,
    calling the filter function on each `Prompt`
]]
local function toreviewlist(deck, filter)
    local ctrt = {}
    local ff = filter or alwaystrue
    for i, cg in ipairs(deck) do
        for j, pr in ipairs(cg) do
            if should(pr) and ff(pr) then
                table.insert(ctrt, { i, j })
            end
        end
    end
    ctrt = shuffle(ctrt)
    return ctrt
end

return { schedule = schedule, update = update, should = should, list = toreviewlist }

memoire

Fix deficiency in 8433404