extra/trees/splay/splay-docs.factor

   1 USING: help.syntax help.markup assocs ;
   2 IN: trees.splay
   3
   4 HELP: SPLAY{
   5 { $syntax "SPLAY{ { key value }... }" }
   6 { $values { "key" "a key" } { "value" "a value" } }
   7 { $description "Literal syntax for an splay tree." } ;
   8
   9 HELP: <splay>
  10 { $values { "tree" splay } }
  11 { $description "Creates an empty splay tree" } ;
  12
  13 HELP: >splay
  14 { $values { "assoc" assoc } { "tree" splay } }
  15 { $description "Converts any " { $link assoc } " into an splay tree." } ;
  16
  17 HELP: splay
  18 { $class-description "This is the class for splay trees. Splay trees have amortized average-case logarithmic time storage and retrieval operations, and better complexity on more skewed lookup distributions, though in bad situations they can degrade to linear time, resembling a linked list. These conform to the assoc protocol." } ;
  19
  20 ARTICLE: "trees.splay" "Splay trees"
  21 "This is a library for splay trees. Splay trees have amortized average-case logarithmic time storage and retrieval operations, and better complexity on more skewed lookup distributions, though in bad situations they can degrade to linear time, resembling a linked list. These trees conform to the assoc protocol."
  22 { $subsections
  23     splay
  24     <splay>
  25     >splay
  26     POSTPONE: SPLAY{
  27 } ;
  28
  29 ABOUT: "trees.splay"