aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/collection/stack.lux
blob: 557564f9265b2a6240895ba3f5aa3e3e841c6218 (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
37
38
39
40
41
42
43
44
(.module:
  [library
   [lux (#- list)
    ["$" documentation (#+ documentation:)]
    [control
     ["<>" parser
      ["<.>" code]]]
    [data
     ["." text (#+ \n)
      ["%" format (#+ format)]]]
    [macro
     ["." template]]]]
  [\\library
   ["." /]])

(documentation: (/.Stack it)
  "A first-in, last-out sequential data-structure.")

(documentation: /.value
  "Yields the top value in the stack, if any."
  [(value stack)])

(documentation: /.next
  ""
  [(next stack)])

(documentation: /.top
  ""
  [(top value stack)])

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..Stack
             ..value
             ..next
             ..top
             ($.default /.empty)
             ($.default /.size)
             ($.default /.empty?)
             ($.default /.equivalence)
             ($.default /.functor)]
            []))