Skip to content

Commit acb7cdb

Browse files
committed
add example to the first paragraph
1 parent 99fa382 commit acb7cdb

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

doc/specs/stdlib_bitsets.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ title: Bitsets
1111
The `stdlib_bitsets` module implements bitset types. A bitset is a
1212
compact representation of a sequence of `bits` binary values. It can
1313
equivalently be considered as a sequence of logical values or as a
14-
subset of the integers 0 ... `bits-1`. The bits are indexed from 0 to
15-
`bits(bitset)-1`. A bitset is used when space savings are critical in
16-
applications that require a large number
17-
of closely related logical values.
14+
subset of the integers 0 ... `bits-1`. For example, the value `1110`
15+
can be considered as defining the subset of integers [1, 2, 3].
16+
The bits are indexed from 0 to `bits(bitset)-1`.
17+
A bitset is used when space savings are critical in applications
18+
that require a large number of closely related logical values.
1819
It may also improve performance by reducing memory traffic. To
1920
implement bitsets the module
2021
defines three bitset types, multiple constants, a character string

0 commit comments

Comments
 (0)