basis/bit-sets/bit-sets-docs.factor

   1 USING: help.markup help.syntax math sequences ;
   2 IN: bit-sets
   3
   4 ARTICLE: "bit-sets" "Bit sets"
   5 "The " { $vocab-link "bit-sets" } " vocabulary implements bit-array-backed sets. Bitsets are efficient for implementing relatively dense sets whose members are in a contiguous range of integers starting from 0. One bit is required for each integer in this range in the underlying representation." $nl
   6 "Bit sets form a class:"
   7 { $subsection bit-set }
   8 "Constructing new bit sets:"
   9 { $subsection <bit-set> } ;
  10
  11 ABOUT: "bit-sets"
  12
  13 HELP: bit-set
  14 { $class-description "The class of bit-array-based " { $link "sets" } "." } ;
  15
  16 HELP: <bit-set>
  17 { $values { "capacity" integer } { "bit-set" bit-set } }
  18 { $description "Creates a new bit set with the given capacity. This set is initially empty and can contain as members integers between 0 and " { $snippet "capacity" } "-1." } ;