extra/trees/avl/avl-docs.factor

   1 USING: help.syntax help.markup assocs ;
   2 IN: trees.avl
   3
   4 HELP: AVL{
   5 { $syntax "AVL{ { key value }... }" }
   6 { $values { "key" "a key" } { "value" "a value" } }
   7 { $description "Literal syntax for an AVL tree." } ;
   8
   9 HELP: <avl>
  10 { $values { "tree" avl } }
  11 { $description "Creates an empty AVL tree" } ;
  12
  13 HELP: >avl
  14 { $values { "assoc" assoc } { "avl" avl } }
  15 { $description "Converts any " { $link assoc } " into an AVL tree." } ;
  16
  17 HELP: avl
  18 { $class-description "This is the class for AVL trees. These conform to the assoc protocol and have efficient (logarithmic time) storage and retrieval operations." } ;
  19
  20 ARTICLE: { "avl" "intro" } "AVL trees"
  21 "This is a library for AVL trees, with logarithmic time storage and retrieval operations. These trees conform to the assoc protocol."
  22 { $subsection avl }
  23 { $subsection <avl> }
  24 { $subsection >avl }
  25 { $subsection POSTPONE: AVL{ } ;
  26
  27 ABOUT: { "avl" "intro" }