aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/function/memo.lux
blob: 0f07fdf3304b619f364880f6c0c771e439182cde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
(.using
 [library
  [lux {"-" open}
   ["$" documentation (.only documentation:)]
   [data
    [text (.only \n)
     ["%" format (.only format)]]]
   [macro
    ["[0]" template]]]]
 [\\library
  ["[0]" /]])

(documentation: /.open
  "Memoization where the memoized results can be re-used accross invocations."
  [(open memo)])

(documentation: /.closed
  (format "Memoization confined to a single invocation to the function (not counting any subsequent recursive invocations)."
          \n "Memoized results will be re-used during recursive invocations, but cannot be accessed after the main invocation has ended.")
  [(closed hash memo)])

(documentation: /.none
  (format "No memoization at all."
          \n "This is useful as a test control when measuring the effect of using memoization.")
  [(none hash memo)])

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..open
             ..closed
             ..none
             ($.default /.memoization)
             ($.default (/.Memo input output))]
            []))