basis/math/bitwise/bitwise-docs.factor

   1 ! Copyright (C) 2008 Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax math sequences ;
   4 IN: math.bitwise
   5
   6 HELP: bitfield
   7 { $values { "values..." "a series of objects" } { "bitspec" "an array" } { "n" integer } }
   8 { $description "Constructs an integer from a series of values on the stack together with a bit field specifier, which is an array whose elements have one of the following shapes:"
   9     { $list
  10         { { $snippet "{ constant shift }" } " - the resulting bit field is bitwise or'd with " { $snippet "constant" } " shifted to the right by " { $snippet "shift" } " bits" }
  11         { { $snippet "{ word shift }" } " - the resulting bit field is bitwise or'd with " { $snippet "word" } " applied to the top of the stack; the result is shifted to the right by " { $snippet "shift" } " bits" }
  12         { { $snippet "shift" } " - the resulting bit field is bitwise or'd with the top of the stack; the result is shifted to the right by " { $snippet "shift" } " bits" }
  13     }
  14 "The bit field specifier is processed left to right, so stack values should be supplied in reverse order." }
  15 { $examples
  16     "Consider the following specification:"
  17     { $list
  18         { "bits 0-10 are set to the value of " { $snippet "x" } }
  19         { "bits 11-14 are set to the value of " { $snippet "y" } }
  20         { "bit 15 is always on" }
  21         { "bits 16-20 are set to the value of " { $snippet "fooify" } " applied to " { $snippet "z" } }
  22     }
  23     "Such a bit field construction can be specified with a word like the following:"
  24     { $code
  25         ": baz-bitfield ( x y z -- n )"
  26         "    {"
  27         "        { fooify 16 }"
  28         "        { 1 15 }"
  29         "        11"
  30         "        0"
  31         "    } ;"
  32     }
  33 } ;
  34
  35 HELP: bits
  36 { $values { "m" integer } { "n" integer } { "m'" integer } }
  37 { $description "Keep only n bits from the integer m." }
  38 { $example "USING: math.bitwise prettyprint ;" "HEX: 123abcdef 16 bits .h" "cdef" } ;
  39
  40 HELP: bitroll
  41 { $values { "x" integer } { "s" "a shift integer" } { "w" "a wrap integer" } { "y" integer }
  42 }
  43 { $description "Roll n by s bits to the left, wrapping around after w bits." }
  44 { $examples
  45     { $example "USING: math.bitwise prettyprint ;" "1 -1 32 bitroll .b" "10000000000000000000000000000000" }
  46     { $example "USING: math.bitwise prettyprint ;" "HEX: ffff0000 8 32 bitroll .h" "ff0000ff" }
  47 } ;
  48
  49 HELP: bit-clear?
  50 { $values
  51      { "x" integer } { "n" integer }
  52      { "?" "a boolean" }
  53 }
  54 { $description "Returns " { $link t } " if the nth bit is set to zero." }
  55 { $examples
  56     { $example "USING: math.bitwise prettyprint ;"
  57                "HEX: ff 8 bit-clear? ."
  58                "t"
  59     }
  60     { $example "" "USING: math.bitwise prettyprint ;"
  61                "HEX: ff 7 bit-clear? ."
  62                "f"
  63     }
  64 } ;
  65
  66 { bit? bit-clear? set-bit clear-bit } related-words
  67
  68 HELP: bit-count
  69 { $values
  70      { "x" integer }
  71      { "n" integer }
  72 }
  73 { $description "Returns the number of set bits as an integer." }
  74 { $examples
  75     { $example "USING: math.bitwise prettyprint ;"
  76                "HEX: f0 bit-count ."
  77                "4"
  78     }
  79     { $example "USING: math.bitwise prettyprint ;"
  80                "-7 bit-count ."
  81                "2"
  82     }
  83 } ;
  84
  85 HELP: bitroll-32
  86 { $values
  87      { "n" integer } { "s" integer }
  88      { "n'" integer }
  89 }
  90 { $description "Rolls the number " { $snippet "n" } " by " { $snippet "s" } " bits to the left, wrapping around after 32 bits." }
  91 { $examples
  92     { $example "USING: math.bitwise prettyprint ;"
  93                "HEX: 1 10 bitroll-32 .h"
  94                "400"
  95     }
  96     { $example "USING: math.bitwise prettyprint ;"
  97                "HEX: 1 -10 bitroll-32 .h"
  98                "400000"
  99     }
 100 } ;
 101
 102 HELP: bitroll-64
 103 { $values
 104      { "n" integer } { "s" "a shift integer" }
 105      { "n'" integer }
 106 }
 107 { $description "Rolls the number " { $snippet "n" } " by " { $snippet "s" } " bits to the left, wrapping around after 64 bits." }
 108 { $examples
 109     { $example "USING: math.bitwise prettyprint ;"
 110                "HEX: 1 10 bitroll-64 .h"
 111                "400"
 112     }
 113     { $example "USING: math.bitwise prettyprint ;"
 114                "HEX: 1 -10 bitroll-64 .h"
 115                "40000000000000"
 116     }
 117 } ;
 118
 119 { bitroll bitroll-32 bitroll-64 } related-words
 120
 121 HELP: clear-bit
 122 { $values
 123      { "x" integer } { "n" integer }
 124      { "y" integer }
 125 }
 126 { $description "Sets the nth bit of " { $snippet "x" } " to zero." }
 127 { $examples
 128     { $example "USING: math.bitwise kernel prettyprint ;"
 129         "HEX: ff 7 clear-bit .h"
 130         "7f"
 131     }
 132 } ;
 133
 134 HELP: flags
 135 { $values
 136      { "values" sequence }
 137 }
 138 { $description "Constructs a constant flag value from a sequence of integers or words that output integers. The resulting constant is computed at compile-time, which makes this word as efficient as using a literal integer." }
 139 { $examples
 140     { $example "USING: math.bitwise kernel prettyprint ;"
 141         "IN: scratchpad"
 142         ": MY-CONSTANT HEX: 1 ; inline"
 143         "{ HEX: 20 MY-CONSTANT BIN: 100 } flags .h"
 144         "25"
 145     }
 146 } ;
 147
 148 HELP: mask
 149 { $values
 150      { "x" integer } { "n" integer }
 151      { "?" "a boolean" }
 152 }
 153 { $description "After the operation, only the bits that were set in both the mask and the original number are set." }
 154 { $examples
 155     { $example "USING: math.bitwise kernel prettyprint ;"
 156         "BIN: 11111111 BIN: 101 mask .b"
 157         "101"
 158     }
 159 } ;
 160
 161 HELP: mask-bit
 162 { $values
 163      { "m" integer } { "n" integer }
 164      { "m'" integer }
 165 }
 166 { $description "Turns off all bits besides the nth bit." }
 167 { $examples
 168     { $example "USING: math.bitwise kernel prettyprint ;"
 169         "HEX: ff 2 mask-bit .b"
 170         "100"
 171     }
 172 } ;
 173
 174 HELP: mask?
 175 { $values
 176      { "x" integer } { "n" integer }
 177      { "?" "a boolean" }
 178 }
 179 { $description "Returns true if all of the bits in the mask " { $snippet "n" } " are set in the integer input " { $snippet "x" } "." }
 180 { $examples
 181     { $example "USING: math.bitwise kernel prettyprint ;"
 182         "HEX: ff HEX: f mask? ."
 183         "t"
 184     }
 185
 186     { $example "USING: math.bitwise kernel prettyprint ;"
 187         "HEX: f0 HEX: 1 mask? ."
 188         "f"
 189     }
 190 } ;
 191
 192 HELP: on-bits
 193 { $values
 194      { "n" integer }
 195      { "m" integer }
 196 }
 197 { $description "Returns an integer with " { $snippet "n" } " bits set." }
 198 { $examples
 199     { $example "USING: math.bitwise kernel prettyprint ;"
 200         "6 on-bits .h"
 201         "3f"
 202     }
 203     { $example "USING: math.bitwise kernel prettyprint ;"
 204         "64 on-bits .h"
 205         "ffffffffffffffff"
 206     }
 207 }
 208 ;
 209
 210 HELP: set-bit
 211 { $values
 212      { "x" integer } { "n" integer }
 213      { "y" integer }
 214 }
 215 { $description "Sets the nth bit of " { $snippet "x" } "." }
 216 { $examples
 217     { $example "USING: math.bitwise kernel prettyprint ;"
 218         "0 5 set-bit .h"
 219         "20"
 220     }
 221 } ;
 222
 223 HELP: shift-mod
 224 { $values
 225      { "n" integer } { "s" integer } { "w" integer }
 226      { "n" integer }
 227 }
 228 { $description "" } ;
 229
 230 HELP: unmask
 231 { $values
 232      { "x" integer } { "n" integer }
 233      { "?" "a boolean" }
 234 }
 235 { $description "Clears the bits in " { $snippet "x" } " if they are set in the mask " { $snippet "n" } "." }
 236 { $examples
 237     { $example "USING: math.bitwise kernel prettyprint ;"
 238         "HEX: ff  HEX: 0f unmask .h"
 239         "f0"
 240     }
 241 } ;
 242
 243 HELP: unmask?
 244 { $values
 245      { "x" integer } { "n" integer }
 246      { "?" "a boolean" }
 247 }
 248 { $description "Tests whether unmasking the bits in " { $snippet "x" } " would return an integer greater than zero." }
 249 { $examples
 250     { $example "USING: math.bitwise kernel prettyprint ;"
 251         "HEX: ff  HEX: 0f unmask? ."
 252         "t"
 253     }
 254 } ;
 255
 256 HELP: w*
 257 { $values
 258      { "int" integer } { "int" integer }
 259      { "int" integer }
 260 }
 261 { $description "Multiplies two integers and wraps the result to 32 bits." }
 262 { $examples
 263     { $example "USING: math.bitwise kernel prettyprint ;"
 264         "HEX: ffffffff HEX: 2 w* ."
 265         "4294967294"
 266     }
 267 } ;
 268
 269 HELP: w+
 270 { $values
 271      { "int" integer } { "int" integer }
 272      { "int" integer }
 273 }
 274 { $description "Adds two integers and wraps the result to 32 bits." }
 275 { $examples
 276     { $example "USING: math.bitwise kernel prettyprint ;"
 277         "HEX: ffffffff HEX: 2 w+ ."
 278         "1"
 279     }
 280 } ;
 281
 282 HELP: w-
 283 { $values
 284      { "int" integer } { "int" integer }
 285      { "int" integer }
 286 }
 287 { $description "Subtracts two integers and wraps the result to 32 bits." }
 288 { $examples
 289     { $example "USING: math.bitwise kernel prettyprint ;"
 290         "HEX: 0 HEX: ff w- ."
 291         "4294967041"
 292     }
 293 } ;
 294
 295 HELP: wrap
 296 { $values
 297      { "m" integer } { "n" integer }
 298      { "m'" integer }
 299 }
 300 { $description "Wraps an integer " { $snippet "m" } " by modding it by " { $snippet "n" } ". This word is uses bitwise arithmetic and does not actually call the modulus word, and as such can only mod by powers of two." }
 301 { $examples "Equivalent to modding by 8:"
 302     { $example
 303         "USING: math.bitwise prettyprint ;"
 304         "HEX: ffff 8 wrap .h"
 305         "7"
 306     }
 307 } ;
 308
 309 ARTICLE: "math-bitfields" "Constructing bit fields"
 310 "Some applications, such as binary communication protocols and assemblers, need to construct integers from elaborate bit field specifications. Hand-coding this using " { $link shift } " and " { $link bitor } " results in repetitive code. A higher-level facility exists to factor out this repetition:"
 311 { $subsection bitfield } ;
 312
 313 ARTICLE: "math.bitwise" "Additional bitwise arithmetic"
 314 "The " { $vocab-link "math.bitwise" } " vocabulary provides bitwise arithmetic words extending " { $link "bitwise-arithmetic" } ". They are useful for efficiency, low-level programming, and interfacing with C libraries."
 315 $nl
 316 "Setting and clearing bits:"
 317 { $subsection set-bit }
 318 { $subsection clear-bit }
 319 "Testing if bits are set or clear:"
 320 { $subsection bit? }
 321 { $subsection bit-clear? }
 322 "Operations with bitmasks:"
 323 { $subsection mask }
 324 { $subsection unmask }
 325 { $subsection mask? }
 326 { $subsection unmask? }
 327 "Generating an integer with n set bits:"
 328 { $subsection on-bits }
 329 "Counting the number of set bits:"
 330 { $subsection bit-count }
 331 "More efficient modding by powers of two:"
 332 { $subsection wrap }
 333 "Bit-rolling:"
 334 { $subsection bitroll }
 335 { $subsection bitroll-32 }
 336 { $subsection bitroll-64 }
 337 "32-bit arithmetic:"
 338 { $subsection w+ }
 339 { $subsection w- }
 340 { $subsection w* }
 341 "Bitfields:"
 342 { $subsection flags }
 343 { $subsection "math-bitfields" } ;
 344
 345 ABOUT: "math.bitwise"