aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/collection/sequence.lux
blob: 283eca3109e464d8d99eaf648a76659106543500 (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
(.require
 [library
  [lux (.except list has revised)
   ["$" documentation]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]
   [macro
    ["[0]" code]
    ["[0]" template]]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.empty)
             ($.default /.size)
             ($.default /.index_out_of_bounds)
             ($.default /.of_list)
             ($.default /.empty?)
             ($.default /.equivalence)
             ($.default /.mix)
             ($.default /.monoid)
             ($.default /.functor)
             ($.default /.apply)
             ($.default /.monad)
             ($.default /.reversed)
             ($.default /.every?)
             ($.default /.any?)

             ($.documentation (/.Sequence it)
               "A sequential data-structure with fast random access.")

             ($.documentation /.suffix
               ""
               [(suffix val sequence)])

             ($.documentation /.within_bounds?
               "Determines whether the index is within the bounds of the sequence."
               [(within_bounds? sequence idx)])

             ($.documentation /.item
               ""
               [(item idx sequence)])

             ($.documentation /.has
               ""
               [(has idx val sequence)])

             ($.documentation /.revised
               ""
               [(revised idx f sequence)])

             ($.documentation /.prefix
               ""
               [(prefix sequence)])

             ($.documentation /.list
               ""
               [(list sequence)])

             ($.documentation /.member?
               ""
               [(member? equivalence sequence val)])

             ($.documentation /.sequence
               "Sequence literals."
               [(is (Sequence Nat)
                    (sequence 12 34 56 78 90))])]
            []))