X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/09d00c6bc88fe624f00ef13b0930b8cc0b6300c1..1589affab225db500965e2cb869c534d6860e6bd:/mp.h diff --git a/mp.h b/mp.h index 6ccf523..c38bb3c 100644 --- a/mp.h +++ b/mp.h @@ -1,6 +1,6 @@ /* -*-c-*- * - * $Id: mp.h,v 1.14 2002/10/15 00:19:40 mdw Exp $ + * $Id: mp.h,v 1.17 2003/05/16 09:09:24 mdw Exp $ * * Simple multiprecision arithmetic * @@ -30,6 +30,15 @@ /*----- Revision history --------------------------------------------------* * * $Log: mp.h,v $ + * Revision 1.17 2003/05/16 09:09:24 mdw + * Fix @mp_lsl2c@. Turns out to be surprisingly tricky. + * + * Revision 1.16 2002/10/15 22:57:22 mdw + * Handy new comparison macros. + * + * Revision 1.15 2002/10/15 19:18:31 mdw + * New operation to negate numbers. + * * Revision 1.14 2002/10/15 00:19:40 mdw * Bit setting and clearing functions. * @@ -656,78 +665,57 @@ extern mp *mp_loadb2c(mp */*d*/, const void */*pv*/, size_t /*sz*/); extern void mp_storeb2c(const mp */*m*/, void */*pv*/, size_t /*sz*/); -/*----- Simple arithmetic -------------------------------------------------*/ +/*----- Bit operations ----------------------------------------------------*/ -/* --- @mp_lsl@, @mp_lsr@ --- * +/* --- @mp_not@ --- * * * Arguments: @mp *d@ = destination * @mp *a@ = source - * @size_t n@ = number of bits to move * - * Returns: Result, @a@ shifted left or right by @n@. - */ + * Returns: The bitwise complement of the source. + */ -extern mp *mp_lsl(mp */*d*/, mp */*a*/, size_t /*n*/); -extern mp *mp_lsr(mp */*d*/, mp */*a*/, size_t /*n*/); +extern mp *mp_not(mp */*d*/, mp */*a*/); -/* --- @mp_lsl2c@, @mp_lsr2c@ --- * +/* --- @mp_bitop@ --- * * * Arguments: @mp *d@ = destination - * @mp *a@ = source - * @size_t n@ = number of bits to move + * @mp *a, *b@ = sources * - * Returns: Result, @a@ shifted left or right by @n@. Handles the - * pretence of sign-extension for negative numbers. + * Returns: The result of the given bitwise operation. These functions + * don't handle negative numbers at all sensibly. For that, use + * the @...2c@ variants. The functions are named after the + * truth tables they generate: + * + * a: 0011 + * b: 0101 + * @mpx_bitXXXX@ */ -extern mp *mp_lsl2c(mp */*d*/, mp */*a*/, size_t /*n*/); -extern mp *mp_lsr2c(mp */*d*/, mp */*a*/, size_t /*n*/); +#define MP_BITDECL(string) \ + extern mp *mp_bit##string(mp */*d*/, mp */*a*/, mp */*b*/); +MPX_DOBIN(MP_BITDECL) -/* --- @mp_testbit@ --- * - * - * Arguments: @mp *x@ = a large integer - * @unsigned long n@ = which bit to test +/* --- @mp_[n]and@, @mp_[n]or@, @mp_[n]xor@, @mp_not@ --- * * - * Returns: Nonzero if the bit is set, zero if not. + * Synonyms for the commonly-used functions. */ -extern int mp_testbit(mp */*x*/, unsigned long /*n*/); +#define mp_and mp_bit0001 +#define mp_or mp_bit0111 +#define mp_nand mp_bit1110 +#define mp_nor mp_bit1000 +#define mp_xor mp_bit0110 -/* --- @mp_testbit2c@ --- * +/* --- @mp_testbit@ --- * * * Arguments: @mp *x@ = a large integer * @unsigned long n@ = which bit to test * - * Returns: Nonzero if the bit is set, zero if not. Fakes up two's - * complement representation. - */ - -extern int mp_testbit2c(mp */*x*/, unsigned long /*n*/); - -/* --- @mp_eq@ --- * - * - * Arguments: @const mp *a, *b@ = two numbers - * - * Returns: Nonzero if the numbers are equal. - */ - -extern int mp_eq(const mp */*a*/, const mp */*b*/); - -#define MP_EQ(a, b) \ - ((((a)->f ^ (b)->f) & MP_NEG) == 0 && \ - mpx_ueq((a)->v, (a)->vl, (b)->v, (b)->vl)) - -/* --- @mp_cmp@ --- * - * - * Arguments: @const mp *a, *b@ = two numbers - * - * Returns: Less than, equal to or greater than zero, according to - * whether @a@ is less than, equal to or greater than @b@. + * Returns: Nonzero if the bit is set, zero if not. */ -extern int mp_cmp(const mp */*a*/, const mp */*b*/); - -#define MP_CMP(a, op, b) (mp_cmp((a), (b)) op 0) +extern int mp_testbit(mp */*x*/, unsigned long /*n*/); /* --- @mp_setbit@, @mp_clearbit@ --- * * @@ -741,58 +729,33 @@ extern int mp_cmp(const mp */*a*/, const mp */*b*/); extern mp *mp_setbit(mp */*d*/, mp */*x*/, unsigned long /*n*/); extern mp *mp_clearbit(mp */*d*/, mp */*x*/, unsigned long /*n*/); -/* --- @mp_setbit2c@, @mp_clearbit2c@ --- * - * - * Arguments: @mp *d@ = a destination - * @mp *x@ = a large integer - * @unsigned long n@ = which bit to modify - * - * Returns: The argument @x@, with the appropriate bit set or cleared. - * Fakes up two's complement representation. - */ - -extern mp *mp_setbit2c(mp */*d*/, mp */*x*/, unsigned long /*n*/); -extern mp *mp_clearbit2c(mp */*d*/, mp */*x*/, unsigned long /*n*/); - -/* --- @mp_bitop@ --- * +/* --- @mp_lsl@, @mp_lslc@, @mp_lsr@ --- * * * Arguments: @mp *d@ = destination - * @mp *a, *b@ = sources - * - * Returns: The result of the given bitwise operation. These functions - * don't handle negative numbers at all sensibly. For that, use - * the @...2c@ variants. The functions are named after the - * truth tables they generate: + * @mp *a@ = source + * @size_t n@ = number of bits to move * - * a: 0011 - * b: 0101 - * @mpx_bitXXXX@ - */ - -#define MP_BITDECL(string) \ - extern mp *mp_bit##string(mp */*d*/, mp */*a*/, mp */*b*/); -MPX_DOBIN(MP_BITDECL) - -/* --- @mp_[n]and@, @mp_[n]or@, @mp_[n]xor@, @mp_not@ --- * + * Returns: Result, @a@ shifted left or right by @n@. * - * Synonyms for the commonly-used functions. + * Use: Bitwise shift operators. @mp_lslc@ fills the bits introduced + * on the right with ones instead of zeroes: it's used + * internally by @mp_lsl2c@, though it may be useful on its + * own. */ -#define mp_and mp_bit0001 -#define mp_or mp_bit0111 -#define mp_nand mp_bit1110 -#define mp_nor mp_bit1000 -#define mp_xor mp_bit0110 +extern mp *mp_lsl(mp */*d*/, mp */*a*/, size_t /*n*/); +extern mp *mp_lslc(mp */*d*/, mp */*a*/, size_t /*n*/); +extern mp *mp_lsr(mp */*d*/, mp */*a*/, size_t /*n*/); -/* --- @mp_not@ --- * +/* --- @mp_not2c@ --- * * * Arguments: @mp *d@ = destination * @mp *a@ = source * - * Returns: The bitwise complement of the source. - */ + * Returns: The sign-extended complement of the argument. + */ -extern mp *mp_not(mp */*d*/, mp */*a*/); +extern mp *mp_not2c(mp */*d*/, mp */*a*/); /* --- @mp_bitop2c@ --- * * @@ -824,15 +787,89 @@ MPX_DOBIN(MP_BIT2CDECL) #define mp_nor2c mp_bit10002c #define mp_xor2c mp_bit01102c -/* --- @mp_not2c@ --- * +/* --- @mp_lsl2c@, @mp_lsr2c@ --- * * * Arguments: @mp *d@ = destination * @mp *a@ = source + * @size_t n@ = number of bits to move * - * Returns: The sign-extended complement of the argument. + * Returns: Result, @a@ shifted left or right by @n@. Handles the + * pretence of sign-extension for negative numbers. */ -extern mp *mp_not2c(mp */*d*/, mp */*a*/); +extern mp *mp_lsl2c(mp */*d*/, mp */*a*/, size_t /*n*/); +extern mp *mp_lsr2c(mp */*d*/, mp */*a*/, size_t /*n*/); + +/* --- @mp_testbit2c@ --- * + * + * Arguments: @mp *x@ = a large integer + * @unsigned long n@ = which bit to test + * + * Returns: Nonzero if the bit is set, zero if not. Fakes up two's + * complement representation. + */ + +extern int mp_testbit2c(mp */*x*/, unsigned long /*n*/); + +/* --- @mp_setbit2c@, @mp_clearbit2c@ --- * + * + * Arguments: @mp *d@ = a destination + * @mp *x@ = a large integer + * @unsigned long n@ = which bit to modify + * + * Returns: The argument @x@, with the appropriate bit set or cleared. + * Fakes up two's complement representation. + */ + +extern mp *mp_setbit2c(mp */*d*/, mp */*x*/, unsigned long /*n*/); +extern mp *mp_clearbit2c(mp */*d*/, mp */*x*/, unsigned long /*n*/); + +/*----- Comparisons -------------------------------------------------------*/ + +/* --- @mp_eq@ --- * + * + * Arguments: @const mp *a, *b@ = two numbers + * + * Returns: Nonzero if the numbers are equal. + */ + +extern int mp_eq(const mp */*a*/, const mp */*b*/); + +#define MP_EQ(a, b) \ + ((((a)->f ^ (b)->f) & MP_NEG) == 0 && \ + mpx_ueq((a)->v, (a)->vl, (b)->v, (b)->vl)) + +/* --- @mp_cmp@ --- * + * + * Arguments: @const mp *a, *b@ = two numbers + * + * Returns: Less than, equal to or greater than zero, according to + * whether @a@ is less than, equal to or greater than @b@. + */ + +extern int mp_cmp(const mp */*a*/, const mp */*b*/); + +#define MP_CMP(a, op, b) (mp_cmp((a), (b)) op 0) + +/* --- Other handy macros --- */ + +#define MP_ISNEG(x) ((x)->f & MP_NEG) +#define MP_ISZERO(x) MP_EQ((x), MP_ZERO) +#define MP_ISPOS(x) (!MP_ISNEG(x) && !MP_ISZERO(x)) + +/*----- Arithmetic operations ---------------------------------------------*/ + +/* --- @mp_neg@ --- * + * + * Arguments: @mp *d@ = destination + * @mp *a@ = argument + * + * Returns: The negation of the argument. + * + * Use: Negates its argument. + */ + +extern mp *mp_neg(mp */*d*/, mp */*a*/); /* --- @mp_add@ --- * *