This is the bit-smasher Reference Manual, version 1.0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:43:38 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
bit-smasherUtility library for handling bit vectors, bit vector arithmetic, and universal integer type conversions between bit-vectors, byte-vectors, octals, decimals, and hexadecimal notation.
"the Phoeron" Colin J.E. Lupton
(GIT https://gitlab.common-lisp.net/thephoeron/bit-smasher/)
https://gitlab.common-lisp.net/thephoeron/bit-smasher/-/issues/
MIT
1.0.4
cl-base58 (system).
cl-base64 (system).
packages.lisp (file).
core.lisp (file).
from-ironclad.lisp (file).
conversion.lisp (file).
arithmetic.lisp (file).
aliases.lisp (file).
utils.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
bit-smasher/bit-smasher.asdbit-smasher/packages.lispbit-smasher/core.lispbit-smasher/from-ironclad.lispbit-smasher/conversion.lispbit-smasher/arithmetic.lispbit-smasher/aliases.lispbit-smasher/utils.lispbit-smasher/bit-smasher.asdbit-smasher (system).
bit-smasher/core.lisppackages.lisp (file).
bit-smasher (system).
*bit-map* (special variable).
hex-char (type).
hex-to-bit-lookup (function).
hex-to-bit-lookup/unsafe (function).
hexchar->int (function).
bit-smasher/from-ironclad.lispcore.lisp (file).
bit-smasher (system).
byte-array-to-hex-string (function).
hex-string-to-byte-array (function).
integer-to-octets (function).
octets-to-integer (function).
bit-smasher/conversion.lispfrom-ironclad.lisp (file).
bit-smasher (system).
bits->hex (function).
bits->int (function).
bits->octets (function).
bits<- (function).
hex->bits (function).
hex->int (function).
hex->octets (function).
hex<- (function).
int->bits (function).
int->hex (function).
int->octets (function).
int<- (function).
octets->bits (function).
octets->hex (function).
octets->int (function).
octets<- (function).
bit-smasher/arithmetic.lispconversion.lisp (file).
bit-smasher (system).
bit-ceiling (function).
bit-difference (function).
bit-floor (function).
bit-product (function).
bit-quotient (function).
bit-sum (function).
lshift (function).
rshift (function).
bit-vector-integer-value-and-place (function).
bit-smasher/aliases.lisparithmetic.lisp (file).
bit-smasher (system).
bit-smasher/utils.lispaliases.lisp (file).
bit-smasher (system).
byte-length (function).
min-bit-length (function).
twos-complement-p (function).
wide-bit-length (function).
Packages are listed by definition order.
bit-smasherbitsmash
common-lisp.
common-lisp-user.
<< (function).
>> (function).
bit* (function).
bit+ (function).
bit- (function).
bit-ceiling (function).
bit-difference (function).
bit-floor (function).
bit-product (function).
bit-quotient (function).
bit-sum (function).
bit/ (function).
bits->hex (function).
bits->int (function).
bits->octets (function).
bits<- (function).
byte-length (function).
hex->bits (function).
hex->int (function).
hex->octets (function).
hex<- (function).
int->bits (function).
int->hex (function).
int->octets (function).
int<- (function).
lshift (function).
min-bit-length (function).
octets->bits (function).
octets->hex (function).
octets->int (function).
octets<- (function).
rshift (function).
twos-complement-p (function).
wide-bit-length (function).
*bit-map* (special variable).
bit-vector-integer-value-and-place (function).
byte-array-to-hex-string (function).
hex-char (type).
hex-string-to-byte-array (function).
hex-to-bit-lookup (function).
hex-to-bit-lookup/unsafe (function).
hexchar->int (function).
integer-to-octets (function).
octets-to-integer (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Return a bit vector of N left-shifted by COUNT. N may be an integer, bit-vector, octet-vector, or hex-string.
Return a bit vector of N right-shifted by COUNT. N may be an integer, bit-vector, octet-vector, or hex-string.
Multiplication for bit-vectors. Return result PRODUCT forced to absolute ceiling value.
Addition for bit-vectors. Return result SUM forced to absolute ceiling value.
Subtraction for bit-vectors. Return result DIFFERENCE forced to absolute ceiling value.
Ceiling division for bit-vectors. Return result CEILING forced to absolute ceiling value.
Subtraction for bit-vectors. Return result DIFFERENCE forced to absolute ceiling value.
Floor division for bit-vectors. Return result FLOOR forced to absolute ceiling value.
Multiplication for bit-vectors. Return result PRODUCT forced to absolute ceiling value.
Division for bit-vectors. Return results QUOTIENT and REMAINDER forced to absolute ceiling values.
Addition for bit-vectors. Return result SUM forced to absolute ceiling value.
Division for bit-vectors. Return results QUOTIENT and REMAINDER forced to absolute ceiling values.
Return the hexadecimal string for bit-vector DATA.
Return the integer value for bit-vector DATA.
Return the octet-vector for bit-vector DATA.
Return the number of bytes required to represent an integer, bit-vector, or hex-string value; or the actual length of an octet-vector, N.
Return the bit-vector for hexadecimal string X.
Return the integer value for hexadecimal string X.
Return the octet-vector for hexadecimal string X.
Return the bit-vector for integer N.
Return the hexadecimal string for integer N.
Return the octet-vector for integer N.
Return a bit vector of N left-shifted by COUNT. N may be an integer, bit-vector, octet-vector, or hex-string.
Return the minimum number of bits required to represent an integer, bit-vector, octet-vector, or hex-string value N.
Return the bit-vector for octet-vector O.
Return the hexadecimal string for octet-vector O.
Return the integer value for octet-vector O.
Return a bit vector of N right-shifted by COUNT. N may be an integer, bit-vector, octet-vector, or hex-string.
Test a bit-vector, octet-vector, hex-string, or non-negative integer to see if it obeys the two’s complement rule.
Return the maximum number of bits required to represent an integer, bit-vector, octet-vector, or hex-string value N.
Returns the bits of BIT-VECTOR as an integer as the primary value, number of bits as the secondary value. SLOW!! Consult Hackers-Delight
Return a string containing the hexadecimal representation of the subsequence of VECTOR between START and END. ELEMENT-TYPE controls the element-type of the returned string.
Parses a substring of STRING delimited by START and END of hexadecimal digits into a byte array.
Return the bit vector associated with a hex-value character CHAR from *bit-map*.
Return the bit vector associated with a hex-value character CHAR from *bit-map*.
Return the bit vector associated with a hex-value character CHAR from *bit-map*.
| Jump to: | <
>
B F H I L M O R T W |
|---|
| Jump to: | <
>
B F H I L M O R T W |
|---|
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*bit-map*: | Private special variables | ||
| | |||
| S | |||
Special Variable, *bit-map*: | Private special variables | ||
| | |||
| Jump to: | *
S |
|---|
| Jump to: | A B C F H P S T U |
|---|
| Jump to: | A B C F H P S T U |
|---|