basis/unrolled-lists/unrolled-lists-docs.factor

   1 IN: unrolled-lists
   2 USING: help.markup help.syntax hashtables search-deques dlists
   3 deques ;
   4
   5 HELP: unrolled-list
   6 { $class-description "The class of unrolled lists." } ;
   7
   8 HELP: <unrolled-list>
   9 { $values { "list" unrolled-list } }
  10 { $description "Creates a new unrolled list." } ;
  11
  12 HELP: <hashed-unrolled-list>
  13 { $values { "search-deque" search-deque } }
  14 { $description "Creates a new " { $link search-deque } " backed by an " { $link unrolled-list } ", with a " { $link hashtable } " for fast membership tests." } ;
  15
  16 ARTICLE: "unrolled-lists" "Unrolled lists"
  17 "The " { $vocab-link "unrolled-lists" } " vocabulary provides an implementation of the " { $link deque } " protocol with constant time insertion and removal at both ends, and lower memory overhead than a " { $link dlist } " due to packing 32 elements per every node. The one tradeoff is that unlike dlists, " { $link delete-node } " is not supported for unrolled lists."
  18 { $subsections
  19     unrolled-list
  20     <unrolled-list>
  21     <hashed-unrolled-list>
  22 } ;
  23
  24 ABOUT: "unrolled-lists"