aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/collection/bits.lux
blob: 522f7eccd70a4ab55c5542c7dffbc56150a8927c (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
(.require
 [library
  [lux (.except)
   ["$" documentation]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.Chunk)
             ($.default /.chunk_size)
             ($.default /.empty)
             ($.default /.empty?)
             ($.default /.equivalence)
             ($.default /.one)
             ($.default /.zero)
             ($.default /.flipped)
             ($.default /.and)
             ($.default /.or)
             ($.default /.xor)

             ($.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)])]
            []))