extra/math/extras/extras-docs.factor

   1 ! Copyright (C) 2012 John Benediktsson
   2 ! See http://factorcode.org/license.txt for BSD license
   3
   4 USING: help.markup help.syntax math sequences ;
   5
   6 IN: math.extras
   7
   8 HELP: bernoulli
   9 { $values { "p" integer } { "n" rational } }
  10 { $description "Return the Bernoulli number " { $snippet "p" } "." } ;
  11
  12 HELP: sterling
  13 { $values { "n" integer } { "k" integer } { "x" integer } }
  14 { $description "Return the Stirling number of the second kind for a set with " { $snippet "n" } " elements partitioned into " { $snippet "k" } " disjoint non-empty sets." } ;
  15
  16 HELP: chi2
  17 { $values { "actual" sequence } { "expected" sequence } { "n" real } }
  18 { $description "Return the chi-squared metric between " { $snippet "actual" } " and " { $snippet "expected" } " observations." } ;
  19
  20 HELP: chi2P
  21 { $values { "chi" real } { "df" real } { "p" real } }
  22 { $description "Returns the inverse chi-squared value according to " { $snippet "P(chi|df) = P(df/2,chi/2)" } "." } ;
  23