extra/project-euler/ave-time/ave-time-docs.factor

   1 USING: help.markup help.syntax math quotations sequences ;
   2 IN: project-euler.ave-time
   3
   4 HELP: collect-benchmarks
   5 { $values { "quot" quotation } { "n" integer } { "seq" sequence } }
   6 { $description "Runs a quotation " { $snippet "n" } " times, collecting the wall clock time inside of a sequence." }
   7 { $notes "The stack effect of " { $snippet "quot" } " is accounted for and only one set of outputs will remain on the stack no matter how many trials are run."
   8     $nl
   9     "A nicer word for interactive use is " { $link ave-time } "." } ;
  10
  11 HELP: ave-time
  12 { $values { "quot" quotation } { "n" integer } }
  13 { $description "Runs a quotation " { $snippet "n" } " times, then prints the average run time and standard deviation." }
  14 { $notes "The stack effect of " { $snippet "quot" } " is accounted for and only one set of outputs will remain on the stack no matter how many trials are run." }
  15 { $examples
  16     "This word can be used to compare performance of the non-optimizing and optimizing compilers."
  17     $nl
  18     "First, we time a quotation directly; quotations are compiled by the non-optimizing quotation compiler:"
  19     { $unchecked-example "[ 1000000 0 [ + ] reduce drop ] 10 ave-time" "465 ms ave run time - 13.37 SD (10 trials)" }
  20     "Now we define a word and compile it with the optimizing word compiler. This results in faster execution:"
  21     { $unchecked-example ": foo 1000000 0 [ + ] reduce ;" "\\ foo compile" "[ foo drop ] 10 ave-time" "202 ms ave run time - 22.73 SD (10 trials)" }
  22 } ;