extra/math/bitfields/lib/lib-docs.factor

   1 USING: help.markup help.syntax kernel math sequences ;
   2 IN: math.bitfields.lib
   3
   4 HELP: bits
   5 { $values { "m" integer } { "n" integer } { "m'" integer } }
   6 { $description "Keep only n bits from the integer m." }
   7 { $example "USING: math.bitfields.lib prettyprint ;" "HEX: 123abcdef 16 bits .h" "cdef" } ;
   8
   9 HELP: bitroll
  10 { $values { "x" "an integer (input)" } { "s" "an integer (shift)" } { "w" "an integer (wrap)" } { "y" integer } }
  11 { $description "Roll n by s bits to the left, wrapping around after w bits." }
  12 { $examples
  13     { $example "USING: math.bitfields.lib prettyprint ;" "1 -1 32 bitroll .b" "10000000000000000000000000000000" }
  14     { $example "USING: math.bitfields.lib prettyprint ;" "HEX: ffff0000 8 32 bitroll .h" "ff0000ff" }
  15 } ;
  16