aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux
blob: adbb1303f75b12739e272f018cc7e27c8443cc03 (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
73
74
75
76
77
78
79
80
81
82
83
84
(.module:
  [library
   [lux #*
    ["$" documentation (#+ documentation:)]
    [control
     ["<>" parser
      ["<.>" code]]]
    [data
     ["." text (#+ \n)
      ["%" format (#+ format)]]]
    [macro
     [syntax (#+ syntax:)]
     ["." code]
     ["." template]]]]
  [\\library
   ["." /]])

(documentation: /.Dictionary
  "A dictionary data-structure with ordered entries.")

(documentation: /.empty
  "An empty dictionary, employing the given order."
  [(empty order)])

(documentation: /.value
  ""
  [(value key dict)])

(documentation: /.key?
  ""
  [(key? dict key)])

(template [<name>]
  [(`` (documentation: <name>
         (format "Yields value under the " (~~ (template.text [<name>])) "imum key.")
         [(<name> dict)]))]

  [/.min]
  [/.max]
  )

(documentation: /.size
  ""
  [(size dict)])

(documentation: /.has
  ""
  [(has key value dict)])

(documentation: /.lacks
  ""
  [(lacks key dict)])

(documentation: /.revised
  ""
  [(revised key transform dict)])

(documentation: /.of_list
  ""
  [(of_list order list)])

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..Dictionary
             ..empty
             ..value
             ..key?

             ..min
             ..max
             
             ..size
             ..has
             ..lacks
             ..revised
             ..of_list
             ($.default /.empty?)
             ($.default /.entries)
             ($.default /.keys)
             ($.default /.values)
             ($.default /.equivalence)]
            []))