Redo handling of aliased calls --> version 2007.02.13
[bigint/bigint.git] / BigUnsigned.cc
index 83e725d..a68b8ac 100644 (file)
@@ -1,6 +1,5 @@
 /*
 * Matt McCutchen's Big Integer Library
-* http://mysite.verizon.net/mccutchen/bigint/
 */
 
 #include "BigUnsigned.hh"
@@ -20,7 +19,7 @@
 * Since 2005.01.06, NumberlikeArray uses `NULL' rather
 * than a real array if one of zero length is needed.
 * These constructors implicitly call NumberlikeArray's
-* default constructor, which sets `blk2 = NULL, cap = len = 0'.
+* default constructor, which sets `blk = NULL, cap = len = 0'.
 * So if the input number is zero, they can just return.
 * See remarks in `NumberlikeArray.hh'.
 */
@@ -30,7 +29,7 @@ BigUnsigned::BigUnsigned(unsigned long x) {
                ; // NumberlikeArray already did all the work
        else {
                cap = 1;
-               blk2 = new Blk[1];
+               blk = new Blk[1];
                len = 1;
                blk[0] = Blk(x);
        }
@@ -41,7 +40,7 @@ BigUnsigned::BigUnsigned(long x) {
                ;
        else if (x > 0) {
                cap = 1;
-               blk2 = new Blk[1];
+               blk = new Blk[1];
                len = 1;
                blk[0] = Blk(x);
        } else
@@ -53,7 +52,7 @@ BigUnsigned::BigUnsigned(unsigned int x) {
                ;
        else {
                cap = 1;
-               blk2 = new Blk[1];
+               blk = new Blk[1];
                len = 1;
                blk[0] = Blk(x);
        }
@@ -64,7 +63,7 @@ BigUnsigned::BigUnsigned(int x) {
                ;
        else if (x > 0) {
                cap = 1;
-               blk2 = new Blk[1];
+               blk = new Blk[1];
                len = 1;
                blk[0] = Blk(x);
        } else
@@ -76,7 +75,7 @@ BigUnsigned::BigUnsigned(unsigned short x) {
                ;
        else {
                cap = 1;
-               blk2 = new Blk[1];
+               blk = new Blk[1];
                len = 1;
                blk[0] = Blk(x);
        }
@@ -87,7 +86,7 @@ BigUnsigned::BigUnsigned(short x) {
                ;
        else if (x > 0) {
                cap = 1;
-               blk2 = new Blk[1];
+               blk = new Blk[1];
                len = 1;
                blk[0] = Blk(x);
        } else
@@ -219,11 +218,37 @@ BigUnsigned::CmpRes BigUnsigned::compareTo(const BigUnsigned &x) const {
 * See Section 4.3.1 of Knuth's ``The Art of Computer Programming''.
 */
 
+/*
+ * On most calls to put-here operations, it's safe to read the inputs little by
+ * little and write the outputs little by little.  However, if one of the
+ * inputs is coming from the same variable into which the output is to be
+ * stored (an "aliased" call), we risk overwriting the input before we read it.
+ * In this case, we first compute the result into a temporary BigUnsigned
+ * variable and then copy it into the requested output variable *this.
+ * Each put-here operation uses the DOTR_ALIASED macro (Do The Right Thing on
+ * aliased calls) to generate code for this check.
+ * 
+ * I adopted this approach on 2007.02.13 (see Assignment Operators in
+ * BigUnsigned.hh).  Before then, put-here operations rejected aliased calls
+ * with an exception.  I think doing the right thing is better.
+ * 
+ * Some of the put-here operations can probably handle aliased calls safely
+ * without the extra copy because (for example) they process blocks strictly
+ * right-to-left.  At some point I might determine which ones don't need the
+ * copy, but my reasoning would need to be verified very carefully.  For now
+ * I'll leave in the copy.
+ */
+#define DOTR_ALIASED(cond, op) \
+       if (cond) { \
+               BigUnsigned tmpThis; \
+               tmpThis.op; \
+               *this = tmpThis; \
+               return; \
+       }
+
 // Addition
 void BigUnsigned::add(const BigUnsigned &a, const BigUnsigned &b) {
-       // Block unsafe calls
-       if (this == &a || this == &b)
-               throw "BigUnsigned::add: One of the arguments is the invoked object";
+       DOTR_ALIASED(this == &a || this == &b, add(a, b));
        // If one argument is zero, copy the other.
        if (a.len == 0) {
                operator =(b);
@@ -284,9 +309,7 @@ void BigUnsigned::add(const BigUnsigned &a, const BigUnsigned &b) {
 
 // Subtraction
 void BigUnsigned::subtract(const BigUnsigned &a, const BigUnsigned &b) {
-       // Block unsafe calls
-       if (this == &a || this == &b)
-               throw "BigUnsigned::subtract: One of the arguments is the invoked object";
+       DOTR_ALIASED(this == &a || this == &b, subtract(a, b));
        // If b is zero, copy a.  If a is shorter than b, the result is negative.
        if (b.len == 0) {
                operator =(a);
@@ -398,9 +421,7 @@ inline BigUnsigned::Blk getShiftedBlock(const BigUnsigned &num,
 
 // Multiplication
 void BigUnsigned::multiply(const BigUnsigned &a, const BigUnsigned &b) {
-       // Block unsafe calls
-       if (this == &a || this == &b)
-               throw "BigUnsigned::multiply: One of the arguments is the invoked object";
+       DOTR_ALIASED(this == &a || this == &b, multiply(a, b));
        // If either a or b is zero, set to zero.
        if (a.len == 0 || b.len == 0) {
                len = 0;
@@ -428,7 +449,7 @@ void BigUnsigned::multiply(const BigUnsigned &a, const BigUnsigned &b) {
        for (i = 0; i < a.len; i++) {
                // For each 1-bit of that block...
                for (i2 = 0; i2 < N; i2++) {
-                       if ((a.blk[i] & (1 << i2)) == 0)
+                       if ((a.blk[i] & (Blk(1) << i2)) == 0)
                                continue;
                        /*
                        * Add b to this, shifted left i blocks and i2 bits.
@@ -484,11 +505,28 @@ void BigUnsigned::multiply(const BigUnsigned &a, const BigUnsigned &b) {
 * and provide outputs in the most convenient places so that no value ever needs
 * to be copied in its entirety.  That way, the client can perform exactly the
 * copying it needs depending on where the inputs are and where it wants the output.
+* A better name for this function might be "modWithQuotient", but I would rather
+* not change the name now.
 */
 void BigUnsigned::divideWithRemainder(const BigUnsigned &b, BigUnsigned &q) {
-       // Block unsafe calls
-       if (this == &b || &q == &b || this == &q)
-               throw "BigUnsigned::divideWithRemainder: Some two objects involved are the same";
+       /*
+        * Defending against aliased calls is a bit tricky because we are
+        * writing to both *this and q.
+        * 
+        * It would be silly to try to write quotient and remainder to the
+        * same variable.  Rule that out right away.
+        */
+       if (this == &q)
+               throw "BigUnsigned::divideWithRemainder: Cannot write quotient and remainder into the same variable";
+       /*
+        * Now *this and q are separate, so the only concern is that b might be
+        * aliased to one of them.  If so, use a temporary copy of b.
+        */
+       if (this == &b || &q == &b) {
+               BigUnsigned tmpB(b);
+               divideWithRemainder(tmpB, q);
+               return;
+       }
        
        /*
        * Note that the mathematical definition of mod (I'm trusting Knuth) is somewhat
@@ -563,8 +601,9 @@ void BigUnsigned::divideWithRemainder(const BigUnsigned &b, BigUnsigned &q) {
        * amusing story of this section of code.
        */
        Index origLen = len; // Save real length.
+       // 2006.05.03: Copy the number and then change the length!
+       allocateAndCopy(len + 1); // Get the space.
        len++; // Increase the length.
-       allocateAndCopy(len); // Get the space.
        blk[origLen] = 0; // Zero the extra block.
        
        // work2 holds part of the result of a subtraction; see above.
@@ -623,7 +662,7 @@ void BigUnsigned::divideWithRemainder(const BigUnsigned &b, BigUnsigned &q) {
                        * the region of work2 we copy is just [i, k).
                        */
                        if (!borrowIn) {
-                               q.blk[i] |= (1 << i2);
+                               q.blk[i] |= (Blk(1) << i2);
                                while (k > i) {
                                        k--;
                                        blk[k] = work2[k];
@@ -684,9 +723,7 @@ void BigUnsigned::divideWithRemainder(const BigUnsigned &b, BigUnsigned &q) {
 
 // Bitwise and
 void BigUnsigned::bitAnd(const BigUnsigned &a, const BigUnsigned &b) {
-       // Block unsafe calls
-       if (this == &a || this == &b)
-               throw "BigUnsigned::bitAnd: One of the arguments is the invoked object";
+       DOTR_ALIASED(this == &a || this == &b, bitAnd(a, b));
        len = (a.len >= b.len) ? b.len : a.len;
        allocate(len);
        Index i;
@@ -697,9 +734,7 @@ void BigUnsigned::bitAnd(const BigUnsigned &a, const BigUnsigned &b) {
 
 // Bitwise or
 void BigUnsigned::bitOr(const BigUnsigned &a, const BigUnsigned &b) {
-       // Block unsafe calls
-       if (this == &a || this == &b)
-               throw "BigUnsigned::bitOr: One of the arguments is the invoked object";
+       DOTR_ALIASED(this == &a || this == &b, bitOr(a, b));
        Index i;
        const BigUnsigned *a2, *b2;
        if (a.len >= b.len) {
@@ -719,9 +754,7 @@ void BigUnsigned::bitOr(const BigUnsigned &a, const BigUnsigned &b) {
 
 // Bitwise xor
 void BigUnsigned::bitXor(const BigUnsigned &a, const BigUnsigned &b) {
-       // Block unsafe calls
-       if (this == &a || this == &b)
-               throw "BigUnsigned::bitXor: One of the arguments is the invoked object";
+       DOTR_ALIASED(this == &a || this == &b, bitXor(a, b));
        Index i;
        const BigUnsigned *a2, *b2;
        if (a.len >= b.len) {
@@ -731,7 +764,7 @@ void BigUnsigned::bitXor(const BigUnsigned &a, const BigUnsigned &b) {
                a2 = &b;
                b2 = &a;
        }
-       allocate(b2->len);
+       allocate(a2->len);
        for (i = 0; i < b2->len; i++)
                blk[i] = a2->blk[i] ^ b2->blk[i];
        for (; i < a2->len; i++)
@@ -752,8 +785,10 @@ void BigUnsigned::operator ++() {
        }
        if (carry) {
                // Matt fixed a bug 2004.12.24: next 2 lines used to say allocateAndCopy(len + 1)
+               // Matt fixed another bug 2006.04.24:
+               // old number only has len blocks, so copy before increasing length
+               allocateAndCopy(len + 1);
                len++;
-               allocateAndCopy(len);
                blk[i] = 1;
        }
 }