extra/trees/trees-docs.factor

   1 USING: help.syntax help.markup assocs ;
   2 IN: trees
   3
   4 HELP: TREE{
   5 { $syntax "TREE{ { key value }... }" }
   6 { $values { "key" "a key" } { "value" "a value" } }
   7 { $description "Literal syntax for an unbalanced tree." } ;
   8
   9 HELP: <tree>
  10 { $values { "tree" tree } }
  11 { $description "Creates an empty unbalanced binary tree" } ;
  12
  13 HELP: >tree
  14 { $values { "assoc" assoc } { "tree" tree } }
  15 { $description "Converts any " { $link assoc } " into an unbalanced binary tree." } ;
  16
  17 HELP: tree
  18 { $class-description "This is the class for unbalanced binary search trees. It is not usually intended to be used directly but rather as a basis for other trees." } ;
  19
  20 ARTICLE: { "trees" "intro" } "Binary search trees"
  21 "This is a library for unbalanced binary search trees. It is not intended to be used directly in most situations but rather as a base class for new trees, because performance can degrade to linear time storage/retrieval by the number of keys. These binary search trees conform to the assoc protocol."
  22 { $subsection tree }
  23 { $subsection <tree> }
  24 { $subsection >tree }
  25 { $subsection POSTPONE: TREE{ } ;
  26
  27 IN: trees
  28 ABOUT: { "trees" "intro" }