extra/math/compare/compare-docs.factor

   1 USING: help.markup help.syntax math ;
   2 IN: math.compare
   3
   4 HELP: absmin
   5 { $values { "a" number } { "b" number } { "x" number } }
   6 { $description "Returns the smaller absolute number with the original sign." } ;
   7
   8 HELP: absmax
   9 { $values { "a" number } { "b" number } { "x" number } }
  10 { $description "Returns the larger absolute number with the original sign." } ;
  11
  12 HELP: posmax
  13 { $values { "a" number } { "b" number } { "x" number } }
  14 { $description "Returns the most-positive value, or zero if both are negative." } ;
  15
  16 HELP: negmin
  17 { $values { "a" number } { "b" number } { "x" number } }
  18 { $description "Returns the most-negative value, or zero if both are positive." } ;
  19
  20 HELP: clamp
  21 { $values { "a" number } { "value" number } { "b" number } { "x" number } }
  22 { $description "Returns the value when between " { $snippet "a" } " and " { $snippet "b" } ", " { $snippet "a" } " if <= " { $snippet "a" } ", or " { $snippet "b" } " if >= " { $snippet "b" } "." } ;
  23