basis/optimizer/optimizer-docs.factor

   1 USING: help.markup help.syntax quotations words math
   2 sequences ;
   3 IN: optimizer
   4
   5 ARTICLE: "optimizer" "Optimizer"
   6 "The words in the " { $vocab-link "optimizer" } " vocabulary are internal to the compiler and user code has no reason to call them."
   7 $nl
   8 "The main entry point into the optimizer:"
   9 { $subsection optimize }
  10 { $subsection "specializers" } ;
  11
  12 ABOUT: "optimizer"
  13
  14 HELP: optimize-1
  15 { $values { "node" "a dataflow graph" } { "newnode" "a dataflow graph" } { "?" "a boolean" } }
  16 { $description "Performs a single round of optimization on the dataflow graph, and outputs the new graph together with a new flag indicating if any changes were made." } ;
  17
  18 HELP: optimize
  19 { $values { "node" "a dataflow graph" } { "newnode" "a dataflow graph" } }
  20 { $description "Continues to optimize a dataflow graph until a fixed point is reached." } ;