aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/collection/bits.lux
blob: e8758f50b72af8248bbbf295a3a930b7758e38a4 (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
(.module:
  [library
   [lux {"-" or and not}
    ["$" documentation {"+" documentation:}]
    [control
     ["<>" parser
      ["<[0]>" code]]]
    [data
     ["[0]" text {"+" \n}
      ["%" format {"+" format}]]]
    [macro
     [syntax {"+" syntax:}]
     ["[0]" code]
     ["[0]" template]]]]
  [\\library
   ["[0]" /]])

(documentation: /.Bits
  "A bit-map.")

(documentation: /.size
  "Measures the size of a bit-map by counting all the 1s in the bit-map."
  [(size bits)])

(documentation: /.capacity
  ""
  [(capacity bits)])

(documentation: /.bit
  ""
  [(bit index bits)])

(documentation: /.intersects?
  ""
  [(intersects? reference sample)])

(documentation: /.not
  ""
  [(not input)])

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..Bits
             ..size
             ..capacity
             ..bit
             
             ..intersects?
             ..not
             
             ($.default /.Chunk)
             ($.default /.chunk_size)
             ($.default /.empty)
             ($.default /.empty?)
             ($.default /.equivalence)
             ($.default /.one)
             ($.default /.zero)
             ($.default /.flipped)
             ($.default /.and)
             ($.default /.or)
             ($.default /.xor)]
            []))