extra/roman/roman-docs.factor

   1 USING: help.markup help.syntax kernel math ;
   2 IN: roman
   3
   4 HELP: >roman
   5 { $values { "n" "an integer" } { "str" "a string" } }
   6 { $description "Converts a number to its lower-case Roman Numeral equivalent." }
   7 { $notes "The range for this word is 1-3999, inclusive." }
   8 { $see-also >ROMAN roman> } ;
   9
  10 HELP: >ROMAN
  11 { $values { "n" "an integer" } { "str" "a string" } }
  12 { $description "Converts a number to its upper-case Roman numeral equivalent." }
  13 { $notes "The range for this word is 1-3999, inclusive." }
  14 { $see-also >roman roman> } ;
  15
  16 HELP: roman>
  17 { $values { "str" "a string" } { "n" "an integer" } }
  18 { $description "Converts a Roman numeral to an integer." }
  19 { $notes "The range for this word is i-mmmcmxcix, inclusive." }
  20 { $see-also >roman } ;
  21
  22 HELP: roman+
  23 { $values { "str1" "a string" } { "str2" "a string" } { "str3" "a string" } }
  24 { $description "Adds two Roman numerals." }
  25 { $see-also roman- } ;
  26
  27 HELP: roman-
  28 { $values { "str1" "a string" } { "str2" "a string" } { "str3" "a string" } }
  29 { $description "Subtracts two Roman numerals." }
  30 { $see-also roman+ } ;
  31
  32 HELP: roman*
  33 { $values { "str1" "a string" } { "str2" "a string" } { "str3" "a string" } }
  34 { $description "Multiplies two Roman numerals." }
  35 { $see-also roman/i roman/mod } ;
  36
  37 HELP: roman/i
  38 { $values { "str1" "a string" } { "str2" "a string" } { "str3" "a string" } }
  39 { $description "Computes the integer division of two Roman numerals." }
  40 { $see-also roman* roman/mod /i } ;
  41
  42 HELP: roman/mod
  43 { $values { "str1" "a string" } { "str2" "a string" } { "str3" "a string" } { "str4" "a string" } }
  44 { $description "Computes the quotient and remainder of two Roman numerals." }
  45 { $see-also roman* roman/i /mod } ;