# CONFIG := gcc-debug
# CONFIG := release
-OBJS = kernel/driver.o kernel/register.o kernel/rtlil.o kernel/log.o kernel/sha1.o kernel/calc.o kernel/select.o kernel/show.o
-OBJS += bigint/BigIntegerAlgorithms.o bigint/BigInteger.o bigint/BigIntegerUtils.o bigint/BigUnsigned.o bigint/BigUnsignedInABase.o
+OBJS = kernel/driver.o kernel/register.o kernel/rtlil.o kernel/log.o kernel/calc.o kernel/select.o kernel/show.o
+
+OBJS += libs/bigint/BigIntegerAlgorithms.o libs/bigint/BigInteger.o libs/bigint/BigIntegerUtils.o
+OBJS += libs/bigint/BigUnsigned.o libs/bigint/BigUnsignedInABase.o
+
+OBJS += libs/sha1/sha1.o
+OBJS += libs/subcircuit/subcircuit.o
GENFILES =
TARGETS = yosys
+++ /dev/null
-*.o
-sample
-testsuite
-testsuite.expected
-testsuite.out
-testsuite.err
+++ /dev/null
-#include "BigInteger.hh"
-
-void BigInteger::operator =(const BigInteger &x) {
- // Calls like a = a have no effect
- if (this == &x)
- return;
- // Copy sign
- sign = x.sign;
- // Copy the rest
- mag = x.mag;
-}
-
-BigInteger::BigInteger(const Blk *b, Index blen, Sign s) : mag(b, blen) {
- switch (s) {
- case zero:
- if (!mag.isZero())
- throw "BigInteger::BigInteger(const Blk *, Index, Sign): Cannot use a sign of zero with a nonzero magnitude";
- sign = zero;
- break;
- case positive:
- case negative:
- // If the magnitude is zero, force the sign to zero.
- sign = mag.isZero() ? zero : s;
- break;
- default:
- /* g++ seems to be optimizing out this case on the assumption
- * that the sign is a valid member of the enumeration. Oh well. */
- throw "BigInteger::BigInteger(const Blk *, Index, Sign): Invalid sign";
- }
-}
-
-BigInteger::BigInteger(const BigUnsigned &x, Sign s) : mag(x) {
- switch (s) {
- case zero:
- if (!mag.isZero())
- throw "BigInteger::BigInteger(const BigUnsigned &, Sign): Cannot use a sign of zero with a nonzero magnitude";
- sign = zero;
- break;
- case positive:
- case negative:
- // If the magnitude is zero, force the sign to zero.
- sign = mag.isZero() ? zero : s;
- break;
- default:
- /* g++ seems to be optimizing out this case on the assumption
- * that the sign is a valid member of the enumeration. Oh well. */
- throw "BigInteger::BigInteger(const BigUnsigned &, Sign): Invalid sign";
- }
-}
-
-/* CONSTRUCTION FROM PRIMITIVE INTEGERS
- * Same idea as in BigUnsigned.cc, except that negative input results in a
- * negative BigInteger instead of an exception. */
-
-// Done longhand to let us use initialization.
-BigInteger::BigInteger(unsigned long x) : mag(x) { sign = mag.isZero() ? zero : positive; }
-BigInteger::BigInteger(unsigned int x) : mag(x) { sign = mag.isZero() ? zero : positive; }
-BigInteger::BigInteger(unsigned short x) : mag(x) { sign = mag.isZero() ? zero : positive; }
-
-// For signed input, determine the desired magnitude and sign separately.
-
-namespace {
- template <class X, class UX>
- BigInteger::Blk magOf(X x) {
- /* UX(...) cast needed to stop short(-2^15), which negates to
- * itself, from sign-extending in the conversion to Blk. */
- return BigInteger::Blk(x < 0 ? UX(-x) : x);
- }
- template <class X>
- BigInteger::Sign signOf(X x) {
- return (x == 0) ? BigInteger::zero
- : (x > 0) ? BigInteger::positive
- : BigInteger::negative;
- }
-}
-
-BigInteger::BigInteger(long x) : sign(signOf(x)), mag(magOf<long , unsigned long >(x)) {}
-BigInteger::BigInteger(int x) : sign(signOf(x)), mag(magOf<int , unsigned int >(x)) {}
-BigInteger::BigInteger(short x) : sign(signOf(x)), mag(magOf<short, unsigned short>(x)) {}
-
-// CONVERSION TO PRIMITIVE INTEGERS
-
-/* Reuse BigUnsigned's conversion to an unsigned primitive integer.
- * The friend is a separate function rather than
- * BigInteger::convertToUnsignedPrimitive to avoid requiring BigUnsigned to
- * declare BigInteger. */
-template <class X>
-inline X convertBigUnsignedToPrimitiveAccess(const BigUnsigned &a) {
- return a.convertToPrimitive<X>();
-}
-
-template <class X>
-X BigInteger::convertToUnsignedPrimitive() const {
- if (sign == negative)
- throw "BigInteger::to<Primitive>: "
- "Cannot convert a negative integer to an unsigned type";
- else
- return convertBigUnsignedToPrimitiveAccess<X>(mag);
-}
-
-/* Similar to BigUnsigned::convertToPrimitive, but split into two cases for
- * nonnegative and negative numbers. */
-template <class X, class UX>
-X BigInteger::convertToSignedPrimitive() const {
- if (sign == zero)
- return 0;
- else if (mag.getLength() == 1) {
- // The single block might fit in an X. Try the conversion.
- Blk b = mag.getBlock(0);
- if (sign == positive) {
- X x = X(b);
- if (x >= 0 && Blk(x) == b)
- return x;
- } else {
- X x = -X(b);
- /* UX(...) needed to avoid rejecting conversion of
- * -2^15 to a short. */
- if (x < 0 && Blk(UX(-x)) == b)
- return x;
- }
- // Otherwise fall through.
- }
- throw "BigInteger::to<Primitive>: "
- "Value is too big to fit in the requested type";
-}
-
-unsigned long BigInteger::toUnsignedLong () const { return convertToUnsignedPrimitive<unsigned long > (); }
-unsigned int BigInteger::toUnsignedInt () const { return convertToUnsignedPrimitive<unsigned int > (); }
-unsigned short BigInteger::toUnsignedShort() const { return convertToUnsignedPrimitive<unsigned short> (); }
-long BigInteger::toLong () const { return convertToSignedPrimitive <long , unsigned long> (); }
-int BigInteger::toInt () const { return convertToSignedPrimitive <int , unsigned int> (); }
-short BigInteger::toShort () const { return convertToSignedPrimitive <short, unsigned short>(); }
-
-// COMPARISON
-BigInteger::CmpRes BigInteger::compareTo(const BigInteger &x) const {
- // A greater sign implies a greater number
- if (sign < x.sign)
- return less;
- else if (sign > x.sign)
- return greater;
- else switch (sign) {
- // If the signs are the same...
- case zero:
- return equal; // Two zeros are equal
- case positive:
- // Compare the magnitudes
- return mag.compareTo(x.mag);
- case negative:
- // Compare the magnitudes, but return the opposite result
- return CmpRes(-mag.compareTo(x.mag));
- default:
- throw "BigInteger internal error";
- }
-}
-
-/* COPY-LESS OPERATIONS
- * These do some messing around to determine the sign of the result,
- * then call one of BigUnsigned's copy-less operations. */
-
-// See remarks about aliased calls in BigUnsigned.cc .
-#define DTRT_ALIASED(cond, op) \
- if (cond) { \
- BigInteger tmpThis; \
- tmpThis.op; \
- *this = tmpThis; \
- return; \
- }
-
-void BigInteger::add(const BigInteger &a, const BigInteger &b) {
- DTRT_ALIASED(this == &a || this == &b, add(a, b));
- // If one argument is zero, copy the other.
- if (a.sign == zero)
- operator =(b);
- else if (b.sign == zero)
- operator =(a);
- // If the arguments have the same sign, take the
- // common sign and add their magnitudes.
- else if (a.sign == b.sign) {
- sign = a.sign;
- mag.add(a.mag, b.mag);
- } else {
- // Otherwise, their magnitudes must be compared.
- switch (a.mag.compareTo(b.mag)) {
- case equal:
- // If their magnitudes are the same, copy zero.
- mag = 0;
- sign = zero;
- break;
- // Otherwise, take the sign of the greater, and subtract
- // the lesser magnitude from the greater magnitude.
- case greater:
- sign = a.sign;
- mag.subtract(a.mag, b.mag);
- break;
- case less:
- sign = b.sign;
- mag.subtract(b.mag, a.mag);
- break;
- }
- }
-}
-
-void BigInteger::subtract(const BigInteger &a, const BigInteger &b) {
- // Notice that this routine is identical to BigInteger::add,
- // if one replaces b.sign by its opposite.
- DTRT_ALIASED(this == &a || this == &b, subtract(a, b));
- // If a is zero, copy b and flip its sign. If b is zero, copy a.
- if (a.sign == zero) {
- mag = b.mag;
- // Take the negative of _b_'s, sign, not ours.
- // Bug pointed out by Sam Larkin on 2005.03.30.
- sign = Sign(-b.sign);
- } else if (b.sign == zero)
- operator =(a);
- // If their signs differ, take a.sign and add the magnitudes.
- else if (a.sign != b.sign) {
- sign = a.sign;
- mag.add(a.mag, b.mag);
- } else {
- // Otherwise, their magnitudes must be compared.
- switch (a.mag.compareTo(b.mag)) {
- // If their magnitudes are the same, copy zero.
- case equal:
- mag = 0;
- sign = zero;
- break;
- // If a's magnitude is greater, take a.sign and
- // subtract a from b.
- case greater:
- sign = a.sign;
- mag.subtract(a.mag, b.mag);
- break;
- // If b's magnitude is greater, take the opposite
- // of b.sign and subtract b from a.
- case less:
- sign = Sign(-b.sign);
- mag.subtract(b.mag, a.mag);
- break;
- }
- }
-}
-
-void BigInteger::multiply(const BigInteger &a, const BigInteger &b) {
- DTRT_ALIASED(this == &a || this == &b, multiply(a, b));
- // If one object is zero, copy zero and return.
- if (a.sign == zero || b.sign == zero) {
- sign = zero;
- mag = 0;
- return;
- }
- // If the signs of the arguments are the same, the result
- // is positive, otherwise it is negative.
- sign = (a.sign == b.sign) ? positive : negative;
- // Multiply the magnitudes.
- mag.multiply(a.mag, b.mag);
-}
-
-/*
- * DIVISION WITH REMAINDER
- * Please read the comments before the definition of
- * `BigUnsigned::divideWithRemainder' in `BigUnsigned.cc' for lots of
- * information you should know before reading this function.
- *
- * Following Knuth, I decree that x / y is to be
- * 0 if y==0 and floor(real-number x / y) if y!=0.
- * Then x % y shall be x - y*(integer x / y).
- *
- * Note that x = y * (x / y) + (x % y) always holds.
- * In addition, (x % y) is from 0 to y - 1 if y > 0,
- * and from -(|y| - 1) to 0 if y < 0. (x % y) = x if y = 0.
- *
- * Examples: (q = a / b, r = a % b)
- * a b q r
- * === === === ===
- * 4 3 1 1
- * -4 3 -2 2
- * 4 -3 -2 -2
- * -4 -3 1 -1
- */
-void BigInteger::divideWithRemainder(const BigInteger &b, BigInteger &q) {
- // Defend against aliased calls;
- // same idea as in BigUnsigned::divideWithRemainder .
- if (this == &q)
- throw "BigInteger::divideWithRemainder: Cannot write quotient and remainder into the same variable";
- if (this == &b || &q == &b) {
- BigInteger tmpB(b);
- divideWithRemainder(tmpB, q);
- return;
- }
-
- // Division by zero gives quotient 0 and remainder *this
- if (b.sign == zero) {
- q.mag = 0;
- q.sign = zero;
- return;
- }
- // 0 / b gives quotient 0 and remainder 0
- if (sign == zero) {
- q.mag = 0;
- q.sign = zero;
- return;
- }
-
- // Here *this != 0, b != 0.
-
- // Do the operands have the same sign?
- if (sign == b.sign) {
- // Yes: easy case. Quotient is zero or positive.
- q.sign = positive;
- } else {
- // No: harder case. Quotient is negative.
- q.sign = negative;
- // Decrease the magnitude of the dividend by one.
- mag--;
- /*
- * We tinker with the dividend before and with the
- * quotient and remainder after so that the result
- * comes out right. To see why it works, consider the following
- * list of examples, where A is the magnitude-decreased
- * a, Q and R are the results of BigUnsigned division
- * with remainder on A and |b|, and q and r are the
- * final results we want:
- *
- * a A b Q R q r
- * -3 -2 3 0 2 -1 0
- * -4 -3 3 1 0 -2 2
- * -5 -4 3 1 1 -2 1
- * -6 -5 3 1 2 -2 0
- *
- * It appears that we need a total of 3 corrections:
- * Decrease the magnitude of a to get A. Increase the
- * magnitude of Q to get q (and make it negative).
- * Find r = (b - 1) - R and give it the desired sign.
- */
- }
-
- // Divide the magnitudes.
- mag.divideWithRemainder(b.mag, q.mag);
-
- if (sign != b.sign) {
- // More for the harder case (as described):
- // Increase the magnitude of the quotient by one.
- q.mag++;
- // Modify the remainder.
- mag.subtract(b.mag, mag);
- mag--;
- }
-
- // Sign of the remainder is always the sign of the divisor b.
- sign = b.sign;
-
- // Set signs to zero as necessary. (Thanks David Allen!)
- if (mag.isZero())
- sign = zero;
- if (q.mag.isZero())
- q.sign = zero;
-
- // WHEW!!!
-}
-
-// Negation
-void BigInteger::negate(const BigInteger &a) {
- DTRT_ALIASED(this == &a, negate(a));
- // Copy a's magnitude
- mag = a.mag;
- // Copy the opposite of a.sign
- sign = Sign(-a.sign);
-}
-
-// INCREMENT/DECREMENT OPERATORS
-
-// Prefix increment
-void BigInteger::operator ++() {
- if (sign == negative) {
- mag--;
- if (mag == 0)
- sign = zero;
- } else {
- mag++;
- sign = positive; // if not already
- }
-}
-
-// Postfix increment: same as prefix
-void BigInteger::operator ++(int) {
- operator ++();
-}
-
-// Prefix decrement
-void BigInteger::operator --() {
- if (sign == positive) {
- mag--;
- if (mag == 0)
- sign = zero;
- } else {
- mag++;
- sign = negative;
- }
-}
-
-// Postfix decrement: same as prefix
-void BigInteger::operator --(int) {
- operator --();
-}
-
+++ /dev/null
-#ifndef BIGINTEGER_H
-#define BIGINTEGER_H
-
-#include "BigUnsigned.hh"
-
-/* A BigInteger object represents a signed integer of size limited only by
- * available memory. BigUnsigneds support most mathematical operators and can
- * be converted to and from most primitive integer types.
- *
- * A BigInteger is just an aggregate of a BigUnsigned and a sign. (It is no
- * longer derived from BigUnsigned because that led to harmful implicit
- * conversions.) */
-class BigInteger {
-
-public:
- typedef BigUnsigned::Blk Blk;
- typedef BigUnsigned::Index Index;
- typedef BigUnsigned::CmpRes CmpRes;
- static const CmpRes
- less = BigUnsigned::less ,
- equal = BigUnsigned::equal ,
- greater = BigUnsigned::greater;
- // Enumeration for the sign of a BigInteger.
- enum Sign { negative = -1, zero = 0, positive = 1 };
-
-protected:
- Sign sign;
- BigUnsigned mag;
-
-public:
- // Constructs zero.
- BigInteger() : sign(zero), mag() {}
-
- // Copy constructor
- BigInteger(const BigInteger &x) : sign(x.sign), mag(x.mag) {};
-
- // Assignment operator
- void operator=(const BigInteger &x);
-
- // Constructor that copies from a given array of blocks with a sign.
- BigInteger(const Blk *b, Index blen, Sign s);
-
- // Nonnegative constructor that copies from a given array of blocks.
- BigInteger(const Blk *b, Index blen) : mag(b, blen) {
- sign = mag.isZero() ? zero : positive;
- }
-
- // Constructor from a BigUnsigned and a sign
- BigInteger(const BigUnsigned &x, Sign s);
-
- // Nonnegative constructor from a BigUnsigned
- BigInteger(const BigUnsigned &x) : mag(x) {
- sign = mag.isZero() ? zero : positive;
- }
-
- // Constructors from primitive integer types
- BigInteger(unsigned long x);
- BigInteger( long x);
- BigInteger(unsigned int x);
- BigInteger( int x);
- BigInteger(unsigned short x);
- BigInteger( short x);
-
- /* Converters to primitive integer types
- * The implicit conversion operators caused trouble, so these are now
- * named. */
- unsigned long toUnsignedLong () const;
- long toLong () const;
- unsigned int toUnsignedInt () const;
- int toInt () const;
- unsigned short toUnsignedShort() const;
- short toShort () const;
-protected:
- // Helper
- template <class X> X convertToUnsignedPrimitive() const;
- template <class X, class UX> X convertToSignedPrimitive() const;
-public:
-
- // ACCESSORS
- Sign getSign() const { return sign; }
- /* The client can't do any harm by holding a read-only reference to the
- * magnitude. */
- const BigUnsigned &getMagnitude() const { return mag; }
-
- // Some accessors that go through to the magnitude
- Index getLength() const { return mag.getLength(); }
- Index getCapacity() const { return mag.getCapacity(); }
- Blk getBlock(Index i) const { return mag.getBlock(i); }
- bool isZero() const { return sign == zero; } // A bit special
-
- // COMPARISONS
-
- // Compares this to x like Perl's <=>
- CmpRes compareTo(const BigInteger &x) const;
-
- // Ordinary comparison operators
- bool operator ==(const BigInteger &x) const {
- return sign == x.sign && mag == x.mag;
- }
- bool operator !=(const BigInteger &x) const { return !operator ==(x); };
- bool operator < (const BigInteger &x) const { return compareTo(x) == less ; }
- bool operator <=(const BigInteger &x) const { return compareTo(x) != greater; }
- bool operator >=(const BigInteger &x) const { return compareTo(x) != less ; }
- bool operator > (const BigInteger &x) const { return compareTo(x) == greater; }
-
- // OPERATORS -- See the discussion in BigUnsigned.hh.
- void add (const BigInteger &a, const BigInteger &b);
- void subtract(const BigInteger &a, const BigInteger &b);
- void multiply(const BigInteger &a, const BigInteger &b);
- /* See the comment on BigUnsigned::divideWithRemainder. Semantics
- * differ from those of primitive integers when negatives and/or zeros
- * are involved. */
- void divideWithRemainder(const BigInteger &b, BigInteger &q);
- void negate(const BigInteger &a);
-
- /* Bitwise operators are not provided for BigIntegers. Use
- * getMagnitude to get the magnitude and operate on that instead. */
-
- BigInteger operator +(const BigInteger &x) const;
- BigInteger operator -(const BigInteger &x) const;
- BigInteger operator *(const BigInteger &x) const;
- BigInteger operator /(const BigInteger &x) const;
- BigInteger operator %(const BigInteger &x) const;
- BigInteger operator -() const;
-
- void operator +=(const BigInteger &x);
- void operator -=(const BigInteger &x);
- void operator *=(const BigInteger &x);
- void operator /=(const BigInteger &x);
- void operator %=(const BigInteger &x);
- void flipSign();
-
- // INCREMENT/DECREMENT OPERATORS
- void operator ++( );
- void operator ++(int);
- void operator --( );
- void operator --(int);
-};
-
-// NORMAL OPERATORS
-/* These create an object to hold the result and invoke
- * the appropriate put-here operation on it, passing
- * this and x. The new object is then returned. */
-inline BigInteger BigInteger::operator +(const BigInteger &x) const {
- BigInteger ans;
- ans.add(*this, x);
- return ans;
-}
-inline BigInteger BigInteger::operator -(const BigInteger &x) const {
- BigInteger ans;
- ans.subtract(*this, x);
- return ans;
-}
-inline BigInteger BigInteger::operator *(const BigInteger &x) const {
- BigInteger ans;
- ans.multiply(*this, x);
- return ans;
-}
-inline BigInteger BigInteger::operator /(const BigInteger &x) const {
- if (x.isZero()) throw "BigInteger::operator /: division by zero";
- BigInteger q, r;
- r = *this;
- r.divideWithRemainder(x, q);
- return q;
-}
-inline BigInteger BigInteger::operator %(const BigInteger &x) const {
- if (x.isZero()) throw "BigInteger::operator %: division by zero";
- BigInteger q, r;
- r = *this;
- r.divideWithRemainder(x, q);
- return r;
-}
-inline BigInteger BigInteger::operator -() const {
- BigInteger ans;
- ans.negate(*this);
- return ans;
-}
-
-/*
- * ASSIGNMENT OPERATORS
- *
- * Now the responsibility for making a temporary copy if necessary
- * belongs to the put-here operations. See Assignment Operators in
- * BigUnsigned.hh.
- */
-inline void BigInteger::operator +=(const BigInteger &x) {
- add(*this, x);
-}
-inline void BigInteger::operator -=(const BigInteger &x) {
- subtract(*this, x);
-}
-inline void BigInteger::operator *=(const BigInteger &x) {
- multiply(*this, x);
-}
-inline void BigInteger::operator /=(const BigInteger &x) {
- if (x.isZero()) throw "BigInteger::operator /=: division by zero";
- /* The following technique is slightly faster than copying *this first
- * when x is large. */
- BigInteger q;
- divideWithRemainder(x, q);
- // *this contains the remainder, but we overwrite it with the quotient.
- *this = q;
-}
-inline void BigInteger::operator %=(const BigInteger &x) {
- if (x.isZero()) throw "BigInteger::operator %=: division by zero";
- BigInteger q;
- // Mods *this by x. Don't care about quotient left in q.
- divideWithRemainder(x, q);
-}
-// This one is trivial
-inline void BigInteger::flipSign() {
- sign = Sign(-sign);
-}
-
-#endif
+++ /dev/null
-#include "BigIntegerAlgorithms.hh"
-
-BigUnsigned gcd(BigUnsigned a, BigUnsigned b) {
- BigUnsigned trash;
- // Neat in-place alternating technique.
- for (;;) {
- if (b.isZero())
- return a;
- a.divideWithRemainder(b, trash);
- if (a.isZero())
- return b;
- b.divideWithRemainder(a, trash);
- }
-}
-
-void extendedEuclidean(BigInteger m, BigInteger n,
- BigInteger &g, BigInteger &r, BigInteger &s) {
- if (&g == &r || &g == &s || &r == &s)
- throw "BigInteger extendedEuclidean: Outputs are aliased";
- BigInteger r1(1), s1(0), r2(0), s2(1), q;
- /* Invariants:
- * r1*m(orig) + s1*n(orig) == m(current)
- * r2*m(orig) + s2*n(orig) == n(current) */
- for (;;) {
- if (n.isZero()) {
- r = r1; s = s1; g = m;
- return;
- }
- // Subtract q times the second invariant from the first invariant.
- m.divideWithRemainder(n, q);
- r1 -= q*r2; s1 -= q*s2;
-
- if (m.isZero()) {
- r = r2; s = s2; g = n;
- return;
- }
- // Subtract q times the first invariant from the second invariant.
- n.divideWithRemainder(m, q);
- r2 -= q*r1; s2 -= q*s1;
- }
-}
-
-BigUnsigned modinv(const BigInteger &x, const BigUnsigned &n) {
- BigInteger g, r, s;
- extendedEuclidean(x, n, g, r, s);
- if (g == 1)
- // r*x + s*n == 1, so r*x === 1 (mod n), so r is the answer.
- return (r % n).getMagnitude(); // (r % n) will be nonnegative
- else
- throw "BigInteger modinv: x and n have a common factor";
-}
-
-BigUnsigned modexp(const BigInteger &base, const BigUnsigned &exponent,
- const BigUnsigned &modulus) {
- BigUnsigned ans = 1, base2 = (base % modulus).getMagnitude();
- BigUnsigned::Index i = exponent.bitLength();
- // For each bit of the exponent, most to least significant...
- while (i > 0) {
- i--;
- // Square.
- ans *= ans;
- ans %= modulus;
- // And multiply if the bit is a 1.
- if (exponent.getBit(i)) {
- ans *= base2;
- ans %= modulus;
- }
- }
- return ans;
-}
+++ /dev/null
-#ifndef BIGINTEGERALGORITHMS_H
-#define BIGINTEGERALGORITHMS_H
-
-#include "BigInteger.hh"
-
-/* Some mathematical algorithms for big integers.
- * This code is new and, as such, experimental. */
-
-// Returns the greatest common divisor of a and b.
-BigUnsigned gcd(BigUnsigned a, BigUnsigned b);
-
-/* Extended Euclidean algorithm.
- * Given m and n, finds gcd g and numbers r, s such that r*m + s*n == g. */
-void extendedEuclidean(BigInteger m, BigInteger n,
- BigInteger &g, BigInteger &r, BigInteger &s);
-
-/* Returns the multiplicative inverse of x modulo n, or throws an exception if
- * they have a common factor. */
-BigUnsigned modinv(const BigInteger &x, const BigUnsigned &n);
-
-// Returns (base ^ exponent) % modulus.
-BigUnsigned modexp(const BigInteger &base, const BigUnsigned &exponent,
- const BigUnsigned &modulus);
-
-#endif
+++ /dev/null
-// This header file includes all of the library header files.
-
-#include "NumberlikeArray.hh"
-#include "BigUnsigned.hh"
-#include "BigInteger.hh"
-#include "BigIntegerAlgorithms.hh"
-#include "BigUnsignedInABase.hh"
-#include "BigIntegerUtils.hh"
+++ /dev/null
-#include "BigIntegerUtils.hh"
-#include "BigUnsignedInABase.hh"
-
-std::string bigUnsignedToString(const BigUnsigned &x) {
- return std::string(BigUnsignedInABase(x, 10));
-}
-
-std::string bigIntegerToString(const BigInteger &x) {
- return (x.getSign() == BigInteger::negative)
- ? (std::string("-") + bigUnsignedToString(x.getMagnitude()))
- : (bigUnsignedToString(x.getMagnitude()));
-}
-
-BigUnsigned stringToBigUnsigned(const std::string &s) {
- return BigUnsigned(BigUnsignedInABase(s, 10));
-}
-
-BigInteger stringToBigInteger(const std::string &s) {
- // Recognize a sign followed by a BigUnsigned.
- return (s[0] == '-') ? BigInteger(stringToBigUnsigned(s.substr(1, s.length() - 1)), BigInteger::negative)
- : (s[0] == '+') ? BigInteger(stringToBigUnsigned(s.substr(1, s.length() - 1)))
- : BigInteger(stringToBigUnsigned(s));
-}
-
-std::ostream &operator <<(std::ostream &os, const BigUnsigned &x) {
- BigUnsignedInABase::Base base;
- long osFlags = os.flags();
- if (osFlags & os.dec)
- base = 10;
- else if (osFlags & os.hex) {
- base = 16;
- if (osFlags & os.showbase)
- os << "0x";
- } else if (osFlags & os.oct) {
- base = 8;
- if (osFlags & os.showbase)
- os << '0';
- } else
- throw "std::ostream << BigUnsigned: Could not determine the desired base from output-stream flags";
- std::string s = std::string(BigUnsignedInABase(x, base));
- os << s;
- return os;
-}
-
-std::ostream &operator <<(std::ostream &os, const BigInteger &x) {
- if (x.getSign() == BigInteger::negative)
- os << '-';
- os << x.getMagnitude();
- return os;
-}
+++ /dev/null
-#ifndef BIGINTEGERUTILS_H
-#define BIGINTEGERUTILS_H
-
-#include "BigInteger.hh"
-#include <string>
-#include <iostream>
-
-/* This file provides:
- * - Convenient std::string <-> BigUnsigned/BigInteger conversion routines
- * - std::ostream << operators for BigUnsigned/BigInteger */
-
-// std::string conversion routines. Base 10 only.
-std::string bigUnsignedToString(const BigUnsigned &x);
-std::string bigIntegerToString(const BigInteger &x);
-BigUnsigned stringToBigUnsigned(const std::string &s);
-BigInteger stringToBigInteger(const std::string &s);
-
-// Creates a BigInteger from data such as `char's; read below for details.
-template <class T>
-BigInteger dataToBigInteger(const T* data, BigInteger::Index length, BigInteger::Sign sign);
-
-// Outputs x to os, obeying the flags `dec', `hex', `bin', and `showbase'.
-std::ostream &operator <<(std::ostream &os, const BigUnsigned &x);
-
-// Outputs x to os, obeying the flags `dec', `hex', `bin', and `showbase'.
-// My somewhat arbitrary policy: a negative sign comes before a base indicator (like -0xFF).
-std::ostream &operator <<(std::ostream &os, const BigInteger &x);
-
-// BEGIN TEMPLATE DEFINITIONS.
-
-/*
- * Converts binary data to a BigInteger.
- * Pass an array `data', its length, and the desired sign.
- *
- * Elements of `data' may be of any type `T' that has the following
- * two properties (this includes almost all integral types):
- *
- * (1) `sizeof(T)' correctly gives the amount of binary data in one
- * value of `T' and is a factor of `sizeof(Blk)'.
- *
- * (2) When a value of `T' is casted to a `Blk', the low bytes of
- * the result contain the desired binary data.
- */
-template <class T>
-BigInteger dataToBigInteger(const T* data, BigInteger::Index length, BigInteger::Sign sign) {
- // really ceiling(numBytes / sizeof(BigInteger::Blk))
- unsigned int pieceSizeInBits = 8 * sizeof(T);
- unsigned int piecesPerBlock = sizeof(BigInteger::Blk) / sizeof(T);
- unsigned int numBlocks = (length + piecesPerBlock - 1) / piecesPerBlock;
-
- // Allocate our block array
- BigInteger::Blk *blocks = new BigInteger::Blk[numBlocks];
-
- BigInteger::Index blockNum, pieceNum, pieceNumHere;
-
- // Convert
- for (blockNum = 0, pieceNum = 0; blockNum < numBlocks; blockNum++) {
- BigInteger::Blk curBlock = 0;
- for (pieceNumHere = 0; pieceNumHere < piecesPerBlock && pieceNum < length;
- pieceNumHere++, pieceNum++)
- curBlock |= (BigInteger::Blk(data[pieceNum]) << (pieceSizeInBits * pieceNumHere));
- blocks[blockNum] = curBlock;
- }
-
- // Create the BigInteger.
- BigInteger x(blocks, numBlocks, sign);
-
- delete [] blocks;
- return x;
-}
-
-#endif
+++ /dev/null
-#include "BigUnsigned.hh"
-
-// Memory management definitions have moved to the bottom of NumberlikeArray.hh.
-
-// The templates used by these constructors and converters are at the bottom of
-// BigUnsigned.hh.
-
-BigUnsigned::BigUnsigned(unsigned long x) { initFromPrimitive (x); }
-BigUnsigned::BigUnsigned(unsigned int x) { initFromPrimitive (x); }
-BigUnsigned::BigUnsigned(unsigned short x) { initFromPrimitive (x); }
-BigUnsigned::BigUnsigned( long x) { initFromSignedPrimitive(x); }
-BigUnsigned::BigUnsigned( int x) { initFromSignedPrimitive(x); }
-BigUnsigned::BigUnsigned( short x) { initFromSignedPrimitive(x); }
-
-unsigned long BigUnsigned::toUnsignedLong () const { return convertToPrimitive <unsigned long >(); }
-unsigned int BigUnsigned::toUnsignedInt () const { return convertToPrimitive <unsigned int >(); }
-unsigned short BigUnsigned::toUnsignedShort() const { return convertToPrimitive <unsigned short>(); }
-long BigUnsigned::toLong () const { return convertToSignedPrimitive< long >(); }
-int BigUnsigned::toInt () const { return convertToSignedPrimitive< int >(); }
-short BigUnsigned::toShort () const { return convertToSignedPrimitive< short>(); }
-
-// BIT/BLOCK ACCESSORS
-
-void BigUnsigned::setBlock(Index i, Blk newBlock) {
- if (newBlock == 0) {
- if (i < len) {
- blk[i] = 0;
- zapLeadingZeros();
- }
- // If i >= len, no effect.
- } else {
- if (i >= len) {
- // The nonzero block extends the number.
- allocateAndCopy(i+1);
- // Zero any added blocks that we aren't setting.
- for (Index j = len; j < i; j++)
- blk[j] = 0;
- len = i+1;
- }
- blk[i] = newBlock;
- }
-}
-
-/* Evidently the compiler wants BigUnsigned:: on the return type because, at
- * that point, it hasn't yet parsed the BigUnsigned:: on the name to get the
- * proper scope. */
-BigUnsigned::Index BigUnsigned::bitLength() const {
- if (isZero())
- return 0;
- else {
- Blk leftmostBlock = getBlock(len - 1);
- Index leftmostBlockLen = 0;
- while (leftmostBlock != 0) {
- leftmostBlock >>= 1;
- leftmostBlockLen++;
- }
- return leftmostBlockLen + (len - 1) * N;
- }
-}
-
-void BigUnsigned::setBit(Index bi, bool newBit) {
- Index blockI = bi / N;
- Blk block = getBlock(blockI), mask = Blk(1) << (bi % N);
- block = newBit ? (block | mask) : (block & ~mask);
- setBlock(blockI, block);
-}
-
-// COMPARISON
-BigUnsigned::CmpRes BigUnsigned::compareTo(const BigUnsigned &x) const {
- // A bigger length implies a bigger number.
- if (len < x.len)
- return less;
- else if (len > x.len)
- return greater;
- else {
- // Compare blocks one by one from left to right.
- Index i = len;
- while (i > 0) {
- i--;
- if (blk[i] == x.blk[i])
- continue;
- else if (blk[i] > x.blk[i])
- return greater;
- else
- return less;
- }
- // If no blocks differed, the numbers are equal.
- return equal;
- }
-}
-
-// COPY-LESS OPERATIONS
-
-/*
- * On most calls to copy-less 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 DTRT_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 DTRT_ALIASED(cond, op) \
- if (cond) { \
- BigUnsigned tmpThis; \
- tmpThis.op; \
- *this = tmpThis; \
- return; \
- }
-
-
-
-void BigUnsigned::add(const BigUnsigned &a, const BigUnsigned &b) {
- DTRT_ALIASED(this == &a || this == &b, add(a, b));
- // If one argument is zero, copy the other.
- if (a.len == 0) {
- operator =(b);
- return;
- } else if (b.len == 0) {
- operator =(a);
- return;
- }
- // Some variables...
- // Carries in and out of an addition stage
- bool carryIn, carryOut;
- Blk temp;
- Index i;
- // a2 points to the longer input, b2 points to the shorter
- const BigUnsigned *a2, *b2;
- if (a.len >= b.len) {
- a2 = &a;
- b2 = &b;
- } else {
- a2 = &b;
- b2 = &a;
- }
- // Set prelimiary length and make room in this BigUnsigned
- len = a2->len + 1;
- allocate(len);
- // For each block index that is present in both inputs...
- for (i = 0, carryIn = false; i < b2->len; i++) {
- // Add input blocks
- temp = a2->blk[i] + b2->blk[i];
- // If a rollover occurred, the result is less than either input.
- // This test is used many times in the BigUnsigned code.
- carryOut = (temp < a2->blk[i]);
- // If a carry was input, handle it
- if (carryIn) {
- temp++;
- carryOut |= (temp == 0);
- }
- blk[i] = temp; // Save the addition result
- carryIn = carryOut; // Pass the carry along
- }
- // If there is a carry left over, increase blocks until
- // one does not roll over.
- for (; i < a2->len && carryIn; i++) {
- temp = a2->blk[i] + 1;
- carryIn = (temp == 0);
- blk[i] = temp;
- }
- // If the carry was resolved but the larger number
- // still has blocks, copy them over.
- for (; i < a2->len; i++)
- blk[i] = a2->blk[i];
- // Set the extra block if there's still a carry, decrease length otherwise
- if (carryIn)
- blk[i] = 1;
- else
- len--;
-}
-
-void BigUnsigned::subtract(const BigUnsigned &a, const BigUnsigned &b) {
- DTRT_ALIASED(this == &a || this == &b, subtract(a, b));
- if (b.len == 0) {
- // If b is zero, copy a.
- operator =(a);
- return;
- } else if (a.len < b.len)
- // If a is shorter than b, the result is negative.
- throw "BigUnsigned::subtract: "
- "Negative result in unsigned calculation";
- // Some variables...
- bool borrowIn, borrowOut;
- Blk temp;
- Index i;
- // Set preliminary length and make room
- len = a.len;
- allocate(len);
- // For each block index that is present in both inputs...
- for (i = 0, borrowIn = false; i < b.len; i++) {
- temp = a.blk[i] - b.blk[i];
- // If a reverse rollover occurred,
- // the result is greater than the block from a.
- borrowOut = (temp > a.blk[i]);
- // Handle an incoming borrow
- if (borrowIn) {
- borrowOut |= (temp == 0);
- temp--;
- }
- blk[i] = temp; // Save the subtraction result
- borrowIn = borrowOut; // Pass the borrow along
- }
- // If there is a borrow left over, decrease blocks until
- // one does not reverse rollover.
- for (; i < a.len && borrowIn; i++) {
- borrowIn = (a.blk[i] == 0);
- blk[i] = a.blk[i] - 1;
- }
- /* If there's still a borrow, the result is negative.
- * Throw an exception, but zero out this object so as to leave it in a
- * predictable state. */
- if (borrowIn) {
- len = 0;
- throw "BigUnsigned::subtract: Negative result in unsigned calculation";
- } else
- // Copy over the rest of the blocks
- for (; i < a.len; i++)
- blk[i] = a.blk[i];
- // Zap leading zeros
- zapLeadingZeros();
-}
-
-/*
- * About the multiplication and division algorithms:
- *
- * I searched unsucessfully for fast C++ built-in operations like the `b_0'
- * and `c_0' Knuth describes in Section 4.3.1 of ``The Art of Computer
- * Programming'' (replace `place' by `Blk'):
- *
- * ``b_0[:] multiplication of a one-place integer by another one-place
- * integer, giving a two-place answer;
- *
- * ``c_0[:] division of a two-place integer by a one-place integer,
- * provided that the quotient is a one-place integer, and yielding
- * also a one-place remainder.''
- *
- * I also missed his note that ``[b]y adjusting the word size, if
- * necessary, nearly all computers will have these three operations
- * available'', so I gave up on trying to use algorithms similar to his.
- * A future version of the library might include such algorithms; I
- * would welcome contributions from others for this.
- *
- * I eventually decided to use bit-shifting algorithms. To multiply `a'
- * and `b', we zero out the result. Then, for each `1' bit in `a', we
- * shift `b' left the appropriate amount and add it to the result.
- * Similarly, to divide `a' by `b', we shift `b' left varying amounts,
- * repeatedly trying to subtract it from `a'. When we succeed, we note
- * the fact by setting a bit in the quotient. While these algorithms
- * have the same O(n^2) time complexity as Knuth's, the ``constant factor''
- * is likely to be larger.
- *
- * Because I used these algorithms, which require single-block addition
- * and subtraction rather than single-block multiplication and division,
- * the innermost loops of all four routines are very similar. Study one
- * of them and all will become clear.
- */
-
-/*
- * This is a little inline function used by both the multiplication
- * routine and the division routine.
- *
- * `getShiftedBlock' returns the `x'th block of `num << y'.
- * `y' may be anything from 0 to N - 1, and `x' may be anything from
- * 0 to `num.len'.
- *
- * Two things contribute to this block:
- *
- * (1) The `N - y' low bits of `num.blk[x]', shifted `y' bits left.
- *
- * (2) The `y' high bits of `num.blk[x-1]', shifted `N - y' bits right.
- *
- * But we must be careful if `x == 0' or `x == num.len', in
- * which case we should use 0 instead of (2) or (1), respectively.
- *
- * If `y == 0', then (2) contributes 0, as it should. However,
- * in some computer environments, for a reason I cannot understand,
- * `a >> b' means `a >> (b % N)'. This means `num.blk[x-1] >> (N - y)'
- * will return `num.blk[x-1]' instead of the desired 0 when `y == 0';
- * the test `y == 0' handles this case specially.
- */
-inline BigUnsigned::Blk getShiftedBlock(const BigUnsigned &num,
- BigUnsigned::Index x, unsigned int y) {
- BigUnsigned::Blk part1 = (x == 0 || y == 0) ? 0 : (num.blk[x - 1] >> (BigUnsigned::N - y));
- BigUnsigned::Blk part2 = (x == num.len) ? 0 : (num.blk[x] << y);
- return part1 | part2;
-}
-
-void BigUnsigned::multiply(const BigUnsigned &a, const BigUnsigned &b) {
- DTRT_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;
- return;
- }
- /*
- * Overall method:
- *
- * Set this = 0.
- * For each 1-bit of `a' (say the `i2'th bit of block `i'):
- * Add `b << (i blocks and i2 bits)' to *this.
- */
- // Variables for the calculation
- Index i, j, k;
- unsigned int i2;
- Blk temp;
- bool carryIn, carryOut;
- // Set preliminary length and make room
- len = a.len + b.len;
- allocate(len);
- // Zero out this object
- for (i = 0; i < len; i++)
- blk[i] = 0;
- // For each block of the first number...
- for (i = 0; i < a.len; i++) {
- // For each 1-bit of that block...
- for (i2 = 0; i2 < N; i2++) {
- if ((a.blk[i] & (Blk(1) << i2)) == 0)
- continue;
- /*
- * Add b to this, shifted left i blocks and i2 bits.
- * j is the index in b, and k = i + j is the index in this.
- *
- * `getShiftedBlock', a short inline function defined above,
- * is now used for the bit handling. It replaces the more
- * complex `bHigh' code, in which each run of the loop dealt
- * immediately with the low bits and saved the high bits to
- * be picked up next time. The last run of the loop used to
- * leave leftover high bits, which were handled separately.
- * Instead, this loop runs an additional time with j == b.len.
- * These changes were made on 2005.01.11.
- */
- for (j = 0, k = i, carryIn = false; j <= b.len; j++, k++) {
- /*
- * The body of this loop is very similar to the body of the first loop
- * in `add', except that this loop does a `+=' instead of a `+'.
- */
- temp = blk[k] + getShiftedBlock(b, j, i2);
- carryOut = (temp < blk[k]);
- if (carryIn) {
- temp++;
- carryOut |= (temp == 0);
- }
- blk[k] = temp;
- carryIn = carryOut;
- }
- // No more extra iteration to deal with `bHigh'.
- // Roll-over a carry as necessary.
- for (; carryIn; k++) {
- blk[k]++;
- carryIn = (blk[k] == 0);
- }
- }
- }
- // Zap possible leading zero
- if (blk[len - 1] == 0)
- len--;
-}
-
-/*
- * DIVISION WITH REMAINDER
- * This monstrous function mods *this by the given divisor b while storing the
- * quotient in the given object q; at the end, *this contains the remainder.
- * The seemingly bizarre pattern of inputs and outputs was chosen so that the
- * function copies as little as possible (since it is implemented by repeated
- * subtraction of multiples of b from *this).
- *
- * "modWithQuotient" might be a better name for this function, but I would
- * rather not change the name now.
- */
-void BigUnsigned::divideWithRemainder(const BigUnsigned &b, BigUnsigned &q) {
- /* Defending against aliased calls is more complex than usual 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;
- }
-
- /*
- * Knuth's definition of mod (which this function uses) is somewhat
- * different from the C++ definition of % in case of division by 0.
- *
- * We let a / 0 == 0 (it doesn't matter much) and a % 0 == a, no
- * exceptions thrown. This allows us to preserve both Knuth's demand
- * that a mod 0 == a and the useful property that
- * (a / b) * b + (a % b) == a.
- */
- if (b.len == 0) {
- q.len = 0;
- return;
- }
-
- /*
- * If *this.len < b.len, then *this < b, and we can be sure that b doesn't go into
- * *this at all. The quotient is 0 and *this is already the remainder (so leave it alone).
- */
- if (len < b.len) {
- q.len = 0;
- return;
- }
-
- // At this point we know (*this).len >= b.len > 0. (Whew!)
-
- /*
- * Overall method:
- *
- * For each appropriate i and i2, decreasing:
- * Subtract (b << (i blocks and i2 bits)) from *this, storing the
- * result in subtractBuf.
- * If the subtraction succeeds with a nonnegative result:
- * Turn on bit i2 of block i of the quotient q.
- * Copy subtractBuf back into *this.
- * Otherwise bit i2 of block i remains off, and *this is unchanged.
- *
- * Eventually q will contain the entire quotient, and *this will
- * be left with the remainder.
- *
- * subtractBuf[x] corresponds to blk[x], not blk[x+i], since 2005.01.11.
- * But on a single iteration, we don't touch the i lowest blocks of blk
- * (and don't use those of subtractBuf) because these blocks are
- * unaffected by the subtraction: we are subtracting
- * (b << (i blocks and i2 bits)), which ends in at least `i' zero
- * blocks. */
- // Variables for the calculation
- Index i, j, k;
- unsigned int i2;
- Blk temp;
- bool borrowIn, borrowOut;
-
- /*
- * Make sure we have an extra zero block just past the value.
- *
- * When we attempt a subtraction, we might shift `b' so
- * its first block begins a few bits left of the dividend,
- * and then we'll try to compare these extra bits with
- * a nonexistent block to the left of the dividend. The
- * extra zero block ensures sensible behavior; we need
- * an extra block in `subtractBuf' for exactly the same reason.
- */
- Index origLen = len; // Save real length.
- /* To avoid an out-of-bounds access in case of reallocation, allocate
- * first and then increment the logical length. */
- allocateAndCopy(len + 1);
- len++;
- blk[origLen] = 0; // Zero the added block.
-
- // subtractBuf holds part of the result of a subtraction; see above.
- Blk *subtractBuf = new Blk[len];
-
- // Set preliminary length for quotient and make room
- q.len = origLen - b.len + 1;
- q.allocate(q.len);
- // Zero out the quotient
- for (i = 0; i < q.len; i++)
- q.blk[i] = 0;
-
- // For each possible left-shift of b in blocks...
- i = q.len;
- while (i > 0) {
- i--;
- // For each possible left-shift of b in bits...
- // (Remember, N is the number of bits in a Blk.)
- q.blk[i] = 0;
- i2 = N;
- while (i2 > 0) {
- i2--;
- /*
- * Subtract b, shifted left i blocks and i2 bits, from *this,
- * and store the answer in subtractBuf. In the for loop, `k == i + j'.
- *
- * Compare this to the middle section of `multiply'. They
- * are in many ways analogous. See especially the discussion
- * of `getShiftedBlock'.
- */
- for (j = 0, k = i, borrowIn = false; j <= b.len; j++, k++) {
- temp = blk[k] - getShiftedBlock(b, j, i2);
- borrowOut = (temp > blk[k]);
- if (borrowIn) {
- borrowOut |= (temp == 0);
- temp--;
- }
- // Since 2005.01.11, indices of `subtractBuf' directly match those of `blk', so use `k'.
- subtractBuf[k] = temp;
- borrowIn = borrowOut;
- }
- // No more extra iteration to deal with `bHigh'.
- // Roll-over a borrow as necessary.
- for (; k < origLen && borrowIn; k++) {
- borrowIn = (blk[k] == 0);
- subtractBuf[k] = blk[k] - 1;
- }
- /*
- * If the subtraction was performed successfully (!borrowIn),
- * set bit i2 in block i of the quotient.
- *
- * Then, copy the portion of subtractBuf filled by the subtraction
- * back to *this. This portion starts with block i and ends--
- * where? Not necessarily at block `i + b.len'! Well, we
- * increased k every time we saved a block into subtractBuf, so
- * the region of subtractBuf we copy is just [i, k).
- */
- if (!borrowIn) {
- q.blk[i] |= (Blk(1) << i2);
- while (k > i) {
- k--;
- blk[k] = subtractBuf[k];
- }
- }
- }
- }
- // Zap possible leading zero in quotient
- if (q.blk[q.len - 1] == 0)
- q.len--;
- // Zap any/all leading zeros in remainder
- zapLeadingZeros();
- // Deallocate subtractBuf.
- // (Thanks to Brad Spencer for noticing my accidental omission of this!)
- delete [] subtractBuf;
-}
-
-/* BITWISE OPERATORS
- * These are straightforward blockwise operations except that they differ in
- * the output length and the necessity of zapLeadingZeros. */
-
-void BigUnsigned::bitAnd(const BigUnsigned &a, const BigUnsigned &b) {
- DTRT_ALIASED(this == &a || this == &b, bitAnd(a, b));
- // The bitwise & can't be longer than either operand.
- len = (a.len >= b.len) ? b.len : a.len;
- allocate(len);
- Index i;
- for (i = 0; i < len; i++)
- blk[i] = a.blk[i] & b.blk[i];
- zapLeadingZeros();
-}
-
-void BigUnsigned::bitOr(const BigUnsigned &a, const BigUnsigned &b) {
- DTRT_ALIASED(this == &a || this == &b, bitOr(a, b));
- Index i;
- const BigUnsigned *a2, *b2;
- if (a.len >= b.len) {
- a2 = &a;
- b2 = &b;
- } else {
- a2 = &b;
- b2 = &a;
- }
- allocate(a2->len);
- for (i = 0; i < b2->len; i++)
- blk[i] = a2->blk[i] | b2->blk[i];
- for (; i < a2->len; i++)
- blk[i] = a2->blk[i];
- len = a2->len;
- // Doesn't need zapLeadingZeros.
-}
-
-void BigUnsigned::bitXor(const BigUnsigned &a, const BigUnsigned &b) {
- DTRT_ALIASED(this == &a || this == &b, bitXor(a, b));
- Index i;
- const BigUnsigned *a2, *b2;
- if (a.len >= b.len) {
- a2 = &a;
- b2 = &b;
- } else {
- a2 = &b;
- b2 = &a;
- }
- allocate(a2->len);
- for (i = 0; i < b2->len; i++)
- blk[i] = a2->blk[i] ^ b2->blk[i];
- for (; i < a2->len; i++)
- blk[i] = a2->blk[i];
- len = a2->len;
- zapLeadingZeros();
-}
-
-void BigUnsigned::bitShiftLeft(const BigUnsigned &a, int b) {
- DTRT_ALIASED(this == &a, bitShiftLeft(a, b));
- if (b < 0) {
- if (b << 1 == 0)
- throw "BigUnsigned::bitShiftLeft: "
- "Pathological shift amount not implemented";
- else {
- bitShiftRight(a, -b);
- return;
- }
- }
- Index shiftBlocks = b / N;
- unsigned int shiftBits = b % N;
- // + 1: room for high bits nudged left into another block
- len = a.len + shiftBlocks + 1;
- allocate(len);
- Index i, j;
- for (i = 0; i < shiftBlocks; i++)
- blk[i] = 0;
- for (j = 0, i = shiftBlocks; j <= a.len; j++, i++)
- blk[i] = getShiftedBlock(a, j, shiftBits);
- // Zap possible leading zero
- if (blk[len - 1] == 0)
- len--;
-}
-
-void BigUnsigned::bitShiftRight(const BigUnsigned &a, int b) {
- DTRT_ALIASED(this == &a, bitShiftRight(a, b));
- if (b < 0) {
- if (b << 1 == 0)
- throw "BigUnsigned::bitShiftRight: "
- "Pathological shift amount not implemented";
- else {
- bitShiftLeft(a, -b);
- return;
- }
- }
- // This calculation is wacky, but expressing the shift as a left bit shift
- // within each block lets us use getShiftedBlock.
- Index rightShiftBlocks = (b + N - 1) / N;
- unsigned int leftShiftBits = N * rightShiftBlocks - b;
- // Now (N * rightShiftBlocks - leftShiftBits) == b
- // and 0 <= leftShiftBits < N.
- if (rightShiftBlocks >= a.len + 1) {
- // All of a is guaranteed to be shifted off, even considering the left
- // bit shift.
- len = 0;
- return;
- }
- // Now we're allocating a positive amount.
- // + 1: room for high bits nudged left into another block
- len = a.len + 1 - rightShiftBlocks;
- allocate(len);
- Index i, j;
- for (j = rightShiftBlocks, i = 0; j <= a.len; j++, i++)
- blk[i] = getShiftedBlock(a, j, leftShiftBits);
- // Zap possible leading zero
- if (blk[len - 1] == 0)
- len--;
-}
-
-// INCREMENT/DECREMENT OPERATORS
-
-// Prefix increment
-void BigUnsigned::operator ++() {
- Index i;
- bool carry = true;
- for (i = 0; i < len && carry; i++) {
- blk[i]++;
- carry = (blk[i] == 0);
- }
- if (carry) {
- // Allocate and then increase length, as in divideWithRemainder
- allocateAndCopy(len + 1);
- len++;
- blk[i] = 1;
- }
-}
-
-// Postfix increment: same as prefix
-void BigUnsigned::operator ++(int) {
- operator ++();
-}
-
-// Prefix decrement
-void BigUnsigned::operator --() {
- if (len == 0)
- throw "BigUnsigned::operator --(): Cannot decrement an unsigned zero";
- Index i;
- bool borrow = true;
- for (i = 0; borrow; i++) {
- borrow = (blk[i] == 0);
- blk[i]--;
- }
- // Zap possible leading zero (there can only be one)
- if (blk[len - 1] == 0)
- len--;
-}
-
-// Postfix decrement: same as prefix
-void BigUnsigned::operator --(int) {
- operator --();
-}
+++ /dev/null
-#ifndef BIGUNSIGNED_H
-#define BIGUNSIGNED_H
-
-#include "NumberlikeArray.hh"
-
-/* A BigUnsigned object represents a nonnegative integer of size limited only by
- * available memory. BigUnsigneds support most mathematical operators and can
- * be converted to and from most primitive integer types.
- *
- * The number is stored as a NumberlikeArray of unsigned longs as if it were
- * written in base 256^sizeof(unsigned long). The least significant block is
- * first, and the length is such that the most significant block is nonzero. */
-class BigUnsigned : protected NumberlikeArray<unsigned long> {
-
-public:
- // Enumeration for the result of a comparison.
- enum CmpRes { less = -1, equal = 0, greater = 1 };
-
- // BigUnsigneds are built with a Blk type of unsigned long.
- typedef unsigned long Blk;
-
- typedef NumberlikeArray<Blk>::Index Index;
- using NumberlikeArray<Blk>::N;
-
-protected:
- // Creates a BigUnsigned with a capacity; for internal use.
- BigUnsigned(int, Index c) : NumberlikeArray<Blk>(0, c) {}
-
- // Decreases len to eliminate any leading zero blocks.
- void zapLeadingZeros() {
- while (len > 0 && blk[len - 1] == 0)
- len--;
- }
-
-public:
- // Constructs zero.
- BigUnsigned() : NumberlikeArray<Blk>() {}
-
- // Copy constructor
- BigUnsigned(const BigUnsigned &x) : NumberlikeArray<Blk>(x) {}
-
- // Assignment operator
- void operator=(const BigUnsigned &x) {
- NumberlikeArray<Blk>::operator =(x);
- }
-
- // Constructor that copies from a given array of blocks.
- BigUnsigned(const Blk *b, Index blen) : NumberlikeArray<Blk>(b, blen) {
- // Eliminate any leading zeros we may have been passed.
- zapLeadingZeros();
- }
-
- // Destructor. NumberlikeArray does the delete for us.
- ~BigUnsigned() {}
-
- // Constructors from primitive integer types
- BigUnsigned(unsigned long x);
- BigUnsigned( long x);
- BigUnsigned(unsigned int x);
- BigUnsigned( int x);
- BigUnsigned(unsigned short x);
- BigUnsigned( short x);
-protected:
- // Helpers
- template <class X> void initFromPrimitive (X x);
- template <class X> void initFromSignedPrimitive(X x);
-public:
-
- /* Converters to primitive integer types
- * The implicit conversion operators caused trouble, so these are now
- * named. */
- unsigned long toUnsignedLong () const;
- long toLong () const;
- unsigned int toUnsignedInt () const;
- int toInt () const;
- unsigned short toUnsignedShort() const;
- short toShort () const;
-protected:
- // Helpers
- template <class X> X convertToSignedPrimitive() const;
- template <class X> X convertToPrimitive () const;
-public:
-
- // BIT/BLOCK ACCESSORS
-
- // Expose these from NumberlikeArray directly.
- using NumberlikeArray<Blk>::getCapacity;
- using NumberlikeArray<Blk>::getLength;
-
- /* Returns the requested block, or 0 if it is beyond the length (as if
- * the number had 0s infinitely to the left). */
- Blk getBlock(Index i) const { return i >= len ? 0 : blk[i]; }
- /* Sets the requested block. The number grows or shrinks as necessary. */
- void setBlock(Index i, Blk newBlock);
-
- // The number is zero if and only if the canonical length is zero.
- bool isZero() const { return NumberlikeArray<Blk>::isEmpty(); }
-
- /* Returns the length of the number in bits, i.e., zero if the number
- * is zero and otherwise one more than the largest value of bi for
- * which getBit(bi) returns true. */
- Index bitLength() const;
- /* Get the state of bit bi, which has value 2^bi. Bits beyond the
- * number's length are considered to be 0. */
- bool getBit(Index bi) const {
- return (getBlock(bi / N) & (Blk(1) << (bi % N))) != 0;
- }
- /* Sets the state of bit bi to newBit. The number grows or shrinks as
- * necessary. */
- void setBit(Index bi, bool newBit);
-
- // COMPARISONS
-
- // Compares this to x like Perl's <=>
- CmpRes compareTo(const BigUnsigned &x) const;
-
- // Ordinary comparison operators
- bool operator ==(const BigUnsigned &x) const {
- return NumberlikeArray<Blk>::operator ==(x);
- }
- bool operator !=(const BigUnsigned &x) const {
- return NumberlikeArray<Blk>::operator !=(x);
- }
- bool operator < (const BigUnsigned &x) const { return compareTo(x) == less ; }
- bool operator <=(const BigUnsigned &x) const { return compareTo(x) != greater; }
- bool operator >=(const BigUnsigned &x) const { return compareTo(x) != less ; }
- bool operator > (const BigUnsigned &x) const { return compareTo(x) == greater; }
-
- /*
- * BigUnsigned and BigInteger both provide three kinds of operators.
- * Here ``big-integer'' refers to BigInteger or BigUnsigned.
- *
- * (1) Overloaded ``return-by-value'' operators:
- * +, -, *, /, %, unary -, &, |, ^, <<, >>.
- * Big-integer code using these operators looks identical to code using
- * the primitive integer types. These operators take one or two
- * big-integer inputs and return a big-integer result, which can then
- * be assigned to a BigInteger variable or used in an expression.
- * Example:
- * BigInteger a(1), b = 1;
- * BigInteger c = a + b;
- *
- * (2) Overloaded assignment operators:
- * +=, -=, *=, /=, %=, flipSign, &=, |=, ^=, <<=, >>=, ++, --.
- * Again, these are used on big integers just like on ints. They take
- * one writable big integer that both provides an operand and receives a
- * result. Most also take a second read-only operand.
- * Example:
- * BigInteger a(1), b(1);
- * a += b;
- *
- * (3) Copy-less operations: `add', `subtract', etc.
- * These named methods take operands as arguments and store the result
- * in the receiver (*this), avoiding unnecessary copies and allocations.
- * `divideWithRemainder' is special: it both takes the dividend from and
- * stores the remainder into the receiver, and it takes a separate
- * object in which to store the quotient. NOTE: If you are wondering
- * why these don't return a value, you probably mean to use the
- * overloaded return-by-value operators instead.
- *
- * Examples:
- * BigInteger a(43), b(7), c, d;
- *
- * c = a + b; // Now c == 50.
- * c.add(a, b); // Same effect but without the two copies.
- *
- * c.divideWithRemainder(b, d);
- * // 50 / 7; now d == 7 (quotient) and c == 1 (remainder).
- *
- * // ``Aliased'' calls now do the right thing using a temporary
- * // copy, but see note on `divideWithRemainder'.
- * a.add(a, b);
- */
-
- // COPY-LESS OPERATIONS
-
- // These 8: Arguments are read-only operands, result is saved in *this.
- void add(const BigUnsigned &a, const BigUnsigned &b);
- void subtract(const BigUnsigned &a, const BigUnsigned &b);
- void multiply(const BigUnsigned &a, const BigUnsigned &b);
- void bitAnd(const BigUnsigned &a, const BigUnsigned &b);
- void bitOr(const BigUnsigned &a, const BigUnsigned &b);
- void bitXor(const BigUnsigned &a, const BigUnsigned &b);
- /* Negative shift amounts translate to opposite-direction shifts,
- * except for -2^(8*sizeof(int)-1) which is unimplemented. */
- void bitShiftLeft(const BigUnsigned &a, int b);
- void bitShiftRight(const BigUnsigned &a, int b);
-
- /* `a.divideWithRemainder(b, q)' is like `q = a / b, a %= b'.
- * / and % use semantics similar to Knuth's, which differ from the
- * primitive integer semantics under division by zero. See the
- * implementation in BigUnsigned.cc for details.
- * `a.divideWithRemainder(b, a)' throws an exception: it doesn't make
- * sense to write quotient and remainder into the same variable. */
- void divideWithRemainder(const BigUnsigned &b, BigUnsigned &q);
-
- /* `divide' and `modulo' are no longer offered. Use
- * `divideWithRemainder' instead. */
-
- // OVERLOADED RETURN-BY-VALUE OPERATORS
- BigUnsigned operator +(const BigUnsigned &x) const;
- BigUnsigned operator -(const BigUnsigned &x) const;
- BigUnsigned operator *(const BigUnsigned &x) const;
- BigUnsigned operator /(const BigUnsigned &x) const;
- BigUnsigned operator %(const BigUnsigned &x) const;
- /* OK, maybe unary minus could succeed in one case, but it really
- * shouldn't be used, so it isn't provided. */
- BigUnsigned operator &(const BigUnsigned &x) const;
- BigUnsigned operator |(const BigUnsigned &x) const;
- BigUnsigned operator ^(const BigUnsigned &x) const;
- BigUnsigned operator <<(int b) const;
- BigUnsigned operator >>(int b) const;
-
- // OVERLOADED ASSIGNMENT OPERATORS
- void operator +=(const BigUnsigned &x);
- void operator -=(const BigUnsigned &x);
- void operator *=(const BigUnsigned &x);
- void operator /=(const BigUnsigned &x);
- void operator %=(const BigUnsigned &x);
- void operator &=(const BigUnsigned &x);
- void operator |=(const BigUnsigned &x);
- void operator ^=(const BigUnsigned &x);
- void operator <<=(int b);
- void operator >>=(int b);
-
- /* INCREMENT/DECREMENT OPERATORS
- * To discourage messy coding, these do not return *this, so prefix
- * and postfix behave the same. */
- void operator ++( );
- void operator ++(int);
- void operator --( );
- void operator --(int);
-
- // Helper function that needs access to BigUnsigned internals
- friend Blk getShiftedBlock(const BigUnsigned &num, Index x,
- unsigned int y);
-
- // See BigInteger.cc.
- template <class X>
- friend X convertBigUnsignedToPrimitiveAccess(const BigUnsigned &a);
-};
-
-/* Implementing the return-by-value and assignment operators in terms of the
- * copy-less operations. The copy-less operations are responsible for making
- * any necessary temporary copies to work around aliasing. */
-
-inline BigUnsigned BigUnsigned::operator +(const BigUnsigned &x) const {
- BigUnsigned ans;
- ans.add(*this, x);
- return ans;
-}
-inline BigUnsigned BigUnsigned::operator -(const BigUnsigned &x) const {
- BigUnsigned ans;
- ans.subtract(*this, x);
- return ans;
-}
-inline BigUnsigned BigUnsigned::operator *(const BigUnsigned &x) const {
- BigUnsigned ans;
- ans.multiply(*this, x);
- return ans;
-}
-inline BigUnsigned BigUnsigned::operator /(const BigUnsigned &x) const {
- if (x.isZero()) throw "BigUnsigned::operator /: division by zero";
- BigUnsigned q, r;
- r = *this;
- r.divideWithRemainder(x, q);
- return q;
-}
-inline BigUnsigned BigUnsigned::operator %(const BigUnsigned &x) const {
- if (x.isZero()) throw "BigUnsigned::operator %: division by zero";
- BigUnsigned q, r;
- r = *this;
- r.divideWithRemainder(x, q);
- return r;
-}
-inline BigUnsigned BigUnsigned::operator &(const BigUnsigned &x) const {
- BigUnsigned ans;
- ans.bitAnd(*this, x);
- return ans;
-}
-inline BigUnsigned BigUnsigned::operator |(const BigUnsigned &x) const {
- BigUnsigned ans;
- ans.bitOr(*this, x);
- return ans;
-}
-inline BigUnsigned BigUnsigned::operator ^(const BigUnsigned &x) const {
- BigUnsigned ans;
- ans.bitXor(*this, x);
- return ans;
-}
-inline BigUnsigned BigUnsigned::operator <<(int b) const {
- BigUnsigned ans;
- ans.bitShiftLeft(*this, b);
- return ans;
-}
-inline BigUnsigned BigUnsigned::operator >>(int b) const {
- BigUnsigned ans;
- ans.bitShiftRight(*this, b);
- return ans;
-}
-
-inline void BigUnsigned::operator +=(const BigUnsigned &x) {
- add(*this, x);
-}
-inline void BigUnsigned::operator -=(const BigUnsigned &x) {
- subtract(*this, x);
-}
-inline void BigUnsigned::operator *=(const BigUnsigned &x) {
- multiply(*this, x);
-}
-inline void BigUnsigned::operator /=(const BigUnsigned &x) {
- if (x.isZero()) throw "BigUnsigned::operator /=: division by zero";
- /* The following technique is slightly faster than copying *this first
- * when x is large. */
- BigUnsigned q;
- divideWithRemainder(x, q);
- // *this contains the remainder, but we overwrite it with the quotient.
- *this = q;
-}
-inline void BigUnsigned::operator %=(const BigUnsigned &x) {
- if (x.isZero()) throw "BigUnsigned::operator %=: division by zero";
- BigUnsigned q;
- // Mods *this by x. Don't care about quotient left in q.
- divideWithRemainder(x, q);
-}
-inline void BigUnsigned::operator &=(const BigUnsigned &x) {
- bitAnd(*this, x);
-}
-inline void BigUnsigned::operator |=(const BigUnsigned &x) {
- bitOr(*this, x);
-}
-inline void BigUnsigned::operator ^=(const BigUnsigned &x) {
- bitXor(*this, x);
-}
-inline void BigUnsigned::operator <<=(int b) {
- bitShiftLeft(*this, b);
-}
-inline void BigUnsigned::operator >>=(int b) {
- bitShiftRight(*this, b);
-}
-
-/* Templates for conversions of BigUnsigned to and from primitive integers.
- * BigInteger.cc needs to instantiate convertToPrimitive, and the uses in
- * BigUnsigned.cc didn't do the trick; I think g++ inlined convertToPrimitive
- * instead of generating linkable instantiations. So for consistency, I put
- * all the templates here. */
-
-// CONSTRUCTION FROM PRIMITIVE INTEGERS
-
-/* Initialize this BigUnsigned from the given primitive integer. The same
- * pattern works for all primitive integer types, so I put it into a template to
- * reduce code duplication. (Don't worry: this is protected and we instantiate
- * it only with primitive integer types.) Type X could be signed, but x is
- * known to be nonnegative. */
-template <class X>
-void BigUnsigned::initFromPrimitive(X x) {
- if (x == 0)
- ; // NumberlikeArray already initialized us to zero.
- else {
- // Create a single block. blk is NULL; no need to delete it.
- cap = 1;
- blk = new Blk[1];
- len = 1;
- blk[0] = Blk(x);
- }
-}
-
-/* Ditto, but first check that x is nonnegative. I could have put the check in
- * initFromPrimitive and let the compiler optimize it out for unsigned-type
- * instantiations, but I wanted to avoid the warning stupidly issued by g++ for
- * a condition that is constant in *any* instantiation, even if not in all. */
-template <class X>
-void BigUnsigned::initFromSignedPrimitive(X x) {
- if (x < 0)
- throw "BigUnsigned constructor: "
- "Cannot construct a BigUnsigned from a negative number";
- else
- initFromPrimitive(x);
-}
-
-// CONVERSION TO PRIMITIVE INTEGERS
-
-/* Template with the same idea as initFromPrimitive. This might be slightly
- * slower than the previous version with the masks, but it's much shorter and
- * clearer, which is the library's stated goal. */
-template <class X>
-X BigUnsigned::convertToPrimitive() const {
- if (len == 0)
- // The number is zero; return zero.
- return 0;
- else if (len == 1) {
- // The single block might fit in an X. Try the conversion.
- X x = X(blk[0]);
- // Make sure the result accurately represents the block.
- if (Blk(x) == blk[0])
- // Successful conversion.
- return x;
- // Otherwise fall through.
- }
- throw "BigUnsigned::to<Primitive>: "
- "Value is too big to fit in the requested type";
-}
-
-/* Wrap the above in an x >= 0 test to make sure we got a nonnegative result,
- * not a negative one that happened to convert back into the correct nonnegative
- * one. (E.g., catch incorrect conversion of 2^31 to the long -2^31.) Again,
- * separated to avoid a g++ warning. */
-template <class X>
-X BigUnsigned::convertToSignedPrimitive() const {
- X x = convertToPrimitive<X>();
- if (x >= 0)
- return x;
- else
- throw "BigUnsigned::to(Primitive): "
- "Value is too big to fit in the requested type";
-}
-
-#endif
+++ /dev/null
-#include "BigUnsignedInABase.hh"
-
-BigUnsignedInABase::BigUnsignedInABase(const Digit *d, Index l, Base base)
- : NumberlikeArray<Digit>(d, l), base(base) {
- // Check the base
- if (base < 2)
- throw "BigUnsignedInABase::BigUnsignedInABase(const Digit *, Index, Base): The base must be at least 2";
-
- // Validate the digits.
- for (Index i = 0; i < l; i++)
- if (blk[i] >= base)
- throw "BigUnsignedInABase::BigUnsignedInABase(const Digit *, Index, Base): A digit is too large for the specified base";
-
- // Eliminate any leading zeros we may have been passed.
- zapLeadingZeros();
-}
-
-namespace {
- unsigned int bitLen(unsigned int x) {
- unsigned int len = 0;
- while (x > 0) {
- x >>= 1;
- len++;
- }
- return len;
- }
- unsigned int ceilingDiv(unsigned int a, unsigned int b) {
- return (a + b - 1) / b;
- }
-}
-
-BigUnsignedInABase::BigUnsignedInABase(const BigUnsigned &x, Base base) {
- // Check the base
- if (base < 2)
- throw "BigUnsignedInABase(BigUnsigned, Base): The base must be at least 2";
- this->base = base;
-
- // Get an upper bound on how much space we need
- int maxBitLenOfX = x.getLength() * BigUnsigned::N;
- int minBitsPerDigit = bitLen(base) - 1;
- int maxDigitLenOfX = ceilingDiv(maxBitLenOfX, minBitsPerDigit);
- len = maxDigitLenOfX; // Another change to comply with `staying in bounds'.
- allocate(len); // Get the space
-
- BigUnsigned x2(x), buBase(base);
- Index digitNum = 0;
-
- while (!x2.isZero()) {
- // Get last digit. This is like `lastDigit = x2 % buBase, x2 /= buBase'.
- BigUnsigned lastDigit(x2);
- lastDigit.divideWithRemainder(buBase, x2);
- // Save the digit.
- blk[digitNum] = lastDigit.toUnsignedShort();
- // Move on. We can't run out of room: we figured it out above.
- digitNum++;
- }
-
- // Save the actual length.
- len = digitNum;
-}
-
-BigUnsignedInABase::operator BigUnsigned() const {
- BigUnsigned ans(0), buBase(base), temp;
- Index digitNum = len;
- while (digitNum > 0) {
- digitNum--;
- temp.multiply(ans, buBase);
- ans.add(temp, BigUnsigned(blk[digitNum]));
- }
- return ans;
-}
-
-BigUnsignedInABase::BigUnsignedInABase(const std::string &s, Base base) {
- // Check the base.
- if (base > 36)
- throw "BigUnsignedInABase(std::string, Base): The default string conversion routines use the symbol set 0-9, A-Z and therefore support only up to base 36. You tried a conversion with a base over 36; write your own string conversion routine.";
- // Save the base.
- // This pattern is seldom seen in C++, but the analogous ``this.'' is common in Java.
- this->base = base;
-
- // `s.length()' is a `size_t', while `len' is a `NumberlikeArray::Index',
- // also known as an `unsigned int'. Some compilers warn without this cast.
- len = Index(s.length());
- allocate(len);
-
- Index digitNum, symbolNumInString;
- for (digitNum = 0; digitNum < len; digitNum++) {
- symbolNumInString = len - 1 - digitNum;
- char theSymbol = s[symbolNumInString];
- if (theSymbol >= '0' && theSymbol <= '9')
- blk[digitNum] = theSymbol - '0';
- else if (theSymbol >= 'A' && theSymbol <= 'Z')
- blk[digitNum] = theSymbol - 'A' + 10;
- else if (theSymbol >= 'a' && theSymbol <= 'z')
- blk[digitNum] = theSymbol - 'a' + 10;
- else
- throw "BigUnsignedInABase(std::string, Base): Bad symbol in input. Only 0-9, A-Z, a-z are accepted.";
-
- if (blk[digitNum] >= base)
- throw "BigUnsignedInABase::BigUnsignedInABase(const Digit *, Index, Base): A digit is too large for the specified base";
- }
- zapLeadingZeros();
-}
-
-BigUnsignedInABase::operator std::string() const {
- if (base > 36)
- throw "BigUnsignedInABase ==> std::string: The default string conversion routines use the symbol set 0-9, A-Z and therefore support only up to base 36. You tried a conversion with a base over 36; write your own string conversion routine.";
- if (len == 0)
- return std::string("0");
- // Some compilers don't have push_back, so use a char * buffer instead.
- char *s = new char[len + 1];
- s[len] = '\0';
- Index digitNum, symbolNumInString;
- for (symbolNumInString = 0; symbolNumInString < len; symbolNumInString++) {
- digitNum = len - 1 - symbolNumInString;
- Digit theDigit = blk[digitNum];
- if (theDigit < 10)
- s[symbolNumInString] = char('0' + theDigit);
- else
- s[symbolNumInString] = char('A' + theDigit - 10);
- }
- std::string s2(s);
- delete [] s;
- return s2;
-}
+++ /dev/null
-#ifndef BIGUNSIGNEDINABASE_H
-#define BIGUNSIGNEDINABASE_H
-
-#include "NumberlikeArray.hh"
-#include "BigUnsigned.hh"
-#include <string>
-
-/*
- * A BigUnsignedInABase object represents a nonnegative integer of size limited
- * only by available memory, represented in a user-specified base that can fit
- * in an `unsigned short' (most can, and this saves memory).
- *
- * BigUnsignedInABase is intended as an intermediary class with little
- * functionality of its own. BigUnsignedInABase objects can be constructed
- * from, and converted to, BigUnsigneds (requiring multiplication, mods, etc.)
- * and `std::string's (by switching digit values for appropriate characters).
- *
- * BigUnsignedInABase is similar to BigUnsigned. Note the following:
- *
- * (1) They represent the number in exactly the same way, except that
- * BigUnsignedInABase uses ``digits'' (or Digit) where BigUnsigned uses
- * ``blocks'' (or Blk).
- *
- * (2) Both use the management features of NumberlikeArray. (In fact, my desire
- * to add a BigUnsignedInABase class without duplicating a lot of code led me to
- * introduce NumberlikeArray.)
- *
- * (3) The only arithmetic operation supported by BigUnsignedInABase is an
- * equality test. Use BigUnsigned for arithmetic.
- */
-
-class BigUnsignedInABase : protected NumberlikeArray<unsigned short> {
-
-public:
- // The digits of a BigUnsignedInABase are unsigned shorts.
- typedef unsigned short Digit;
- // That's also the type of a base.
- typedef Digit Base;
-
-protected:
- // The base in which this BigUnsignedInABase is expressed
- Base base;
-
- // Creates a BigUnsignedInABase with a capacity; for internal use.
- BigUnsignedInABase(int, Index c) : NumberlikeArray<Digit>(0, c) {}
-
- // Decreases len to eliminate any leading zero digits.
- void zapLeadingZeros() {
- while (len > 0 && blk[len - 1] == 0)
- len--;
- }
-
-public:
- // Constructs zero in base 2.
- BigUnsignedInABase() : NumberlikeArray<Digit>(), base(2) {}
-
- // Copy constructor
- BigUnsignedInABase(const BigUnsignedInABase &x) : NumberlikeArray<Digit>(x), base(x.base) {}
-
- // Assignment operator
- void operator =(const BigUnsignedInABase &x) {
- NumberlikeArray<Digit>::operator =(x);
- base = x.base;
- }
-
- // Constructor that copies from a given array of digits.
- BigUnsignedInABase(const Digit *d, Index l, Base base);
-
- // Destructor. NumberlikeArray does the delete for us.
- ~BigUnsignedInABase() {}
-
- // LINKS TO BIGUNSIGNED
- BigUnsignedInABase(const BigUnsigned &x, Base base);
- operator BigUnsigned() const;
-
- /* LINKS TO STRINGS
- *
- * These use the symbols ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'' to
- * represent digits of 0 through 35. When parsing strings, lowercase is
- * also accepted.
- *
- * All string representations are big-endian (big-place-value digits
- * first). (Computer scientists have adopted zero-based counting; why
- * can't they tolerate little-endian numbers?)
- *
- * No string representation has a ``base indicator'' like ``0x''.
- *
- * An exception is made for zero: it is converted to ``0'' and not the
- * empty string.
- *
- * If you want different conventions, write your own routines to go
- * between BigUnsignedInABase and strings. It's not hard.
- */
- operator std::string() const;
- BigUnsignedInABase(const std::string &s, Base base);
-
-public:
-
- // ACCESSORS
- Base getBase() const { return base; }
-
- // Expose these from NumberlikeArray directly.
- using NumberlikeArray<Digit>::getCapacity;
- using NumberlikeArray<Digit>::getLength;
-
- /* Returns the requested digit, or 0 if it is beyond the length (as if
- * the number had 0s infinitely to the left). */
- Digit getDigit(Index i) const { return i >= len ? 0 : blk[i]; }
-
- // The number is zero if and only if the canonical length is zero.
- bool isZero() const { return NumberlikeArray<Digit>::isEmpty(); }
-
- /* Equality test. For the purposes of this test, two BigUnsignedInABase
- * values must have the same base to be equal. */
- bool operator ==(const BigUnsignedInABase &x) const {
- return base == x.base && NumberlikeArray<Digit>::operator ==(x);
- }
- bool operator !=(const BigUnsignedInABase &x) const { return !operator ==(x); }
-
-};
-
-#endif
+++ /dev/null
- Change Log
-
-These entries tell you what was added, fixed, or improved in each version as
-compared to the previous one. In case you haven't noticed, a version number
-roughly corresponds to the release date of that version in `YYYY.MM.DD[.N]'
-format, where `.N' goes `.2', `.3', etc. if there are multiple versions on the
-same day. The topmost version listed is the one you have.
-
-2010.04.30
-----------
-- Strengthen the advice about build/IDE configuration in the README.
-
-2009.05.03
-----------
-- BigUnsigned::{get,set}Bit: Change two remaining `1 <<' to `Blk(1) <<' to work
- on systems where sizeof(unsigned int) != sizeof(Blk). Bug reported by Brad
- Spencer.
-- dataToBigInteger: Change a `delete' to `delete []' to avoid leaking memory.
- Bug reported by Nicolás Carrasco.
-
-2009.03.26
-----------
-- BigUnsignedInABase(std::string) Reject digits too big for the base.
- Bug reported by Niakam Kazemi.
-
-2008.07.20
-----------
-Dennis Yew pointed out serious problems with ambiguities and unwanted
-conversions when mixing BigInteger/BigUnsigned and primitive integers. To fix
-these, I removed the implicit conversions from BigInteger/BigUnsigned to
-primitive integers and from BigInteger to BigUnsigned. Removing the
-BigInteger-to-BigUnsigned conversion required changing BigInteger to have a
-BigUnsigned field instead of inheriting from it; this was a complex task but
-ultimately gave a saner design. At the same time, I went through the entire
-codebase, making the formatting and comments prettier and reworking anything I
-thought was unclear. I also added a testsuite (currently for 32-bit systems
-only); it doesn't yet cover the entire library but should help to ensure that
-things work the way they should.
-
-A number of changes from version 2007.07.07 break compatibility with existing
-code that uses the library, but updating that code should be pretty easy:
-- BigInteger can no longer be implicitly converted to BigUnsigned. Use
- getMagnitude() instead.
-- BigUnsigned and BigInteger can no longer be implicitly converted to primitive
- integers. Use the toInt() family of functions instead.
-- The easy* functions have been renamed to more mature names:
- bigUnsignedToString, bigIntegerToString, stringToBigUnsigned,
- stringToBigInteger, dataToBigInteger.
-- BigInteger no longer supports bitwise operations. Get the magnitude with
- getMagnitude() and operate on that instead.
-- The old {BigUnsigned,BigInteger}::{divide,modulo} copy-less options have been
- removed. Use divideWithRemainder instead.
-- Added a base argument to BigUnsignedInABase's digit-array constructor. I
- ope no one used that constructor in its broken state anyway.
-
-Other notable changes:
-- Added BigUnsigned functions setBlock, bitLength, getBit, setBit.
-- The bit-shifting operations now support negative shift amounts, which shift in
- the other direction.
-- Added some big-integer algorithms in BigIntegerAlgorithms.hh: gcd,
- extendedEuclidean, modinv, modexp.
-
-2007.07.07
-----------
-Update the "Running the sample program produces this output:" comment in
-sample.cc for the bitwise operators.
-
-2007.06.14
-----------
-- Implement << and >> for BigUnsigned in response to email from Marco Schulze.
-- Fix name: DOTR_ALIASED -> DTRT_ALIASED.
-- Demonstrate all bitwise operators (&, |, ^, <<, >>) in sample.cc.
-
-2007.02.16
-----------
-Boris Dessy pointed out that the library threw an exception on "a *= a", so I changed all the put-here operations to handle aliased calls correctly using a temporary copy instead of throwing exceptions.
-
-2006.08.14
-----------
-In BigUnsigned::bitXor, change allocate(b2->len) to allocate(a2->len): we should allocate enough space for the longer number, not the shorter one! Thanks to Sriram Sankararaman for pointing this out.
-
-2006.05.03
-----------
-I ran the sample program using valgrind and discovered a `delete s' that should be `delete [] s' and a `len++' before an `allocateAndCopy(len)' that should have been after an `allocateAndCopy(len + 1)'. I fixed both. Yay for valgrind!
-
-2006.05.01
-----------
-I fixed incorrect results reported by Mohand Mezmaz and related memory corruption on platforms where Blk is bigger than int. I replaced (1 << x) with (Blk(1) << x) in two places in BigUnsigned.cc.
-
-2006.04.24
-----------
-Two bug fixes: BigUnsigned "++x" no longer segfaults when x grows in length, and BigUnsigned == and != are now redeclared so as to be usable. I redid the Makefile: I removed the *.tag mechanism and hard-coded the library's header dependencies, I added comments, and I made the Makefile more useful for building one's own programs instead of just the sample.
-
-2006.02.26
-----------
-A few tweaks in preparation for a group to distribute the library. The project Web site has moved; I updated the references. I fixed a typo and added a missing function in NumberlikeArray.hh. I'm using Eclipse now, so you get Eclipse project files.
-
-2005.03.30
-----------
-Sam Larkin found a bug in `BigInteger::subtract'; I fixed it.
-
-2005.01.18
-----------
-I fixed some problems with `easyDataToBI'. Due to some multiply declared variables, this function would not compile. However, it is a template function, so the compiler parses it and doesn't compile the parsed representation until something uses the function; this is how I missed the problems. I also removed debugging output from this function.
-
-2005.01.17
-----------
-A fix to some out-of-bounds accesses reported by Milan Tomic (see the comment under `BigUnsigned::divideWithRemainder'). `BigUnsigned::multiply' and `BigUnsigned::divideWithRemainder' implementations neatened up a bit with the help of a function `getShiftedBlock'. I (finally!) introduced a constant `BigUnsigned::N', the number of bits in a `BigUnsigned::Blk', which varies depending on machine word size. In both code and comments, it replaces the much clunkier `8*sizeof(Blk)'. Numerous other small changes. There's a new conversion routine `easyDataToBI' that will convert almost any format of binary data to a `BigInteger'.
-
-I have inserted a significant number of new comments. Most explain unobvious aspects of the code.
-
-2005.01.06
-----------
-Some changes to the way zero-length arrays are handled by `NumberlikeArray', which fixed a memory leak reported by Milan Tomic.
-
-2004.12.24.2
-------------
-I tied down a couple of loose ends involving division/modulo. I added an explanation of put-here vs. overloaded operators in the sample program; this has confused too many people. Miscellaneous other improvements.
-
-I believe that, at this point, the Big Integer Library makes no assumptions about the word size of the machine it is using. `BigUnsigned::Blk' is always an `unsigned long', whatever that may be, and its size is computed with `sizeof' when necessary. However, just in case, I would be interested to have someone test the library on a non-32-bit machine to see if it works.
-
-2004.12.24
-----------
-This is a _major_ upgrade to the library. Among the things that have changed:
-
-I wrote the original version of the library, particularly the four ``classical algorithms'' in `BigUnsigned.cc', using array indexing. Then I rewrote it to use pointers because I thought that would be faster. But recently, I revisited the code in `BigUnsigned.cc' and found that I could not begin to understand what it was doing.
-
-I have decided that the drawbacks of pointers, increased coding difficulty and reduced code readability, far outweigh their speed benefits. Plus, any modern optimizing compiler should produce fast code either way. Therefore, I rewrote the library to use array indexing again. (Thank goodness for regular-expression find-and-replace. It saved me a lot of time.)
-
-The put-here operations `divide' and `modulo' of each of `BigUnsigned' and `BigInteger' have been supplanted by a single operation `divideWithRemainder'. Read the profuse comments for more information on its exact behavior.
-
-There is a new class `BigUnsignedInABase' that is like `BigUnsigned' but uses a user-specified, small base instead of `256 ^ sizeof(unsigned long)'. Much of the code common to the two has been factored out into `NumberlikeArray'.
-
-`BigUnsignedInABase' facilitates conversion between `BigUnsigned's and digit-by-digit string representations using `std::string'. Convenience routines to do this conversion are in `BigIntegerUtils.hh'. `iostream' compatibility has been improved.
-
-I would like to thank Chris Morbitzer for the e-mail message that catalyzed this major upgrade. He wanted a way to convert a string to a BigInteger. One thing just led to another, roughly in reverse order from how they are listed here.
-
-2004.1216
----------
-Brad Spencer pointed out a memory leak in `BigUnsigned::divide'. It is fixed in the December 16, 2004 version.
-
-2004.1205
----------
-After months of inactivity, I fixed a bug in the `BigInteger' division routine; thanks to David Allen for reporting the bug. I also added simple routines for decimal output to `std::ostream's, and there is a demo that prints out powers of 3.
-
-~~~~
+++ /dev/null
-# Mention default target.
-all:
-
-# Implicit rule to compile C++ files. Modify to your taste.
-%.o: %.cc
- g++ -c -O2 -Wall -Wextra -pedantic $<
-
-# Components of the library.
-library-objects = \
- BigUnsigned.o \
- BigInteger.o \
- BigIntegerAlgorithms.o \
- BigUnsignedInABase.o \
- BigIntegerUtils.o \
-
-library-headers = \
- NumberlikeArray.hh \
- BigUnsigned.hh \
- BigInteger.hh \
- BigIntegerAlgorithms.hh \
- BigUnsignedInABase.hh \
- BigIntegerLibrary.hh \
-
-# To ``make the library'', make all its objects using the implicit rule.
-library: $(library-objects)
-
-# Conservatively assume that all the objects depend on all the headers.
-$(library-objects): $(library-headers)
-
-# TESTSUITE (NOTE: Currently expects a 32-bit system)
-# Compiling the testsuite.
-testsuite.o: $(library-headers)
-testsuite: testsuite.o $(library-objects)
- g++ $^ -o $@
-# Extract the expected output from the testsuite source.
-testsuite.expected: testsuite.cc
- nl -ba -p -s: $< | sed -nre 's,^ +([0-9]+):.*//([^ ]),Line \1: \2,p' >$@
-# Run the testsuite.
-.PHONY: test
-test: testsuite testsuite.expected
- ./run-testsuite
-testsuite-cleanfiles = \
- testsuite.o testsuite testsuite.expected \
- testsuite.out testsuite.err
-
-# The rules below build a program that uses the library. They are preset to
-# build ``sample'' from ``sample.cc''. You can change the name(s) of the
-# source file(s) and program file to build your own program, or you can write
-# your own Makefile.
-
-# Components of the program.
-program = sample
-program-objects = sample.o
-
-# Conservatively assume all the program source files depend on all the library
-# headers. You can change this if it is not the case.
-$(program-objects) : $(library-headers)
-
-# How to link the program. The implicit rule covers individual objects.
-$(program) : $(program-objects) $(library-objects)
- g++ $^ -o $@
-
-# Delete all generated files we know about.
-clean :
- rm -f $(library-objects) $(testsuite-cleanfiles) $(program-objects) $(program)
-
-# I removed the *.tag dependency tracking system because it had few advantages
-# over manually entering all the dependencies. If there were a portable,
-# reliable dependency tracking system, I'd use it, but I know of no such;
-# cons and depcomp are almost good enough.
-
-# Come back and define default target.
-all : library $(program)
+++ /dev/null
-#ifndef NUMBERLIKEARRAY_H
-#define NUMBERLIKEARRAY_H
-
-// Make sure we have NULL.
-#ifndef NULL
-#define NULL 0
-#endif
-
-/* A NumberlikeArray<Blk> object holds a heap-allocated array of Blk with a
- * length and a capacity and provides basic memory management features.
- * BigUnsigned and BigUnsignedInABase both subclass it.
- *
- * NumberlikeArray provides no information hiding. Subclasses should use
- * nonpublic inheritance and manually expose members as desired using
- * declarations like this:
- *
- * public:
- * NumberlikeArray< the-type-argument >::getLength;
- */
-template <class Blk>
-class NumberlikeArray {
-public:
-
- // Type for the index of a block in the array
- typedef unsigned int Index;
- // The number of bits in a block, defined below.
- static const unsigned int N;
-
- // The current allocated capacity of this NumberlikeArray (in blocks)
- Index cap;
- // The actual length of the value stored in this NumberlikeArray (in blocks)
- Index len;
- // Heap-allocated array of the blocks (can be NULL if len == 0)
- Blk *blk;
-
- // Constructs a ``zero'' NumberlikeArray with the given capacity.
- NumberlikeArray(Index c) : cap(c), len(0) {
- blk = (cap > 0) ? (new Blk[cap]) : NULL;
- }
-
- /* Constructs a zero NumberlikeArray without allocating a backing array.
- * A subclass that doesn't know the needed capacity at initialization
- * time can use this constructor and then overwrite blk without first
- * deleting it. */
- NumberlikeArray() : cap(0), len(0) {
- blk = NULL;
- }
-
- // Destructor. Note that `delete NULL' is a no-op.
- ~NumberlikeArray() {
- delete [] blk;
- }
-
- /* Ensures that the array has at least the requested capacity; may
- * destroy the contents. */
- void allocate(Index c);
-
- /* Ensures that the array has at least the requested capacity; does not
- * destroy the contents. */
- void allocateAndCopy(Index c);
-
- // Copy constructor
- NumberlikeArray(const NumberlikeArray<Blk> &x);
-
- // Assignment operator
- void operator=(const NumberlikeArray<Blk> &x);
-
- // Constructor that copies from a given array of blocks
- NumberlikeArray(const Blk *b, Index blen);
-
- // ACCESSORS
- Index getCapacity() const { return cap; }
- Index getLength() const { return len; }
- Blk getBlock(Index i) const { return blk[i]; }
- bool isEmpty() const { return len == 0; }
-
- /* Equality comparison: checks if both objects have the same length and
- * equal (==) array elements to that length. Subclasses may wish to
- * override. */
- bool operator ==(const NumberlikeArray<Blk> &x) const;
-
- bool operator !=(const NumberlikeArray<Blk> &x) const {
- return !operator ==(x);
- }
-};
-
-/* BEGIN TEMPLATE DEFINITIONS. They are present here so that source files that
- * include this header file can generate the necessary real definitions. */
-
-template <class Blk>
-const unsigned int NumberlikeArray<Blk>::N = 8 * sizeof(Blk);
-
-template <class Blk>
-void NumberlikeArray<Blk>::allocate(Index c) {
- // If the requested capacity is more than the current capacity...
- if (c > cap) {
- // Delete the old number array
- delete [] blk;
- // Allocate the new array
- cap = c;
- blk = new Blk[cap];
- }
-}
-
-template <class Blk>
-void NumberlikeArray<Blk>::allocateAndCopy(Index c) {
- // If the requested capacity is more than the current capacity...
- if (c > cap) {
- Blk *oldBlk = blk;
- // Allocate the new number array
- cap = c;
- blk = new Blk[cap];
- // Copy number blocks
- Index i;
- for (i = 0; i < len; i++)
- blk[i] = oldBlk[i];
- // Delete the old array
- delete [] oldBlk;
- }
-}
-
-template <class Blk>
-NumberlikeArray<Blk>::NumberlikeArray(const NumberlikeArray<Blk> &x)
- : len(x.len) {
- // Create array
- cap = len;
- blk = new Blk[cap];
- // Copy blocks
- Index i;
- for (i = 0; i < len; i++)
- blk[i] = x.blk[i];
-}
-
-template <class Blk>
-void NumberlikeArray<Blk>::operator=(const NumberlikeArray<Blk> &x) {
- /* Calls like a = a have no effect; catch them before the aliasing
- * causes a problem */
- if (this == &x)
- return;
- // Copy length
- len = x.len;
- // Expand array if necessary
- allocate(len);
- // Copy number blocks
- Index i;
- for (i = 0; i < len; i++)
- blk[i] = x.blk[i];
-}
-
-template <class Blk>
-NumberlikeArray<Blk>::NumberlikeArray(const Blk *b, Index blen)
- : cap(blen), len(blen) {
- // Create array
- blk = new Blk[cap];
- // Copy blocks
- Index i;
- for (i = 0; i < len; i++)
- blk[i] = b[i];
-}
-
-template <class Blk>
-bool NumberlikeArray<Blk>::operator ==(const NumberlikeArray<Blk> &x) const {
- if (len != x.len)
- // Definitely unequal.
- return false;
- else {
- // Compare corresponding blocks one by one.
- Index i;
- for (i = 0; i < len; i++)
- if (blk[i] != x.blk[i])
- return false;
- // No blocks differed, so the objects are equal.
- return true;
- }
-}
-
-#endif
+++ /dev/null
-
-Note by Clifford Wolf:
-This version of bigint was downloaded at 2012-08-29 from
-https://mattmccutchen.net/bigint/bigint-2010.04.30.tar.bz2
-
-Some minor changes were made to the source code (e.g. "using"
-was added to access declarations to prohibit compiler warnings).
-
-
-==============================================================================
-
- C++ Big Integer Library
- (see ChangeLog for version)
-
- http://mattmccutchen.net/bigint/
-
- Written and maintained by Matt McCutchen <matt@mattmccutchen.net>
-
-You can use this library in a C++ program to do arithmetic on integers of size
-limited only by your computer's memory. The library provides BigUnsigned and
-BigInteger classes that represent nonnegative integers and signed integers,
-respectively. Most of the C++ arithmetic operators are overloaded for these
-classes, so big-integer calculations are as easy as:
-
- #include "BigIntegerLibrary.hh"
-
- BigInteger a = 65536;
- cout << (a * a * a * a * a * a * a * a);
-
- (prints 340282366920938463463374607431768211456)
-
-The code in `sample.cc' demonstrates the most important features of the library.
-To get started quickly, read the code and explanations in that file and run it.
-If you want more detail or a feature not shown in `sample.cc', consult the
-consult the actual header and source files, which are thoroughly commented.
-
-This library emphasizes ease of use and clarity of implementation over speed;
-some users will prefer GMP (http://swox.com/gmp/), which is faster. The code is
-intended to be reasonably portable across computers and modern C++ compilers; in
-particular, it uses whatever word size the computer provides (32-bit, 64-bit, or
-otherwise).
-
-Compiling programs that use the library
----------------------------------------
-The library consists of a folder full of C++ header files (`.hh') and source
-files (`.cc'). Your own programs should `#include' the necessary header files
-and link with the source files. A makefile that builds the sample program
-(`sample.cc') is included; you can adapt it to replace the sample with your own
-program.
-
-Alternatively, you can use your own build system or IDE. In that case, you must
-put the library header files where the compiler will find them and arrange to
-have your program linked with the library source files; otherwise, you will get
-errors about missing header files or "undefined references". To learn how to do
-this, consult the documentation for the build system or IDE; don't bother asking
-me. Adding all the library files to your project will work in many IDEs but may
-not be the most desirable approach.
-
-Resources
----------
-The library's Web site (above) provides links to released versions, the current
-development version, and a mailing list for release announcements, questions,
-bug reports, and other discussion of the library. I would be delighted to hear
-from you if you like this library and/or find a good use for it.
-
-Bugs and enhancements
----------------------
-The library has been tested by me and others but is by no means bug-free. If
-you find a bug, please report it, whether it comes in the form of compiling
-trouble, a mathematically inaccurate result, or a memory-management blooper
-(since I use Java, these are altogether too common in my C++). I generally fix
-all reported bugs. You are also welcome to request enhancements, but I am
-unlikely to do substantial amounts of work on enhancements at this point.
-
-Legal
------
-I, Matt McCutchen, the sole author of the original Big Integer Library, waive my
-copyright to it, placing it in the public domain. The library comes with
-absolutely no warranty.
-
-~~~~
+++ /dev/null
-#!/bin/bash
-
-bad=
-
-# If you encounter the following problem with Valgrind like I did:
-# https://bugzilla.redhat.com/show_bug.cgi?id=455644
-# you can pass the environment variable NO_VALGRIND=1 to run the testsuite
-# without it.
-if [ "$NO_VALGRIND" ]; then
- cmd=(./testsuite)
-else
- cmd=(valgrind --error-exitcode=1 --leak-check=full ./testsuite)
-fi
-
-set -o pipefail
-# Stdout goes directly to testsuite.out; stderr goes down the pipe.
-if ! "${cmd[@]}" 2>&1 >testsuite.out | tee testsuite.err; then
- echo >&2 'Memory errors!'
- bad=1
-fi
-
-if grep 'LEAK SUMMARY' testsuite.err >/dev/null; then
- echo >&2 'Memory leaks!'
- bad=1
-fi
-
-if ! diff -u testsuite.expected testsuite.out; then
- echo >&2 'Output is incorrect!'
- bad=1
-fi
-
-if [ $bad ]; then
- echo >&2 'Test suite failed!'
- exit 1
-else
- echo 'Test suite passed.'
-fi
+++ /dev/null
-// Sample program demonstrating the use of the Big Integer Library.
-
-// Standard libraries
-#include <string>
-#include <iostream>
-
-// `BigIntegerLibrary.hh' includes all of the library headers.
-#include "BigIntegerLibrary.hh"
-
-int main() {
- /* The library throws `const char *' error messages when things go
- * wrong. It's a good idea to catch them using a `try' block like this
- * one. Your C++ compiler might need a command-line option to compile
- * code that uses exceptions. */
- try {
- BigInteger a; // a is 0
- int b = 535;
-
- /* Any primitive integer can be converted implicitly to a
- * BigInteger. */
- a = b;
-
- /* The reverse conversion requires a method call (implicit
- * conversions were previously supported but caused trouble).
- * If a were too big for an int, the library would throw an
- * exception. */
- b = a.toInt();
-
- BigInteger c(a); // Copy a BigInteger.
-
- // The int literal is converted to a BigInteger.
- BigInteger d(-314159265);
-
- /* This won't compile (at least on 32-bit machines) because the
- * number is too big to be a primitive integer literal, and
- * there's no such thing as a BigInteger literal. */
- //BigInteger e(3141592653589793238462643383279);
-
- // Instead you can convert the number from a string.
- std::string s("3141592653589793238462643383279");
- BigInteger f = stringToBigInteger(s);
-
- // You can convert the other way too.
- std::string s2 = bigIntegerToString(f);
-
- // f is implicitly stringified and sent to std::cout.
- std::cout << f << std::endl;
-
- /* Let's do some math! The library overloads most of the
- * mathematical operators (including assignment operators) to
- * work on BigIntegers. There are also ``copy-less''
- * operations; see `BigUnsigned.hh' for details. */
-
- // Arithmetic operators
- BigInteger g(314159), h(265);
- std::cout << (g + h) << '\n'
- << (g - h) << '\n'
- << (g * h) << '\n'
- << (g / h) << '\n'
- << (g % h) << std::endl;
-
- // Bitwise operators
- BigUnsigned i(0xFF0000FF), j(0x0000FFFF);
- // The library's << operator recognizes base flags.
- std::cout.flags(std::ios::hex | std::ios::showbase);
- std::cout << (i & j) << '\n'
- << (i | j) << '\n'
- << (i ^ j) << '\n'
- // Shift distances are ordinary unsigned ints.
- << (j << 21) << '\n'
- << (j >> 10) << '\n';
- std::cout.flags(std::ios::dec);
-
- // Let's do some heavy lifting and calculate powers of 314.
- int maxPower = 10;
- BigUnsigned x(1), big314(314);
- for (int power = 0; power <= maxPower; power++) {
- std::cout << "314^" << power << " = " << x << std::endl;
- x *= big314; // A BigInteger assignment operator
- }
-
- // Some big-integer algorithms (albeit on small integers).
- std::cout << gcd(BigUnsigned(60), 72) << '\n'
- << modinv(BigUnsigned(7), 11) << '\n'
- << modexp(BigUnsigned(314), 159, 2653) << std::endl;
-
- // Add your own code here to experiment with the library.
- } catch(char const* err) {
- std::cout << "The library threw an exception:\n"
- << err << std::endl;
- }
-
- return 0;
-}
-
-/*
-The original sample program produces this output:
-
-3141592653589793238462643383279
-314424
-313894
-83252135
-1185
-134
-0xFF
-0xFF00FFFF
-0xFF00FF00
-0x1FFFE00000
-0x3F
-314^0 = 1
-314^1 = 314
-314^2 = 98596
-314^3 = 30959144
-314^4 = 9721171216
-314^5 = 3052447761824
-314^6 = 958468597212736
-314^7 = 300959139524799104
-314^8 = 94501169810786918656
-314^9 = 29673367320587092457984
-314^10 = 9317437338664347031806976
-12
-8
-1931
-
-*/
+++ /dev/null
-/* Test suite for the library. First, it ``tests'' that all the constructs it
- * uses compile successfully. Then, its output to stdout is compared to the
- * expected output automatically extracted from slash-slash comments below.
- *
- * NOTE: For now, the test suite expects a 32-bit system. On others, some tests
- * may fail, and it may be ineffective at catching bugs. TODO: Remedy this. */
-
-#include "BigIntegerLibrary.hh"
-
-#include <string>
-#include <iostream>
-using namespace std;
-
-// Evaluate expr and print the result or "error" as appropriate.
-#define TEST(expr) do {\
- cout << "Line " << __LINE__ << ": ";\
- try {\
- cout << (expr);\
- } catch (const char *err) {\
- cout << "error";\
- }\
- cout << endl;\
-} while (0)
-
-const BigUnsigned &check(const BigUnsigned &x) {
- unsigned int l = x.getLength();
- if (l != 0 && x.getBlock(l-1) == 0)
- cout << "check: Unzapped number!" << endl;
- if (l > x.getCapacity())
- cout << "check: Capacity inconsistent with length!" << endl;
- return x;
-}
-
-const BigInteger &check(const BigInteger &x) {
- if (x.getSign() == 0 && !x.getMagnitude().isZero())
- cout << "check: Sign should not be zero!" << endl;
- if (x.getSign() != 0 && x.getMagnitude().isZero())
- cout << "check: Sign should be zero!" << endl;
- check(x.getMagnitude());
- return x;
-}
-
-short pathologicalShort = ~((unsigned short)(~0) >> 1);
-int pathologicalInt = ~((unsigned int)(~0) >> 1);
-long pathologicalLong = ~((unsigned long)(~0) >> 1);
-
-int main() {
-
-try {
-
-BigUnsigned z(0), one(1), ten(10);
-TEST(z); //0
-TEST(1); //1
-TEST(10); //10
-
-// TODO: Comprehensively test the general and special cases of each function.
-
-// === Default constructors ===
-
-TEST(check(BigUnsigned())); //0
-TEST(check(BigInteger())); //0
-
-// === Block-array constructors ===
-
-BigUnsigned::Blk myBlocks[3];
-myBlocks[0] = 3;
-myBlocks[1] = 4;
-myBlocks[2] = 0;
-BigUnsigned bu(myBlocks, 3);
-TEST(check(bu)); //17179869187
-TEST(check(BigInteger(myBlocks, 3))); //17179869187
-TEST(check(BigInteger(bu ))); //17179869187
-
-// For nonzero magnitude, reject zero and invalid signs.
-TEST(check(BigInteger(myBlocks, 3, BigInteger::positive))); //17179869187
-TEST(check(BigInteger(myBlocks, 3, BigInteger::negative))); //-17179869187
-TEST(check(BigInteger(myBlocks, 3, BigInteger::zero ))); //error
-TEST(check(BigInteger(bu, BigInteger::positive))); //17179869187
-TEST(check(BigInteger(bu, BigInteger::negative))); //-17179869187
-TEST(check(BigInteger(bu, BigInteger::zero ))); //error
-
-// For zero magnitude, force the sign to zero without error.
-BigUnsigned::Blk myZeroBlocks[1];
-myZeroBlocks[0] = 0;
-TEST(check(BigInteger(myZeroBlocks, 1, BigInteger::positive))); //0
-TEST(check(BigInteger(myZeroBlocks, 1, BigInteger::negative))); //0
-TEST(check(BigInteger(myZeroBlocks, 1, BigInteger::zero ))); //0
-
-// === BigUnsigned conversion limits ===
-
-TEST(BigUnsigned(0).toUnsignedLong()); //0
-TEST(BigUnsigned(4294967295U).toUnsignedLong()); //4294967295
-TEST(stringToBigUnsigned("4294967296").toUnsignedLong()); //error
-
-TEST(BigUnsigned(0).toLong()); //0
-TEST(BigUnsigned(2147483647).toLong()); //2147483647
-TEST(BigUnsigned(2147483648U).toLong()); //error
-
-// int is the same as long on a 32-bit system
-TEST(BigUnsigned(0).toUnsignedInt()); //0
-TEST(BigUnsigned(4294967295U).toUnsignedInt()); //4294967295
-TEST(stringToBigUnsigned("4294967296").toUnsignedInt()); //error
-
-TEST(BigUnsigned(0).toInt()); //0
-TEST(BigUnsigned(2147483647).toInt()); //2147483647
-TEST(BigUnsigned(2147483648U).toInt()); //error
-
-TEST(BigUnsigned(0).toUnsignedShort()); //0
-TEST(BigUnsigned(65535).toUnsignedShort()); //65535
-TEST(BigUnsigned(65536).toUnsignedShort()); //error
-
-TEST(BigUnsigned(0).toShort()); //0
-TEST(BigUnsigned(32767).toShort()); //32767
-TEST(BigUnsigned(32768).toShort()); //error
-
-// === BigInteger conversion limits ===
-
-TEST(BigInteger(-1).toUnsignedLong()); //error
-TEST(BigInteger(0).toUnsignedLong()); //0
-TEST(BigInteger(4294967295U).toUnsignedLong()); //4294967295
-TEST(stringToBigInteger("4294967296").toUnsignedLong()); //error
-
-TEST(stringToBigInteger("-2147483649").toLong()); //error
-TEST(stringToBigInteger("-2147483648").toLong()); //-2147483648
-TEST(BigInteger(-2147483647).toLong()); //-2147483647
-TEST(BigInteger(0).toLong()); //0
-TEST(BigInteger(2147483647).toLong()); //2147483647
-TEST(BigInteger(2147483648U).toLong()); //error
-
-// int is the same as long on a 32-bit system
-TEST(BigInteger(-1).toUnsignedInt()); //error
-TEST(BigInteger(0).toUnsignedInt()); //0
-TEST(BigInteger(4294967295U).toUnsignedInt()); //4294967295
-TEST(stringToBigInteger("4294967296").toUnsignedInt()); //error
-
-TEST(stringToBigInteger("-2147483649").toInt()); //error
-TEST(stringToBigInteger("-2147483648").toInt()); //-2147483648
-TEST(BigInteger(-2147483647).toInt()); //-2147483647
-TEST(BigInteger(0).toInt()); //0
-TEST(BigInteger(2147483647).toInt()); //2147483647
-TEST(BigInteger(2147483648U).toInt()); //error
-
-TEST(BigInteger(-1).toUnsignedShort()); //error
-TEST(BigInteger(0).toUnsignedShort()); //0
-TEST(BigInteger(65535).toUnsignedShort()); //65535
-TEST(BigInteger(65536).toUnsignedShort()); //error
-
-TEST(BigInteger(-32769).toShort()); //error
-TEST(BigInteger(-32768).toShort()); //-32768
-TEST(BigInteger(-32767).toShort()); //-32767
-TEST(BigInteger(0).toShort()); //0
-TEST(BigInteger(32767).toShort()); //32767
-TEST(BigInteger(32768).toShort()); //error
-
-// === Negative BigUnsigneds ===
-
-// ...during construction
-TEST(BigUnsigned(short(-1))); //error
-TEST(BigUnsigned(pathologicalShort)); //error
-TEST(BigUnsigned(-1)); //error
-TEST(BigUnsigned(pathologicalInt)); //error
-TEST(BigUnsigned(long(-1))); //error
-TEST(BigUnsigned(pathologicalLong)); //error
-
-// ...during subtraction
-TEST(BigUnsigned(5) - BigUnsigned(6)); //error
-TEST(stringToBigUnsigned("314159265358979323") - stringToBigUnsigned("314159265358979324")); //error
-TEST(check(BigUnsigned(5) - BigUnsigned(5))); //0
-TEST(check(stringToBigUnsigned("314159265358979323") - stringToBigUnsigned("314159265358979323"))); //0
-TEST(check(stringToBigUnsigned("4294967296") - BigUnsigned(1))); //4294967295
-
-// === BigUnsigned addition ===
-
-TEST(check(BigUnsigned(0) + 0)); //0
-TEST(check(BigUnsigned(0) + 1)); //1
-// Ordinary carry
-TEST(check(stringToBigUnsigned("8589934591" /* 2^33 - 1*/)
- + stringToBigUnsigned("4294967298" /* 2^32 + 2 */))); //12884901889
-// Creation of a new block
-TEST(check(BigUnsigned(0xFFFFFFFFU) + 1)); //4294967296
-
-// === BigUnsigned subtraction ===
-
-TEST(check(BigUnsigned(1) - 0)); //1
-TEST(check(BigUnsigned(1) - 1)); //0
-TEST(check(BigUnsigned(2) - 1)); //1
-// Ordinary borrow
-TEST(check(stringToBigUnsigned("12884901889")
- - stringToBigUnsigned("4294967298"))); //8589934591
-// Borrow that removes a block
-TEST(check(stringToBigUnsigned("4294967296") - 1)); //4294967295
-
-// === BigUnsigned multiplication and division ===
-
-BigUnsigned a = check(BigUnsigned(314159265) * 358979323);
-TEST(a); //112776680263877595
-TEST(a / 123); //916883579381118
-TEST(a % 123); //81
-
-TEST(BigUnsigned(5) / 0); //error
-
-// === Block accessors ===
-
-BigUnsigned b;
-TEST(b); //0
-TEST(b.getBlock(0)); //0
-b.setBlock(1, 314);
-// Did b grow properly? And did we zero intermediate blocks?
-TEST(check(b)); //1348619730944
-TEST(b.getLength()); //2
-TEST(b.getBlock(0)); //0
-TEST(b.getBlock(1)); //314
-// Did b shrink properly?
-b.setBlock(1, 0);
-TEST(check(b)); //0
-
-BigUnsigned bb(314);
-bb.setBlock(1, 159);
-// Make sure we used allocateAndCopy, not allocate
-TEST(bb.getBlock(0)); //314
-TEST(bb.getBlock(1)); //159
-// Blocks beyond the number should be zero regardless of whether they are
-// within the capacity.
-bb.add(1, 2);
-TEST(bb.getBlock(0)); //3
-TEST(bb.getBlock(1)); //0
-TEST(bb.getBlock(2)); //0
-TEST(bb.getBlock(314159)); //0
-
-// === Bit accessors ===
-
-TEST(BigUnsigned(0).bitLength()); //0
-TEST(BigUnsigned(1).bitLength()); //1
-TEST(BigUnsigned(4095).bitLength()); //12
-TEST(BigUnsigned(4096).bitLength()); //13
-// 5 billion is between 2^32 (about 4 billion) and 2^33 (about 8 billion).
-TEST(stringToBigUnsigned("5000000000").bitLength()); //33
-
-// 25 is binary 11001.
-BigUnsigned bbb(25);
-TEST(bbb.getBit(4)); //1
-TEST(bbb.getBit(3)); //1
-TEST(bbb.getBit(2)); //0
-TEST(bbb.getBit(1)); //0
-TEST(bbb.getBit(0)); //1
-TEST(bbb.bitLength()); //5
-// Effectively add 2^32.
-bbb.setBit(32, true);
-TEST(bbb); //4294967321
-bbb.setBit(31, true);
-bbb.setBit(32, false);
-TEST(check(bbb)); //2147483673
-
-// === Combining BigUnsigned, BigInteger, and primitive integers ===
-
-BigUnsigned p1 = BigUnsigned(3) * 5;
-TEST(p1); //15
-/* In this case, we would like g++ to implicitly promote the BigUnsigned to a
- * BigInteger, but it seems to prefer converting the -5 to a BigUnsigned, which
- * causes an error. If I take out constructors for BigUnsigned from signed
- * primitive integers, the BigUnsigned(3) becomes ambiguous, and if I take out
- * all the constructors but BigUnsigned(unsigned long), g++ uses that
- * constructor and gets a wrong (positive) answer. Thus, I think we'll just
- * have to live with this cast. */
-BigInteger p2 = BigInteger(BigUnsigned(3)) * -5;
-TEST(p2); //-15
-
-// === Test some previous bugs ===
-
-{
- /* Test that BigInteger division sets the sign to zero.
- * Bug reported by David Allen. */
- BigInteger num(3), denom(5), quotient;
- num.divideWithRemainder(denom, quotient);
- check(quotient);
- num = 5;
- num.divideWithRemainder(denom, quotient);
- check(num);
-}
-
-{
- /* Test that BigInteger subtraction sets the sign properly.
- * Bug reported by Samuel Larkin. */
- BigInteger zero(0), three(3), ans;
- ans = zero - three;
- TEST(check(ans).getSign()); //-1
-}
-
-{
- /* Test that BigInteger multiplication shifts bits properly on systems
- * where long is bigger than int. (Obviously, this would only catch the
- * bug when run on such a system.)
- * Bug reported by Mohand Mezmaz. */
- BigInteger f=4; f*=3;
- TEST(check(f)); //12
-}
-
-{
- /* Test that bitwise XOR allocates the larger length.
- * Bug reported by Sriram Sankararaman. */
- BigUnsigned a(0), b(3), ans;
- ans = a ^ b;
- TEST(ans); //3
-}
-
-{
- /* Test that an aliased multiplication works.
- * Bug reported by Boris Dessy. */
- BigInteger num(5);
- num *= num;
- TEST(check(num)); //25
-}
-
-{
- /* Test that BigUnsignedInABase(std::string) constructor rejects digits
- * too big for the specified base.
- * Bug reported by Niakam Kazemi. */
- TEST(BigUnsignedInABase("f", 10)); //error
-}
-
-} catch (const char *err) {
- cout << "UNCAUGHT ERROR: " << err << endl;
-}
-
-return 0;
-}
*/
#include "kernel/log.h"
-#include "kernel/sha1.h"
+#include "libs/sha1/sha1.h"
#include "ast.h"
#include <sstream>
*/
#include "kernel/log.h"
-#include "kernel/sha1.h"
+#include "libs/sha1/sha1.h"
#include "ast.h"
#include <sstream>
*/
#include "kernel/log.h"
-#include "kernel/sha1.h"
+#include "libs/sha1/sha1.h"
#include "ast.h"
#include <sstream>
#include "verilog_frontend.h"
#include "kernel/register.h"
#include "kernel/log.h"
-#include "kernel/sha1.h"
+#include "libs/sha1/sha1.h"
#include <sstream>
#include <stdarg.h>
#include <assert.h>
*/
#include "kernel/rtlil.h"
-#include "bigint/BigIntegerLibrary.hh"
+#include "libs/bigint/BigIntegerLibrary.hh"
#include <assert.h>
static BigInteger const2big(const RTLIL::Const &val, bool as_signed, int &undef_bit_pos)
+++ /dev/null
-/*\r
- Copyright (c) 2011, Micael Hildenborg\r
- All rights reserved.\r
-\r
- Redistribution and use in source and binary forms, with or without\r
- modification, are permitted provided that the following conditions are met:\r
- * Redistributions of source code must retain the above copyright\r
- notice, this list of conditions and the following disclaimer.\r
- * Redistributions in binary form must reproduce the above copyright\r
- notice, this list of conditions and the following disclaimer in the\r
- documentation and/or other materials provided with the distribution.\r
- * Neither the name of Micael Hildenborg nor the\r
- names of its contributors may be used to endorse or promote products\r
- derived from this software without specific prior written permission.\r
-\r
- THIS SOFTWARE IS PROVIDED BY Micael Hildenborg ''AS IS'' AND ANY\r
- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
- DISCLAIMED. IN NO EVENT SHALL Micael Hildenborg BE LIABLE FOR ANY\r
- DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
- */\r
-\r
-/*\r
- Contributors:\r
- Gustav\r
- Several members in the gamedev.se forum.\r
- Gregory Petrosyan\r
- */\r
-\r
-#include "sha1.h"\r
-\r
-namespace sha1\r
-{\r
- namespace // local\r
- {\r
- // Rotate an integer value to left.\r
- inline unsigned int rol(const unsigned int value,\r
- const unsigned int steps)\r
- {\r
- return ((value << steps) | (value >> (32 - steps)));\r
- }\r
-\r
- // Sets the first 16 integers in the buffert to zero.\r
- // Used for clearing the W buffert.\r
- inline void clearWBuffert(unsigned int* buffert)\r
- {\r
- for (int pos = 16; --pos >= 0;)\r
- {\r
- buffert[pos] = 0;\r
- }\r
- }\r
-\r
- void innerHash(unsigned int* result, unsigned int* w)\r
- {\r
- unsigned int a = result[0];\r
- unsigned int b = result[1];\r
- unsigned int c = result[2];\r
- unsigned int d = result[3];\r
- unsigned int e = result[4];\r
-\r
- int round = 0;\r
-\r
- #define sha1macro(func,val) \\r
- { \\r
- const unsigned int t = rol(a, 5) + (func) + e + val + w[round]; \\r
- e = d; \\r
- d = c; \\r
- c = rol(b, 30); \\r
- b = a; \\r
- a = t; \\r
- }\r
-\r
- while (round < 16)\r
- {\r
- sha1macro((b & c) | (~b & d), 0x5a827999)\r
- ++round;\r
- }\r
- while (round < 20)\r
- {\r
- w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
- sha1macro((b & c) | (~b & d), 0x5a827999)\r
- ++round;\r
- }\r
- while (round < 40)\r
- {\r
- w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
- sha1macro(b ^ c ^ d, 0x6ed9eba1)\r
- ++round;\r
- }\r
- while (round < 60)\r
- {\r
- w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
- sha1macro((b & c) | (b & d) | (c & d), 0x8f1bbcdc)\r
- ++round;\r
- }\r
- while (round < 80)\r
- {\r
- w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
- sha1macro(b ^ c ^ d, 0xca62c1d6)\r
- ++round;\r
- }\r
-\r
- #undef sha1macro\r
-\r
- result[0] += a;\r
- result[1] += b;\r
- result[2] += c;\r
- result[3] += d;\r
- result[4] += e;\r
- }\r
- } // namespace\r
-\r
- void calc(const void* src, const int bytelength, unsigned char* hash)\r
- {\r
- // Init the result array.\r
- unsigned int result[5] = { 0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0 };\r
-\r
- // Cast the void src pointer to be the byte array we can work with.\r
- const unsigned char* sarray = (const unsigned char*) src;\r
-\r
- // The reusable round buffer\r
- unsigned int w[80];\r
-\r
- // Loop through all complete 64byte blocks.\r
- const int endOfFullBlocks = bytelength - 64;\r
- int endCurrentBlock;\r
- int currentBlock = 0;\r
-\r
- while (currentBlock <= endOfFullBlocks)\r
- {\r
- endCurrentBlock = currentBlock + 64;\r
-\r
- // Init the round buffer with the 64 byte block data.\r
- for (int roundPos = 0; currentBlock < endCurrentBlock; currentBlock += 4)\r
- {\r
- // This line will swap endian on big endian and keep endian on little endian.\r
- w[roundPos++] = (unsigned int) sarray[currentBlock + 3]\r
- | (((unsigned int) sarray[currentBlock + 2]) << 8)\r
- | (((unsigned int) sarray[currentBlock + 1]) << 16)\r
- | (((unsigned int) sarray[currentBlock]) << 24);\r
- }\r
- innerHash(result, w);\r
- }\r
-\r
- // Handle the last and not full 64 byte block if existing.\r
- endCurrentBlock = bytelength - currentBlock;\r
- clearWBuffert(w);\r
- int lastBlockBytes = 0;\r
- for (;lastBlockBytes < endCurrentBlock; ++lastBlockBytes)\r
- {\r
- w[lastBlockBytes >> 2] |= (unsigned int) sarray[lastBlockBytes + currentBlock] << ((3 - (lastBlockBytes & 3)) << 3);\r
- }\r
- w[lastBlockBytes >> 2] |= 0x80 << ((3 - (lastBlockBytes & 3)) << 3);\r
- if (endCurrentBlock >= 56)\r
- {\r
- innerHash(result, w);\r
- clearWBuffert(w);\r
- }\r
- w[15] = bytelength << 3;\r
- innerHash(result, w);\r
-\r
- // Store hash in result pointer, and make sure we get in in the correct order on both endian models.\r
- for (int hashByte = 20; --hashByte >= 0;)\r
- {\r
- hash[hashByte] = (result[hashByte >> 2] >> (((3 - hashByte) & 0x3) << 3)) & 0xff;\r
- }\r
- }\r
-\r
- void toHexString(const unsigned char* hash, char* hexstring)\r
- {\r
- const char hexDigits[] = { "0123456789abcdef" };\r
-\r
- for (int hashByte = 20; --hashByte >= 0;)\r
- {\r
- hexstring[hashByte << 1] = hexDigits[(hash[hashByte] >> 4) & 0xf];\r
- hexstring[(hashByte << 1) + 1] = hexDigits[hash[hashByte] & 0xf];\r
- }\r
- hexstring[40] = 0;\r
- }\r
-} // namespace sha1\r
+++ /dev/null
-/*\r
- Copyright (c) 2011, Micael Hildenborg\r
- All rights reserved.\r
-\r
- Redistribution and use in source and binary forms, with or without\r
- modification, are permitted provided that the following conditions are met:\r
- * Redistributions of source code must retain the above copyright\r
- notice, this list of conditions and the following disclaimer.\r
- * Redistributions in binary form must reproduce the above copyright\r
- notice, this list of conditions and the following disclaimer in the\r
- documentation and/or other materials provided with the distribution.\r
- * Neither the name of Micael Hildenborg nor the\r
- names of its contributors may be used to endorse or promote products\r
- derived from this software without specific prior written permission.\r
-\r
- THIS SOFTWARE IS PROVIDED BY Micael Hildenborg ''AS IS'' AND ANY\r
- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
- DISCLAIMED. IN NO EVENT SHALL Micael Hildenborg BE LIABLE FOR ANY\r
- DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
- */\r
-\r
-#ifndef SHA1_DEFINED\r
-#define SHA1_DEFINED\r
-\r
-namespace sha1\r
-{\r
-\r
- /**\r
- @param src points to any kind of data to be hashed.\r
- @param bytelength the number of bytes to hash from the src pointer.\r
- @param hash should point to a buffer of at least 20 bytes of size for storing the sha1 result in.\r
- */\r
- void calc(const void* src, const int bytelength, unsigned char* hash);\r
-\r
- /**\r
- @param hash is 20 bytes of sha1 hash. This is the same data that is the result from the calc function.\r
- @param hexstring should point to a buffer of at least 41 bytes of size for storing the hexadecimal representation of the hash. A zero will be written at position 40, so the buffer will be a valid zero ended string.\r
- */\r
- void toHexString(const unsigned char* hash, char* hexstring);\r
-\r
-} // namespace sha1\r
-\r
-#endif // SHA1_DEFINED\r
--- /dev/null
+*.o
+sample
+testsuite
+testsuite.expected
+testsuite.out
+testsuite.err
--- /dev/null
+#include "BigInteger.hh"
+
+void BigInteger::operator =(const BigInteger &x) {
+ // Calls like a = a have no effect
+ if (this == &x)
+ return;
+ // Copy sign
+ sign = x.sign;
+ // Copy the rest
+ mag = x.mag;
+}
+
+BigInteger::BigInteger(const Blk *b, Index blen, Sign s) : mag(b, blen) {
+ switch (s) {
+ case zero:
+ if (!mag.isZero())
+ throw "BigInteger::BigInteger(const Blk *, Index, Sign): Cannot use a sign of zero with a nonzero magnitude";
+ sign = zero;
+ break;
+ case positive:
+ case negative:
+ // If the magnitude is zero, force the sign to zero.
+ sign = mag.isZero() ? zero : s;
+ break;
+ default:
+ /* g++ seems to be optimizing out this case on the assumption
+ * that the sign is a valid member of the enumeration. Oh well. */
+ throw "BigInteger::BigInteger(const Blk *, Index, Sign): Invalid sign";
+ }
+}
+
+BigInteger::BigInteger(const BigUnsigned &x, Sign s) : mag(x) {
+ switch (s) {
+ case zero:
+ if (!mag.isZero())
+ throw "BigInteger::BigInteger(const BigUnsigned &, Sign): Cannot use a sign of zero with a nonzero magnitude";
+ sign = zero;
+ break;
+ case positive:
+ case negative:
+ // If the magnitude is zero, force the sign to zero.
+ sign = mag.isZero() ? zero : s;
+ break;
+ default:
+ /* g++ seems to be optimizing out this case on the assumption
+ * that the sign is a valid member of the enumeration. Oh well. */
+ throw "BigInteger::BigInteger(const BigUnsigned &, Sign): Invalid sign";
+ }
+}
+
+/* CONSTRUCTION FROM PRIMITIVE INTEGERS
+ * Same idea as in BigUnsigned.cc, except that negative input results in a
+ * negative BigInteger instead of an exception. */
+
+// Done longhand to let us use initialization.
+BigInteger::BigInteger(unsigned long x) : mag(x) { sign = mag.isZero() ? zero : positive; }
+BigInteger::BigInteger(unsigned int x) : mag(x) { sign = mag.isZero() ? zero : positive; }
+BigInteger::BigInteger(unsigned short x) : mag(x) { sign = mag.isZero() ? zero : positive; }
+
+// For signed input, determine the desired magnitude and sign separately.
+
+namespace {
+ template <class X, class UX>
+ BigInteger::Blk magOf(X x) {
+ /* UX(...) cast needed to stop short(-2^15), which negates to
+ * itself, from sign-extending in the conversion to Blk. */
+ return BigInteger::Blk(x < 0 ? UX(-x) : x);
+ }
+ template <class X>
+ BigInteger::Sign signOf(X x) {
+ return (x == 0) ? BigInteger::zero
+ : (x > 0) ? BigInteger::positive
+ : BigInteger::negative;
+ }
+}
+
+BigInteger::BigInteger(long x) : sign(signOf(x)), mag(magOf<long , unsigned long >(x)) {}
+BigInteger::BigInteger(int x) : sign(signOf(x)), mag(magOf<int , unsigned int >(x)) {}
+BigInteger::BigInteger(short x) : sign(signOf(x)), mag(magOf<short, unsigned short>(x)) {}
+
+// CONVERSION TO PRIMITIVE INTEGERS
+
+/* Reuse BigUnsigned's conversion to an unsigned primitive integer.
+ * The friend is a separate function rather than
+ * BigInteger::convertToUnsignedPrimitive to avoid requiring BigUnsigned to
+ * declare BigInteger. */
+template <class X>
+inline X convertBigUnsignedToPrimitiveAccess(const BigUnsigned &a) {
+ return a.convertToPrimitive<X>();
+}
+
+template <class X>
+X BigInteger::convertToUnsignedPrimitive() const {
+ if (sign == negative)
+ throw "BigInteger::to<Primitive>: "
+ "Cannot convert a negative integer to an unsigned type";
+ else
+ return convertBigUnsignedToPrimitiveAccess<X>(mag);
+}
+
+/* Similar to BigUnsigned::convertToPrimitive, but split into two cases for
+ * nonnegative and negative numbers. */
+template <class X, class UX>
+X BigInteger::convertToSignedPrimitive() const {
+ if (sign == zero)
+ return 0;
+ else if (mag.getLength() == 1) {
+ // The single block might fit in an X. Try the conversion.
+ Blk b = mag.getBlock(0);
+ if (sign == positive) {
+ X x = X(b);
+ if (x >= 0 && Blk(x) == b)
+ return x;
+ } else {
+ X x = -X(b);
+ /* UX(...) needed to avoid rejecting conversion of
+ * -2^15 to a short. */
+ if (x < 0 && Blk(UX(-x)) == b)
+ return x;
+ }
+ // Otherwise fall through.
+ }
+ throw "BigInteger::to<Primitive>: "
+ "Value is too big to fit in the requested type";
+}
+
+unsigned long BigInteger::toUnsignedLong () const { return convertToUnsignedPrimitive<unsigned long > (); }
+unsigned int BigInteger::toUnsignedInt () const { return convertToUnsignedPrimitive<unsigned int > (); }
+unsigned short BigInteger::toUnsignedShort() const { return convertToUnsignedPrimitive<unsigned short> (); }
+long BigInteger::toLong () const { return convertToSignedPrimitive <long , unsigned long> (); }
+int BigInteger::toInt () const { return convertToSignedPrimitive <int , unsigned int> (); }
+short BigInteger::toShort () const { return convertToSignedPrimitive <short, unsigned short>(); }
+
+// COMPARISON
+BigInteger::CmpRes BigInteger::compareTo(const BigInteger &x) const {
+ // A greater sign implies a greater number
+ if (sign < x.sign)
+ return less;
+ else if (sign > x.sign)
+ return greater;
+ else switch (sign) {
+ // If the signs are the same...
+ case zero:
+ return equal; // Two zeros are equal
+ case positive:
+ // Compare the magnitudes
+ return mag.compareTo(x.mag);
+ case negative:
+ // Compare the magnitudes, but return the opposite result
+ return CmpRes(-mag.compareTo(x.mag));
+ default:
+ throw "BigInteger internal error";
+ }
+}
+
+/* COPY-LESS OPERATIONS
+ * These do some messing around to determine the sign of the result,
+ * then call one of BigUnsigned's copy-less operations. */
+
+// See remarks about aliased calls in BigUnsigned.cc .
+#define DTRT_ALIASED(cond, op) \
+ if (cond) { \
+ BigInteger tmpThis; \
+ tmpThis.op; \
+ *this = tmpThis; \
+ return; \
+ }
+
+void BigInteger::add(const BigInteger &a, const BigInteger &b) {
+ DTRT_ALIASED(this == &a || this == &b, add(a, b));
+ // If one argument is zero, copy the other.
+ if (a.sign == zero)
+ operator =(b);
+ else if (b.sign == zero)
+ operator =(a);
+ // If the arguments have the same sign, take the
+ // common sign and add their magnitudes.
+ else if (a.sign == b.sign) {
+ sign = a.sign;
+ mag.add(a.mag, b.mag);
+ } else {
+ // Otherwise, their magnitudes must be compared.
+ switch (a.mag.compareTo(b.mag)) {
+ case equal:
+ // If their magnitudes are the same, copy zero.
+ mag = 0;
+ sign = zero;
+ break;
+ // Otherwise, take the sign of the greater, and subtract
+ // the lesser magnitude from the greater magnitude.
+ case greater:
+ sign = a.sign;
+ mag.subtract(a.mag, b.mag);
+ break;
+ case less:
+ sign = b.sign;
+ mag.subtract(b.mag, a.mag);
+ break;
+ }
+ }
+}
+
+void BigInteger::subtract(const BigInteger &a, const BigInteger &b) {
+ // Notice that this routine is identical to BigInteger::add,
+ // if one replaces b.sign by its opposite.
+ DTRT_ALIASED(this == &a || this == &b, subtract(a, b));
+ // If a is zero, copy b and flip its sign. If b is zero, copy a.
+ if (a.sign == zero) {
+ mag = b.mag;
+ // Take the negative of _b_'s, sign, not ours.
+ // Bug pointed out by Sam Larkin on 2005.03.30.
+ sign = Sign(-b.sign);
+ } else if (b.sign == zero)
+ operator =(a);
+ // If their signs differ, take a.sign and add the magnitudes.
+ else if (a.sign != b.sign) {
+ sign = a.sign;
+ mag.add(a.mag, b.mag);
+ } else {
+ // Otherwise, their magnitudes must be compared.
+ switch (a.mag.compareTo(b.mag)) {
+ // If their magnitudes are the same, copy zero.
+ case equal:
+ mag = 0;
+ sign = zero;
+ break;
+ // If a's magnitude is greater, take a.sign and
+ // subtract a from b.
+ case greater:
+ sign = a.sign;
+ mag.subtract(a.mag, b.mag);
+ break;
+ // If b's magnitude is greater, take the opposite
+ // of b.sign and subtract b from a.
+ case less:
+ sign = Sign(-b.sign);
+ mag.subtract(b.mag, a.mag);
+ break;
+ }
+ }
+}
+
+void BigInteger::multiply(const BigInteger &a, const BigInteger &b) {
+ DTRT_ALIASED(this == &a || this == &b, multiply(a, b));
+ // If one object is zero, copy zero and return.
+ if (a.sign == zero || b.sign == zero) {
+ sign = zero;
+ mag = 0;
+ return;
+ }
+ // If the signs of the arguments are the same, the result
+ // is positive, otherwise it is negative.
+ sign = (a.sign == b.sign) ? positive : negative;
+ // Multiply the magnitudes.
+ mag.multiply(a.mag, b.mag);
+}
+
+/*
+ * DIVISION WITH REMAINDER
+ * Please read the comments before the definition of
+ * `BigUnsigned::divideWithRemainder' in `BigUnsigned.cc' for lots of
+ * information you should know before reading this function.
+ *
+ * Following Knuth, I decree that x / y is to be
+ * 0 if y==0 and floor(real-number x / y) if y!=0.
+ * Then x % y shall be x - y*(integer x / y).
+ *
+ * Note that x = y * (x / y) + (x % y) always holds.
+ * In addition, (x % y) is from 0 to y - 1 if y > 0,
+ * and from -(|y| - 1) to 0 if y < 0. (x % y) = x if y = 0.
+ *
+ * Examples: (q = a / b, r = a % b)
+ * a b q r
+ * === === === ===
+ * 4 3 1 1
+ * -4 3 -2 2
+ * 4 -3 -2 -2
+ * -4 -3 1 -1
+ */
+void BigInteger::divideWithRemainder(const BigInteger &b, BigInteger &q) {
+ // Defend against aliased calls;
+ // same idea as in BigUnsigned::divideWithRemainder .
+ if (this == &q)
+ throw "BigInteger::divideWithRemainder: Cannot write quotient and remainder into the same variable";
+ if (this == &b || &q == &b) {
+ BigInteger tmpB(b);
+ divideWithRemainder(tmpB, q);
+ return;
+ }
+
+ // Division by zero gives quotient 0 and remainder *this
+ if (b.sign == zero) {
+ q.mag = 0;
+ q.sign = zero;
+ return;
+ }
+ // 0 / b gives quotient 0 and remainder 0
+ if (sign == zero) {
+ q.mag = 0;
+ q.sign = zero;
+ return;
+ }
+
+ // Here *this != 0, b != 0.
+
+ // Do the operands have the same sign?
+ if (sign == b.sign) {
+ // Yes: easy case. Quotient is zero or positive.
+ q.sign = positive;
+ } else {
+ // No: harder case. Quotient is negative.
+ q.sign = negative;
+ // Decrease the magnitude of the dividend by one.
+ mag--;
+ /*
+ * We tinker with the dividend before and with the
+ * quotient and remainder after so that the result
+ * comes out right. To see why it works, consider the following
+ * list of examples, where A is the magnitude-decreased
+ * a, Q and R are the results of BigUnsigned division
+ * with remainder on A and |b|, and q and r are the
+ * final results we want:
+ *
+ * a A b Q R q r
+ * -3 -2 3 0 2 -1 0
+ * -4 -3 3 1 0 -2 2
+ * -5 -4 3 1 1 -2 1
+ * -6 -5 3 1 2 -2 0
+ *
+ * It appears that we need a total of 3 corrections:
+ * Decrease the magnitude of a to get A. Increase the
+ * magnitude of Q to get q (and make it negative).
+ * Find r = (b - 1) - R and give it the desired sign.
+ */
+ }
+
+ // Divide the magnitudes.
+ mag.divideWithRemainder(b.mag, q.mag);
+
+ if (sign != b.sign) {
+ // More for the harder case (as described):
+ // Increase the magnitude of the quotient by one.
+ q.mag++;
+ // Modify the remainder.
+ mag.subtract(b.mag, mag);
+ mag--;
+ }
+
+ // Sign of the remainder is always the sign of the divisor b.
+ sign = b.sign;
+
+ // Set signs to zero as necessary. (Thanks David Allen!)
+ if (mag.isZero())
+ sign = zero;
+ if (q.mag.isZero())
+ q.sign = zero;
+
+ // WHEW!!!
+}
+
+// Negation
+void BigInteger::negate(const BigInteger &a) {
+ DTRT_ALIASED(this == &a, negate(a));
+ // Copy a's magnitude
+ mag = a.mag;
+ // Copy the opposite of a.sign
+ sign = Sign(-a.sign);
+}
+
+// INCREMENT/DECREMENT OPERATORS
+
+// Prefix increment
+void BigInteger::operator ++() {
+ if (sign == negative) {
+ mag--;
+ if (mag == 0)
+ sign = zero;
+ } else {
+ mag++;
+ sign = positive; // if not already
+ }
+}
+
+// Postfix increment: same as prefix
+void BigInteger::operator ++(int) {
+ operator ++();
+}
+
+// Prefix decrement
+void BigInteger::operator --() {
+ if (sign == positive) {
+ mag--;
+ if (mag == 0)
+ sign = zero;
+ } else {
+ mag++;
+ sign = negative;
+ }
+}
+
+// Postfix decrement: same as prefix
+void BigInteger::operator --(int) {
+ operator --();
+}
+
--- /dev/null
+#ifndef BIGINTEGER_H
+#define BIGINTEGER_H
+
+#include "BigUnsigned.hh"
+
+/* A BigInteger object represents a signed integer of size limited only by
+ * available memory. BigUnsigneds support most mathematical operators and can
+ * be converted to and from most primitive integer types.
+ *
+ * A BigInteger is just an aggregate of a BigUnsigned and a sign. (It is no
+ * longer derived from BigUnsigned because that led to harmful implicit
+ * conversions.) */
+class BigInteger {
+
+public:
+ typedef BigUnsigned::Blk Blk;
+ typedef BigUnsigned::Index Index;
+ typedef BigUnsigned::CmpRes CmpRes;
+ static const CmpRes
+ less = BigUnsigned::less ,
+ equal = BigUnsigned::equal ,
+ greater = BigUnsigned::greater;
+ // Enumeration for the sign of a BigInteger.
+ enum Sign { negative = -1, zero = 0, positive = 1 };
+
+protected:
+ Sign sign;
+ BigUnsigned mag;
+
+public:
+ // Constructs zero.
+ BigInteger() : sign(zero), mag() {}
+
+ // Copy constructor
+ BigInteger(const BigInteger &x) : sign(x.sign), mag(x.mag) {};
+
+ // Assignment operator
+ void operator=(const BigInteger &x);
+
+ // Constructor that copies from a given array of blocks with a sign.
+ BigInteger(const Blk *b, Index blen, Sign s);
+
+ // Nonnegative constructor that copies from a given array of blocks.
+ BigInteger(const Blk *b, Index blen) : mag(b, blen) {
+ sign = mag.isZero() ? zero : positive;
+ }
+
+ // Constructor from a BigUnsigned and a sign
+ BigInteger(const BigUnsigned &x, Sign s);
+
+ // Nonnegative constructor from a BigUnsigned
+ BigInteger(const BigUnsigned &x) : mag(x) {
+ sign = mag.isZero() ? zero : positive;
+ }
+
+ // Constructors from primitive integer types
+ BigInteger(unsigned long x);
+ BigInteger( long x);
+ BigInteger(unsigned int x);
+ BigInteger( int x);
+ BigInteger(unsigned short x);
+ BigInteger( short x);
+
+ /* Converters to primitive integer types
+ * The implicit conversion operators caused trouble, so these are now
+ * named. */
+ unsigned long toUnsignedLong () const;
+ long toLong () const;
+ unsigned int toUnsignedInt () const;
+ int toInt () const;
+ unsigned short toUnsignedShort() const;
+ short toShort () const;
+protected:
+ // Helper
+ template <class X> X convertToUnsignedPrimitive() const;
+ template <class X, class UX> X convertToSignedPrimitive() const;
+public:
+
+ // ACCESSORS
+ Sign getSign() const { return sign; }
+ /* The client can't do any harm by holding a read-only reference to the
+ * magnitude. */
+ const BigUnsigned &getMagnitude() const { return mag; }
+
+ // Some accessors that go through to the magnitude
+ Index getLength() const { return mag.getLength(); }
+ Index getCapacity() const { return mag.getCapacity(); }
+ Blk getBlock(Index i) const { return mag.getBlock(i); }
+ bool isZero() const { return sign == zero; } // A bit special
+
+ // COMPARISONS
+
+ // Compares this to x like Perl's <=>
+ CmpRes compareTo(const BigInteger &x) const;
+
+ // Ordinary comparison operators
+ bool operator ==(const BigInteger &x) const {
+ return sign == x.sign && mag == x.mag;
+ }
+ bool operator !=(const BigInteger &x) const { return !operator ==(x); };
+ bool operator < (const BigInteger &x) const { return compareTo(x) == less ; }
+ bool operator <=(const BigInteger &x) const { return compareTo(x) != greater; }
+ bool operator >=(const BigInteger &x) const { return compareTo(x) != less ; }
+ bool operator > (const BigInteger &x) const { return compareTo(x) == greater; }
+
+ // OPERATORS -- See the discussion in BigUnsigned.hh.
+ void add (const BigInteger &a, const BigInteger &b);
+ void subtract(const BigInteger &a, const BigInteger &b);
+ void multiply(const BigInteger &a, const BigInteger &b);
+ /* See the comment on BigUnsigned::divideWithRemainder. Semantics
+ * differ from those of primitive integers when negatives and/or zeros
+ * are involved. */
+ void divideWithRemainder(const BigInteger &b, BigInteger &q);
+ void negate(const BigInteger &a);
+
+ /* Bitwise operators are not provided for BigIntegers. Use
+ * getMagnitude to get the magnitude and operate on that instead. */
+
+ BigInteger operator +(const BigInteger &x) const;
+ BigInteger operator -(const BigInteger &x) const;
+ BigInteger operator *(const BigInteger &x) const;
+ BigInteger operator /(const BigInteger &x) const;
+ BigInteger operator %(const BigInteger &x) const;
+ BigInteger operator -() const;
+
+ void operator +=(const BigInteger &x);
+ void operator -=(const BigInteger &x);
+ void operator *=(const BigInteger &x);
+ void operator /=(const BigInteger &x);
+ void operator %=(const BigInteger &x);
+ void flipSign();
+
+ // INCREMENT/DECREMENT OPERATORS
+ void operator ++( );
+ void operator ++(int);
+ void operator --( );
+ void operator --(int);
+};
+
+// NORMAL OPERATORS
+/* These create an object to hold the result and invoke
+ * the appropriate put-here operation on it, passing
+ * this and x. The new object is then returned. */
+inline BigInteger BigInteger::operator +(const BigInteger &x) const {
+ BigInteger ans;
+ ans.add(*this, x);
+ return ans;
+}
+inline BigInteger BigInteger::operator -(const BigInteger &x) const {
+ BigInteger ans;
+ ans.subtract(*this, x);
+ return ans;
+}
+inline BigInteger BigInteger::operator *(const BigInteger &x) const {
+ BigInteger ans;
+ ans.multiply(*this, x);
+ return ans;
+}
+inline BigInteger BigInteger::operator /(const BigInteger &x) const {
+ if (x.isZero()) throw "BigInteger::operator /: division by zero";
+ BigInteger q, r;
+ r = *this;
+ r.divideWithRemainder(x, q);
+ return q;
+}
+inline BigInteger BigInteger::operator %(const BigInteger &x) const {
+ if (x.isZero()) throw "BigInteger::operator %: division by zero";
+ BigInteger q, r;
+ r = *this;
+ r.divideWithRemainder(x, q);
+ return r;
+}
+inline BigInteger BigInteger::operator -() const {
+ BigInteger ans;
+ ans.negate(*this);
+ return ans;
+}
+
+/*
+ * ASSIGNMENT OPERATORS
+ *
+ * Now the responsibility for making a temporary copy if necessary
+ * belongs to the put-here operations. See Assignment Operators in
+ * BigUnsigned.hh.
+ */
+inline void BigInteger::operator +=(const BigInteger &x) {
+ add(*this, x);
+}
+inline void BigInteger::operator -=(const BigInteger &x) {
+ subtract(*this, x);
+}
+inline void BigInteger::operator *=(const BigInteger &x) {
+ multiply(*this, x);
+}
+inline void BigInteger::operator /=(const BigInteger &x) {
+ if (x.isZero()) throw "BigInteger::operator /=: division by zero";
+ /* The following technique is slightly faster than copying *this first
+ * when x is large. */
+ BigInteger q;
+ divideWithRemainder(x, q);
+ // *this contains the remainder, but we overwrite it with the quotient.
+ *this = q;
+}
+inline void BigInteger::operator %=(const BigInteger &x) {
+ if (x.isZero()) throw "BigInteger::operator %=: division by zero";
+ BigInteger q;
+ // Mods *this by x. Don't care about quotient left in q.
+ divideWithRemainder(x, q);
+}
+// This one is trivial
+inline void BigInteger::flipSign() {
+ sign = Sign(-sign);
+}
+
+#endif
--- /dev/null
+#include "BigIntegerAlgorithms.hh"
+
+BigUnsigned gcd(BigUnsigned a, BigUnsigned b) {
+ BigUnsigned trash;
+ // Neat in-place alternating technique.
+ for (;;) {
+ if (b.isZero())
+ return a;
+ a.divideWithRemainder(b, trash);
+ if (a.isZero())
+ return b;
+ b.divideWithRemainder(a, trash);
+ }
+}
+
+void extendedEuclidean(BigInteger m, BigInteger n,
+ BigInteger &g, BigInteger &r, BigInteger &s) {
+ if (&g == &r || &g == &s || &r == &s)
+ throw "BigInteger extendedEuclidean: Outputs are aliased";
+ BigInteger r1(1), s1(0), r2(0), s2(1), q;
+ /* Invariants:
+ * r1*m(orig) + s1*n(orig) == m(current)
+ * r2*m(orig) + s2*n(orig) == n(current) */
+ for (;;) {
+ if (n.isZero()) {
+ r = r1; s = s1; g = m;
+ return;
+ }
+ // Subtract q times the second invariant from the first invariant.
+ m.divideWithRemainder(n, q);
+ r1 -= q*r2; s1 -= q*s2;
+
+ if (m.isZero()) {
+ r = r2; s = s2; g = n;
+ return;
+ }
+ // Subtract q times the first invariant from the second invariant.
+ n.divideWithRemainder(m, q);
+ r2 -= q*r1; s2 -= q*s1;
+ }
+}
+
+BigUnsigned modinv(const BigInteger &x, const BigUnsigned &n) {
+ BigInteger g, r, s;
+ extendedEuclidean(x, n, g, r, s);
+ if (g == 1)
+ // r*x + s*n == 1, so r*x === 1 (mod n), so r is the answer.
+ return (r % n).getMagnitude(); // (r % n) will be nonnegative
+ else
+ throw "BigInteger modinv: x and n have a common factor";
+}
+
+BigUnsigned modexp(const BigInteger &base, const BigUnsigned &exponent,
+ const BigUnsigned &modulus) {
+ BigUnsigned ans = 1, base2 = (base % modulus).getMagnitude();
+ BigUnsigned::Index i = exponent.bitLength();
+ // For each bit of the exponent, most to least significant...
+ while (i > 0) {
+ i--;
+ // Square.
+ ans *= ans;
+ ans %= modulus;
+ // And multiply if the bit is a 1.
+ if (exponent.getBit(i)) {
+ ans *= base2;
+ ans %= modulus;
+ }
+ }
+ return ans;
+}
--- /dev/null
+#ifndef BIGINTEGERALGORITHMS_H
+#define BIGINTEGERALGORITHMS_H
+
+#include "BigInteger.hh"
+
+/* Some mathematical algorithms for big integers.
+ * This code is new and, as such, experimental. */
+
+// Returns the greatest common divisor of a and b.
+BigUnsigned gcd(BigUnsigned a, BigUnsigned b);
+
+/* Extended Euclidean algorithm.
+ * Given m and n, finds gcd g and numbers r, s such that r*m + s*n == g. */
+void extendedEuclidean(BigInteger m, BigInteger n,
+ BigInteger &g, BigInteger &r, BigInteger &s);
+
+/* Returns the multiplicative inverse of x modulo n, or throws an exception if
+ * they have a common factor. */
+BigUnsigned modinv(const BigInteger &x, const BigUnsigned &n);
+
+// Returns (base ^ exponent) % modulus.
+BigUnsigned modexp(const BigInteger &base, const BigUnsigned &exponent,
+ const BigUnsigned &modulus);
+
+#endif
--- /dev/null
+// This header file includes all of the library header files.
+
+#include "NumberlikeArray.hh"
+#include "BigUnsigned.hh"
+#include "BigInteger.hh"
+#include "BigIntegerAlgorithms.hh"
+#include "BigUnsignedInABase.hh"
+#include "BigIntegerUtils.hh"
--- /dev/null
+#include "BigIntegerUtils.hh"
+#include "BigUnsignedInABase.hh"
+
+std::string bigUnsignedToString(const BigUnsigned &x) {
+ return std::string(BigUnsignedInABase(x, 10));
+}
+
+std::string bigIntegerToString(const BigInteger &x) {
+ return (x.getSign() == BigInteger::negative)
+ ? (std::string("-") + bigUnsignedToString(x.getMagnitude()))
+ : (bigUnsignedToString(x.getMagnitude()));
+}
+
+BigUnsigned stringToBigUnsigned(const std::string &s) {
+ return BigUnsigned(BigUnsignedInABase(s, 10));
+}
+
+BigInteger stringToBigInteger(const std::string &s) {
+ // Recognize a sign followed by a BigUnsigned.
+ return (s[0] == '-') ? BigInteger(stringToBigUnsigned(s.substr(1, s.length() - 1)), BigInteger::negative)
+ : (s[0] == '+') ? BigInteger(stringToBigUnsigned(s.substr(1, s.length() - 1)))
+ : BigInteger(stringToBigUnsigned(s));
+}
+
+std::ostream &operator <<(std::ostream &os, const BigUnsigned &x) {
+ BigUnsignedInABase::Base base;
+ long osFlags = os.flags();
+ if (osFlags & os.dec)
+ base = 10;
+ else if (osFlags & os.hex) {
+ base = 16;
+ if (osFlags & os.showbase)
+ os << "0x";
+ } else if (osFlags & os.oct) {
+ base = 8;
+ if (osFlags & os.showbase)
+ os << '0';
+ } else
+ throw "std::ostream << BigUnsigned: Could not determine the desired base from output-stream flags";
+ std::string s = std::string(BigUnsignedInABase(x, base));
+ os << s;
+ return os;
+}
+
+std::ostream &operator <<(std::ostream &os, const BigInteger &x) {
+ if (x.getSign() == BigInteger::negative)
+ os << '-';
+ os << x.getMagnitude();
+ return os;
+}
--- /dev/null
+#ifndef BIGINTEGERUTILS_H
+#define BIGINTEGERUTILS_H
+
+#include "BigInteger.hh"
+#include <string>
+#include <iostream>
+
+/* This file provides:
+ * - Convenient std::string <-> BigUnsigned/BigInteger conversion routines
+ * - std::ostream << operators for BigUnsigned/BigInteger */
+
+// std::string conversion routines. Base 10 only.
+std::string bigUnsignedToString(const BigUnsigned &x);
+std::string bigIntegerToString(const BigInteger &x);
+BigUnsigned stringToBigUnsigned(const std::string &s);
+BigInteger stringToBigInteger(const std::string &s);
+
+// Creates a BigInteger from data such as `char's; read below for details.
+template <class T>
+BigInteger dataToBigInteger(const T* data, BigInteger::Index length, BigInteger::Sign sign);
+
+// Outputs x to os, obeying the flags `dec', `hex', `bin', and `showbase'.
+std::ostream &operator <<(std::ostream &os, const BigUnsigned &x);
+
+// Outputs x to os, obeying the flags `dec', `hex', `bin', and `showbase'.
+// My somewhat arbitrary policy: a negative sign comes before a base indicator (like -0xFF).
+std::ostream &operator <<(std::ostream &os, const BigInteger &x);
+
+// BEGIN TEMPLATE DEFINITIONS.
+
+/*
+ * Converts binary data to a BigInteger.
+ * Pass an array `data', its length, and the desired sign.
+ *
+ * Elements of `data' may be of any type `T' that has the following
+ * two properties (this includes almost all integral types):
+ *
+ * (1) `sizeof(T)' correctly gives the amount of binary data in one
+ * value of `T' and is a factor of `sizeof(Blk)'.
+ *
+ * (2) When a value of `T' is casted to a `Blk', the low bytes of
+ * the result contain the desired binary data.
+ */
+template <class T>
+BigInteger dataToBigInteger(const T* data, BigInteger::Index length, BigInteger::Sign sign) {
+ // really ceiling(numBytes / sizeof(BigInteger::Blk))
+ unsigned int pieceSizeInBits = 8 * sizeof(T);
+ unsigned int piecesPerBlock = sizeof(BigInteger::Blk) / sizeof(T);
+ unsigned int numBlocks = (length + piecesPerBlock - 1) / piecesPerBlock;
+
+ // Allocate our block array
+ BigInteger::Blk *blocks = new BigInteger::Blk[numBlocks];
+
+ BigInteger::Index blockNum, pieceNum, pieceNumHere;
+
+ // Convert
+ for (blockNum = 0, pieceNum = 0; blockNum < numBlocks; blockNum++) {
+ BigInteger::Blk curBlock = 0;
+ for (pieceNumHere = 0; pieceNumHere < piecesPerBlock && pieceNum < length;
+ pieceNumHere++, pieceNum++)
+ curBlock |= (BigInteger::Blk(data[pieceNum]) << (pieceSizeInBits * pieceNumHere));
+ blocks[blockNum] = curBlock;
+ }
+
+ // Create the BigInteger.
+ BigInteger x(blocks, numBlocks, sign);
+
+ delete [] blocks;
+ return x;
+}
+
+#endif
--- /dev/null
+#include "BigUnsigned.hh"
+
+// Memory management definitions have moved to the bottom of NumberlikeArray.hh.
+
+// The templates used by these constructors and converters are at the bottom of
+// BigUnsigned.hh.
+
+BigUnsigned::BigUnsigned(unsigned long x) { initFromPrimitive (x); }
+BigUnsigned::BigUnsigned(unsigned int x) { initFromPrimitive (x); }
+BigUnsigned::BigUnsigned(unsigned short x) { initFromPrimitive (x); }
+BigUnsigned::BigUnsigned( long x) { initFromSignedPrimitive(x); }
+BigUnsigned::BigUnsigned( int x) { initFromSignedPrimitive(x); }
+BigUnsigned::BigUnsigned( short x) { initFromSignedPrimitive(x); }
+
+unsigned long BigUnsigned::toUnsignedLong () const { return convertToPrimitive <unsigned long >(); }
+unsigned int BigUnsigned::toUnsignedInt () const { return convertToPrimitive <unsigned int >(); }
+unsigned short BigUnsigned::toUnsignedShort() const { return convertToPrimitive <unsigned short>(); }
+long BigUnsigned::toLong () const { return convertToSignedPrimitive< long >(); }
+int BigUnsigned::toInt () const { return convertToSignedPrimitive< int >(); }
+short BigUnsigned::toShort () const { return convertToSignedPrimitive< short>(); }
+
+// BIT/BLOCK ACCESSORS
+
+void BigUnsigned::setBlock(Index i, Blk newBlock) {
+ if (newBlock == 0) {
+ if (i < len) {
+ blk[i] = 0;
+ zapLeadingZeros();
+ }
+ // If i >= len, no effect.
+ } else {
+ if (i >= len) {
+ // The nonzero block extends the number.
+ allocateAndCopy(i+1);
+ // Zero any added blocks that we aren't setting.
+ for (Index j = len; j < i; j++)
+ blk[j] = 0;
+ len = i+1;
+ }
+ blk[i] = newBlock;
+ }
+}
+
+/* Evidently the compiler wants BigUnsigned:: on the return type because, at
+ * that point, it hasn't yet parsed the BigUnsigned:: on the name to get the
+ * proper scope. */
+BigUnsigned::Index BigUnsigned::bitLength() const {
+ if (isZero())
+ return 0;
+ else {
+ Blk leftmostBlock = getBlock(len - 1);
+ Index leftmostBlockLen = 0;
+ while (leftmostBlock != 0) {
+ leftmostBlock >>= 1;
+ leftmostBlockLen++;
+ }
+ return leftmostBlockLen + (len - 1) * N;
+ }
+}
+
+void BigUnsigned::setBit(Index bi, bool newBit) {
+ Index blockI = bi / N;
+ Blk block = getBlock(blockI), mask = Blk(1) << (bi % N);
+ block = newBit ? (block | mask) : (block & ~mask);
+ setBlock(blockI, block);
+}
+
+// COMPARISON
+BigUnsigned::CmpRes BigUnsigned::compareTo(const BigUnsigned &x) const {
+ // A bigger length implies a bigger number.
+ if (len < x.len)
+ return less;
+ else if (len > x.len)
+ return greater;
+ else {
+ // Compare blocks one by one from left to right.
+ Index i = len;
+ while (i > 0) {
+ i--;
+ if (blk[i] == x.blk[i])
+ continue;
+ else if (blk[i] > x.blk[i])
+ return greater;
+ else
+ return less;
+ }
+ // If no blocks differed, the numbers are equal.
+ return equal;
+ }
+}
+
+// COPY-LESS OPERATIONS
+
+/*
+ * On most calls to copy-less 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 DTRT_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 DTRT_ALIASED(cond, op) \
+ if (cond) { \
+ BigUnsigned tmpThis; \
+ tmpThis.op; \
+ *this = tmpThis; \
+ return; \
+ }
+
+
+
+void BigUnsigned::add(const BigUnsigned &a, const BigUnsigned &b) {
+ DTRT_ALIASED(this == &a || this == &b, add(a, b));
+ // If one argument is zero, copy the other.
+ if (a.len == 0) {
+ operator =(b);
+ return;
+ } else if (b.len == 0) {
+ operator =(a);
+ return;
+ }
+ // Some variables...
+ // Carries in and out of an addition stage
+ bool carryIn, carryOut;
+ Blk temp;
+ Index i;
+ // a2 points to the longer input, b2 points to the shorter
+ const BigUnsigned *a2, *b2;
+ if (a.len >= b.len) {
+ a2 = &a;
+ b2 = &b;
+ } else {
+ a2 = &b;
+ b2 = &a;
+ }
+ // Set prelimiary length and make room in this BigUnsigned
+ len = a2->len + 1;
+ allocate(len);
+ // For each block index that is present in both inputs...
+ for (i = 0, carryIn = false; i < b2->len; i++) {
+ // Add input blocks
+ temp = a2->blk[i] + b2->blk[i];
+ // If a rollover occurred, the result is less than either input.
+ // This test is used many times in the BigUnsigned code.
+ carryOut = (temp < a2->blk[i]);
+ // If a carry was input, handle it
+ if (carryIn) {
+ temp++;
+ carryOut |= (temp == 0);
+ }
+ blk[i] = temp; // Save the addition result
+ carryIn = carryOut; // Pass the carry along
+ }
+ // If there is a carry left over, increase blocks until
+ // one does not roll over.
+ for (; i < a2->len && carryIn; i++) {
+ temp = a2->blk[i] + 1;
+ carryIn = (temp == 0);
+ blk[i] = temp;
+ }
+ // If the carry was resolved but the larger number
+ // still has blocks, copy them over.
+ for (; i < a2->len; i++)
+ blk[i] = a2->blk[i];
+ // Set the extra block if there's still a carry, decrease length otherwise
+ if (carryIn)
+ blk[i] = 1;
+ else
+ len--;
+}
+
+void BigUnsigned::subtract(const BigUnsigned &a, const BigUnsigned &b) {
+ DTRT_ALIASED(this == &a || this == &b, subtract(a, b));
+ if (b.len == 0) {
+ // If b is zero, copy a.
+ operator =(a);
+ return;
+ } else if (a.len < b.len)
+ // If a is shorter than b, the result is negative.
+ throw "BigUnsigned::subtract: "
+ "Negative result in unsigned calculation";
+ // Some variables...
+ bool borrowIn, borrowOut;
+ Blk temp;
+ Index i;
+ // Set preliminary length and make room
+ len = a.len;
+ allocate(len);
+ // For each block index that is present in both inputs...
+ for (i = 0, borrowIn = false; i < b.len; i++) {
+ temp = a.blk[i] - b.blk[i];
+ // If a reverse rollover occurred,
+ // the result is greater than the block from a.
+ borrowOut = (temp > a.blk[i]);
+ // Handle an incoming borrow
+ if (borrowIn) {
+ borrowOut |= (temp == 0);
+ temp--;
+ }
+ blk[i] = temp; // Save the subtraction result
+ borrowIn = borrowOut; // Pass the borrow along
+ }
+ // If there is a borrow left over, decrease blocks until
+ // one does not reverse rollover.
+ for (; i < a.len && borrowIn; i++) {
+ borrowIn = (a.blk[i] == 0);
+ blk[i] = a.blk[i] - 1;
+ }
+ /* If there's still a borrow, the result is negative.
+ * Throw an exception, but zero out this object so as to leave it in a
+ * predictable state. */
+ if (borrowIn) {
+ len = 0;
+ throw "BigUnsigned::subtract: Negative result in unsigned calculation";
+ } else
+ // Copy over the rest of the blocks
+ for (; i < a.len; i++)
+ blk[i] = a.blk[i];
+ // Zap leading zeros
+ zapLeadingZeros();
+}
+
+/*
+ * About the multiplication and division algorithms:
+ *
+ * I searched unsucessfully for fast C++ built-in operations like the `b_0'
+ * and `c_0' Knuth describes in Section 4.3.1 of ``The Art of Computer
+ * Programming'' (replace `place' by `Blk'):
+ *
+ * ``b_0[:] multiplication of a one-place integer by another one-place
+ * integer, giving a two-place answer;
+ *
+ * ``c_0[:] division of a two-place integer by a one-place integer,
+ * provided that the quotient is a one-place integer, and yielding
+ * also a one-place remainder.''
+ *
+ * I also missed his note that ``[b]y adjusting the word size, if
+ * necessary, nearly all computers will have these three operations
+ * available'', so I gave up on trying to use algorithms similar to his.
+ * A future version of the library might include such algorithms; I
+ * would welcome contributions from others for this.
+ *
+ * I eventually decided to use bit-shifting algorithms. To multiply `a'
+ * and `b', we zero out the result. Then, for each `1' bit in `a', we
+ * shift `b' left the appropriate amount and add it to the result.
+ * Similarly, to divide `a' by `b', we shift `b' left varying amounts,
+ * repeatedly trying to subtract it from `a'. When we succeed, we note
+ * the fact by setting a bit in the quotient. While these algorithms
+ * have the same O(n^2) time complexity as Knuth's, the ``constant factor''
+ * is likely to be larger.
+ *
+ * Because I used these algorithms, which require single-block addition
+ * and subtraction rather than single-block multiplication and division,
+ * the innermost loops of all four routines are very similar. Study one
+ * of them and all will become clear.
+ */
+
+/*
+ * This is a little inline function used by both the multiplication
+ * routine and the division routine.
+ *
+ * `getShiftedBlock' returns the `x'th block of `num << y'.
+ * `y' may be anything from 0 to N - 1, and `x' may be anything from
+ * 0 to `num.len'.
+ *
+ * Two things contribute to this block:
+ *
+ * (1) The `N - y' low bits of `num.blk[x]', shifted `y' bits left.
+ *
+ * (2) The `y' high bits of `num.blk[x-1]', shifted `N - y' bits right.
+ *
+ * But we must be careful if `x == 0' or `x == num.len', in
+ * which case we should use 0 instead of (2) or (1), respectively.
+ *
+ * If `y == 0', then (2) contributes 0, as it should. However,
+ * in some computer environments, for a reason I cannot understand,
+ * `a >> b' means `a >> (b % N)'. This means `num.blk[x-1] >> (N - y)'
+ * will return `num.blk[x-1]' instead of the desired 0 when `y == 0';
+ * the test `y == 0' handles this case specially.
+ */
+inline BigUnsigned::Blk getShiftedBlock(const BigUnsigned &num,
+ BigUnsigned::Index x, unsigned int y) {
+ BigUnsigned::Blk part1 = (x == 0 || y == 0) ? 0 : (num.blk[x - 1] >> (BigUnsigned::N - y));
+ BigUnsigned::Blk part2 = (x == num.len) ? 0 : (num.blk[x] << y);
+ return part1 | part2;
+}
+
+void BigUnsigned::multiply(const BigUnsigned &a, const BigUnsigned &b) {
+ DTRT_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;
+ return;
+ }
+ /*
+ * Overall method:
+ *
+ * Set this = 0.
+ * For each 1-bit of `a' (say the `i2'th bit of block `i'):
+ * Add `b << (i blocks and i2 bits)' to *this.
+ */
+ // Variables for the calculation
+ Index i, j, k;
+ unsigned int i2;
+ Blk temp;
+ bool carryIn, carryOut;
+ // Set preliminary length and make room
+ len = a.len + b.len;
+ allocate(len);
+ // Zero out this object
+ for (i = 0; i < len; i++)
+ blk[i] = 0;
+ // For each block of the first number...
+ for (i = 0; i < a.len; i++) {
+ // For each 1-bit of that block...
+ for (i2 = 0; i2 < N; i2++) {
+ if ((a.blk[i] & (Blk(1) << i2)) == 0)
+ continue;
+ /*
+ * Add b to this, shifted left i blocks and i2 bits.
+ * j is the index in b, and k = i + j is the index in this.
+ *
+ * `getShiftedBlock', a short inline function defined above,
+ * is now used for the bit handling. It replaces the more
+ * complex `bHigh' code, in which each run of the loop dealt
+ * immediately with the low bits and saved the high bits to
+ * be picked up next time. The last run of the loop used to
+ * leave leftover high bits, which were handled separately.
+ * Instead, this loop runs an additional time with j == b.len.
+ * These changes were made on 2005.01.11.
+ */
+ for (j = 0, k = i, carryIn = false; j <= b.len; j++, k++) {
+ /*
+ * The body of this loop is very similar to the body of the first loop
+ * in `add', except that this loop does a `+=' instead of a `+'.
+ */
+ temp = blk[k] + getShiftedBlock(b, j, i2);
+ carryOut = (temp < blk[k]);
+ if (carryIn) {
+ temp++;
+ carryOut |= (temp == 0);
+ }
+ blk[k] = temp;
+ carryIn = carryOut;
+ }
+ // No more extra iteration to deal with `bHigh'.
+ // Roll-over a carry as necessary.
+ for (; carryIn; k++) {
+ blk[k]++;
+ carryIn = (blk[k] == 0);
+ }
+ }
+ }
+ // Zap possible leading zero
+ if (blk[len - 1] == 0)
+ len--;
+}
+
+/*
+ * DIVISION WITH REMAINDER
+ * This monstrous function mods *this by the given divisor b while storing the
+ * quotient in the given object q; at the end, *this contains the remainder.
+ * The seemingly bizarre pattern of inputs and outputs was chosen so that the
+ * function copies as little as possible (since it is implemented by repeated
+ * subtraction of multiples of b from *this).
+ *
+ * "modWithQuotient" might be a better name for this function, but I would
+ * rather not change the name now.
+ */
+void BigUnsigned::divideWithRemainder(const BigUnsigned &b, BigUnsigned &q) {
+ /* Defending against aliased calls is more complex than usual 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;
+ }
+
+ /*
+ * Knuth's definition of mod (which this function uses) is somewhat
+ * different from the C++ definition of % in case of division by 0.
+ *
+ * We let a / 0 == 0 (it doesn't matter much) and a % 0 == a, no
+ * exceptions thrown. This allows us to preserve both Knuth's demand
+ * that a mod 0 == a and the useful property that
+ * (a / b) * b + (a % b) == a.
+ */
+ if (b.len == 0) {
+ q.len = 0;
+ return;
+ }
+
+ /*
+ * If *this.len < b.len, then *this < b, and we can be sure that b doesn't go into
+ * *this at all. The quotient is 0 and *this is already the remainder (so leave it alone).
+ */
+ if (len < b.len) {
+ q.len = 0;
+ return;
+ }
+
+ // At this point we know (*this).len >= b.len > 0. (Whew!)
+
+ /*
+ * Overall method:
+ *
+ * For each appropriate i and i2, decreasing:
+ * Subtract (b << (i blocks and i2 bits)) from *this, storing the
+ * result in subtractBuf.
+ * If the subtraction succeeds with a nonnegative result:
+ * Turn on bit i2 of block i of the quotient q.
+ * Copy subtractBuf back into *this.
+ * Otherwise bit i2 of block i remains off, and *this is unchanged.
+ *
+ * Eventually q will contain the entire quotient, and *this will
+ * be left with the remainder.
+ *
+ * subtractBuf[x] corresponds to blk[x], not blk[x+i], since 2005.01.11.
+ * But on a single iteration, we don't touch the i lowest blocks of blk
+ * (and don't use those of subtractBuf) because these blocks are
+ * unaffected by the subtraction: we are subtracting
+ * (b << (i blocks and i2 bits)), which ends in at least `i' zero
+ * blocks. */
+ // Variables for the calculation
+ Index i, j, k;
+ unsigned int i2;
+ Blk temp;
+ bool borrowIn, borrowOut;
+
+ /*
+ * Make sure we have an extra zero block just past the value.
+ *
+ * When we attempt a subtraction, we might shift `b' so
+ * its first block begins a few bits left of the dividend,
+ * and then we'll try to compare these extra bits with
+ * a nonexistent block to the left of the dividend. The
+ * extra zero block ensures sensible behavior; we need
+ * an extra block in `subtractBuf' for exactly the same reason.
+ */
+ Index origLen = len; // Save real length.
+ /* To avoid an out-of-bounds access in case of reallocation, allocate
+ * first and then increment the logical length. */
+ allocateAndCopy(len + 1);
+ len++;
+ blk[origLen] = 0; // Zero the added block.
+
+ // subtractBuf holds part of the result of a subtraction; see above.
+ Blk *subtractBuf = new Blk[len];
+
+ // Set preliminary length for quotient and make room
+ q.len = origLen - b.len + 1;
+ q.allocate(q.len);
+ // Zero out the quotient
+ for (i = 0; i < q.len; i++)
+ q.blk[i] = 0;
+
+ // For each possible left-shift of b in blocks...
+ i = q.len;
+ while (i > 0) {
+ i--;
+ // For each possible left-shift of b in bits...
+ // (Remember, N is the number of bits in a Blk.)
+ q.blk[i] = 0;
+ i2 = N;
+ while (i2 > 0) {
+ i2--;
+ /*
+ * Subtract b, shifted left i blocks and i2 bits, from *this,
+ * and store the answer in subtractBuf. In the for loop, `k == i + j'.
+ *
+ * Compare this to the middle section of `multiply'. They
+ * are in many ways analogous. See especially the discussion
+ * of `getShiftedBlock'.
+ */
+ for (j = 0, k = i, borrowIn = false; j <= b.len; j++, k++) {
+ temp = blk[k] - getShiftedBlock(b, j, i2);
+ borrowOut = (temp > blk[k]);
+ if (borrowIn) {
+ borrowOut |= (temp == 0);
+ temp--;
+ }
+ // Since 2005.01.11, indices of `subtractBuf' directly match those of `blk', so use `k'.
+ subtractBuf[k] = temp;
+ borrowIn = borrowOut;
+ }
+ // No more extra iteration to deal with `bHigh'.
+ // Roll-over a borrow as necessary.
+ for (; k < origLen && borrowIn; k++) {
+ borrowIn = (blk[k] == 0);
+ subtractBuf[k] = blk[k] - 1;
+ }
+ /*
+ * If the subtraction was performed successfully (!borrowIn),
+ * set bit i2 in block i of the quotient.
+ *
+ * Then, copy the portion of subtractBuf filled by the subtraction
+ * back to *this. This portion starts with block i and ends--
+ * where? Not necessarily at block `i + b.len'! Well, we
+ * increased k every time we saved a block into subtractBuf, so
+ * the region of subtractBuf we copy is just [i, k).
+ */
+ if (!borrowIn) {
+ q.blk[i] |= (Blk(1) << i2);
+ while (k > i) {
+ k--;
+ blk[k] = subtractBuf[k];
+ }
+ }
+ }
+ }
+ // Zap possible leading zero in quotient
+ if (q.blk[q.len - 1] == 0)
+ q.len--;
+ // Zap any/all leading zeros in remainder
+ zapLeadingZeros();
+ // Deallocate subtractBuf.
+ // (Thanks to Brad Spencer for noticing my accidental omission of this!)
+ delete [] subtractBuf;
+}
+
+/* BITWISE OPERATORS
+ * These are straightforward blockwise operations except that they differ in
+ * the output length and the necessity of zapLeadingZeros. */
+
+void BigUnsigned::bitAnd(const BigUnsigned &a, const BigUnsigned &b) {
+ DTRT_ALIASED(this == &a || this == &b, bitAnd(a, b));
+ // The bitwise & can't be longer than either operand.
+ len = (a.len >= b.len) ? b.len : a.len;
+ allocate(len);
+ Index i;
+ for (i = 0; i < len; i++)
+ blk[i] = a.blk[i] & b.blk[i];
+ zapLeadingZeros();
+}
+
+void BigUnsigned::bitOr(const BigUnsigned &a, const BigUnsigned &b) {
+ DTRT_ALIASED(this == &a || this == &b, bitOr(a, b));
+ Index i;
+ const BigUnsigned *a2, *b2;
+ if (a.len >= b.len) {
+ a2 = &a;
+ b2 = &b;
+ } else {
+ a2 = &b;
+ b2 = &a;
+ }
+ allocate(a2->len);
+ for (i = 0; i < b2->len; i++)
+ blk[i] = a2->blk[i] | b2->blk[i];
+ for (; i < a2->len; i++)
+ blk[i] = a2->blk[i];
+ len = a2->len;
+ // Doesn't need zapLeadingZeros.
+}
+
+void BigUnsigned::bitXor(const BigUnsigned &a, const BigUnsigned &b) {
+ DTRT_ALIASED(this == &a || this == &b, bitXor(a, b));
+ Index i;
+ const BigUnsigned *a2, *b2;
+ if (a.len >= b.len) {
+ a2 = &a;
+ b2 = &b;
+ } else {
+ a2 = &b;
+ b2 = &a;
+ }
+ allocate(a2->len);
+ for (i = 0; i < b2->len; i++)
+ blk[i] = a2->blk[i] ^ b2->blk[i];
+ for (; i < a2->len; i++)
+ blk[i] = a2->blk[i];
+ len = a2->len;
+ zapLeadingZeros();
+}
+
+void BigUnsigned::bitShiftLeft(const BigUnsigned &a, int b) {
+ DTRT_ALIASED(this == &a, bitShiftLeft(a, b));
+ if (b < 0) {
+ if (b << 1 == 0)
+ throw "BigUnsigned::bitShiftLeft: "
+ "Pathological shift amount not implemented";
+ else {
+ bitShiftRight(a, -b);
+ return;
+ }
+ }
+ Index shiftBlocks = b / N;
+ unsigned int shiftBits = b % N;
+ // + 1: room for high bits nudged left into another block
+ len = a.len + shiftBlocks + 1;
+ allocate(len);
+ Index i, j;
+ for (i = 0; i < shiftBlocks; i++)
+ blk[i] = 0;
+ for (j = 0, i = shiftBlocks; j <= a.len; j++, i++)
+ blk[i] = getShiftedBlock(a, j, shiftBits);
+ // Zap possible leading zero
+ if (blk[len - 1] == 0)
+ len--;
+}
+
+void BigUnsigned::bitShiftRight(const BigUnsigned &a, int b) {
+ DTRT_ALIASED(this == &a, bitShiftRight(a, b));
+ if (b < 0) {
+ if (b << 1 == 0)
+ throw "BigUnsigned::bitShiftRight: "
+ "Pathological shift amount not implemented";
+ else {
+ bitShiftLeft(a, -b);
+ return;
+ }
+ }
+ // This calculation is wacky, but expressing the shift as a left bit shift
+ // within each block lets us use getShiftedBlock.
+ Index rightShiftBlocks = (b + N - 1) / N;
+ unsigned int leftShiftBits = N * rightShiftBlocks - b;
+ // Now (N * rightShiftBlocks - leftShiftBits) == b
+ // and 0 <= leftShiftBits < N.
+ if (rightShiftBlocks >= a.len + 1) {
+ // All of a is guaranteed to be shifted off, even considering the left
+ // bit shift.
+ len = 0;
+ return;
+ }
+ // Now we're allocating a positive amount.
+ // + 1: room for high bits nudged left into another block
+ len = a.len + 1 - rightShiftBlocks;
+ allocate(len);
+ Index i, j;
+ for (j = rightShiftBlocks, i = 0; j <= a.len; j++, i++)
+ blk[i] = getShiftedBlock(a, j, leftShiftBits);
+ // Zap possible leading zero
+ if (blk[len - 1] == 0)
+ len--;
+}
+
+// INCREMENT/DECREMENT OPERATORS
+
+// Prefix increment
+void BigUnsigned::operator ++() {
+ Index i;
+ bool carry = true;
+ for (i = 0; i < len && carry; i++) {
+ blk[i]++;
+ carry = (blk[i] == 0);
+ }
+ if (carry) {
+ // Allocate and then increase length, as in divideWithRemainder
+ allocateAndCopy(len + 1);
+ len++;
+ blk[i] = 1;
+ }
+}
+
+// Postfix increment: same as prefix
+void BigUnsigned::operator ++(int) {
+ operator ++();
+}
+
+// Prefix decrement
+void BigUnsigned::operator --() {
+ if (len == 0)
+ throw "BigUnsigned::operator --(): Cannot decrement an unsigned zero";
+ Index i;
+ bool borrow = true;
+ for (i = 0; borrow; i++) {
+ borrow = (blk[i] == 0);
+ blk[i]--;
+ }
+ // Zap possible leading zero (there can only be one)
+ if (blk[len - 1] == 0)
+ len--;
+}
+
+// Postfix decrement: same as prefix
+void BigUnsigned::operator --(int) {
+ operator --();
+}
--- /dev/null
+#ifndef BIGUNSIGNED_H
+#define BIGUNSIGNED_H
+
+#include "NumberlikeArray.hh"
+
+/* A BigUnsigned object represents a nonnegative integer of size limited only by
+ * available memory. BigUnsigneds support most mathematical operators and can
+ * be converted to and from most primitive integer types.
+ *
+ * The number is stored as a NumberlikeArray of unsigned longs as if it were
+ * written in base 256^sizeof(unsigned long). The least significant block is
+ * first, and the length is such that the most significant block is nonzero. */
+class BigUnsigned : protected NumberlikeArray<unsigned long> {
+
+public:
+ // Enumeration for the result of a comparison.
+ enum CmpRes { less = -1, equal = 0, greater = 1 };
+
+ // BigUnsigneds are built with a Blk type of unsigned long.
+ typedef unsigned long Blk;
+
+ typedef NumberlikeArray<Blk>::Index Index;
+ using NumberlikeArray<Blk>::N;
+
+protected:
+ // Creates a BigUnsigned with a capacity; for internal use.
+ BigUnsigned(int, Index c) : NumberlikeArray<Blk>(0, c) {}
+
+ // Decreases len to eliminate any leading zero blocks.
+ void zapLeadingZeros() {
+ while (len > 0 && blk[len - 1] == 0)
+ len--;
+ }
+
+public:
+ // Constructs zero.
+ BigUnsigned() : NumberlikeArray<Blk>() {}
+
+ // Copy constructor
+ BigUnsigned(const BigUnsigned &x) : NumberlikeArray<Blk>(x) {}
+
+ // Assignment operator
+ void operator=(const BigUnsigned &x) {
+ NumberlikeArray<Blk>::operator =(x);
+ }
+
+ // Constructor that copies from a given array of blocks.
+ BigUnsigned(const Blk *b, Index blen) : NumberlikeArray<Blk>(b, blen) {
+ // Eliminate any leading zeros we may have been passed.
+ zapLeadingZeros();
+ }
+
+ // Destructor. NumberlikeArray does the delete for us.
+ ~BigUnsigned() {}
+
+ // Constructors from primitive integer types
+ BigUnsigned(unsigned long x);
+ BigUnsigned( long x);
+ BigUnsigned(unsigned int x);
+ BigUnsigned( int x);
+ BigUnsigned(unsigned short x);
+ BigUnsigned( short x);
+protected:
+ // Helpers
+ template <class X> void initFromPrimitive (X x);
+ template <class X> void initFromSignedPrimitive(X x);
+public:
+
+ /* Converters to primitive integer types
+ * The implicit conversion operators caused trouble, so these are now
+ * named. */
+ unsigned long toUnsignedLong () const;
+ long toLong () const;
+ unsigned int toUnsignedInt () const;
+ int toInt () const;
+ unsigned short toUnsignedShort() const;
+ short toShort () const;
+protected:
+ // Helpers
+ template <class X> X convertToSignedPrimitive() const;
+ template <class X> X convertToPrimitive () const;
+public:
+
+ // BIT/BLOCK ACCESSORS
+
+ // Expose these from NumberlikeArray directly.
+ using NumberlikeArray<Blk>::getCapacity;
+ using NumberlikeArray<Blk>::getLength;
+
+ /* Returns the requested block, or 0 if it is beyond the length (as if
+ * the number had 0s infinitely to the left). */
+ Blk getBlock(Index i) const { return i >= len ? 0 : blk[i]; }
+ /* Sets the requested block. The number grows or shrinks as necessary. */
+ void setBlock(Index i, Blk newBlock);
+
+ // The number is zero if and only if the canonical length is zero.
+ bool isZero() const { return NumberlikeArray<Blk>::isEmpty(); }
+
+ /* Returns the length of the number in bits, i.e., zero if the number
+ * is zero and otherwise one more than the largest value of bi for
+ * which getBit(bi) returns true. */
+ Index bitLength() const;
+ /* Get the state of bit bi, which has value 2^bi. Bits beyond the
+ * number's length are considered to be 0. */
+ bool getBit(Index bi) const {
+ return (getBlock(bi / N) & (Blk(1) << (bi % N))) != 0;
+ }
+ /* Sets the state of bit bi to newBit. The number grows or shrinks as
+ * necessary. */
+ void setBit(Index bi, bool newBit);
+
+ // COMPARISONS
+
+ // Compares this to x like Perl's <=>
+ CmpRes compareTo(const BigUnsigned &x) const;
+
+ // Ordinary comparison operators
+ bool operator ==(const BigUnsigned &x) const {
+ return NumberlikeArray<Blk>::operator ==(x);
+ }
+ bool operator !=(const BigUnsigned &x) const {
+ return NumberlikeArray<Blk>::operator !=(x);
+ }
+ bool operator < (const BigUnsigned &x) const { return compareTo(x) == less ; }
+ bool operator <=(const BigUnsigned &x) const { return compareTo(x) != greater; }
+ bool operator >=(const BigUnsigned &x) const { return compareTo(x) != less ; }
+ bool operator > (const BigUnsigned &x) const { return compareTo(x) == greater; }
+
+ /*
+ * BigUnsigned and BigInteger both provide three kinds of operators.
+ * Here ``big-integer'' refers to BigInteger or BigUnsigned.
+ *
+ * (1) Overloaded ``return-by-value'' operators:
+ * +, -, *, /, %, unary -, &, |, ^, <<, >>.
+ * Big-integer code using these operators looks identical to code using
+ * the primitive integer types. These operators take one or two
+ * big-integer inputs and return a big-integer result, which can then
+ * be assigned to a BigInteger variable or used in an expression.
+ * Example:
+ * BigInteger a(1), b = 1;
+ * BigInteger c = a + b;
+ *
+ * (2) Overloaded assignment operators:
+ * +=, -=, *=, /=, %=, flipSign, &=, |=, ^=, <<=, >>=, ++, --.
+ * Again, these are used on big integers just like on ints. They take
+ * one writable big integer that both provides an operand and receives a
+ * result. Most also take a second read-only operand.
+ * Example:
+ * BigInteger a(1), b(1);
+ * a += b;
+ *
+ * (3) Copy-less operations: `add', `subtract', etc.
+ * These named methods take operands as arguments and store the result
+ * in the receiver (*this), avoiding unnecessary copies and allocations.
+ * `divideWithRemainder' is special: it both takes the dividend from and
+ * stores the remainder into the receiver, and it takes a separate
+ * object in which to store the quotient. NOTE: If you are wondering
+ * why these don't return a value, you probably mean to use the
+ * overloaded return-by-value operators instead.
+ *
+ * Examples:
+ * BigInteger a(43), b(7), c, d;
+ *
+ * c = a + b; // Now c == 50.
+ * c.add(a, b); // Same effect but without the two copies.
+ *
+ * c.divideWithRemainder(b, d);
+ * // 50 / 7; now d == 7 (quotient) and c == 1 (remainder).
+ *
+ * // ``Aliased'' calls now do the right thing using a temporary
+ * // copy, but see note on `divideWithRemainder'.
+ * a.add(a, b);
+ */
+
+ // COPY-LESS OPERATIONS
+
+ // These 8: Arguments are read-only operands, result is saved in *this.
+ void add(const BigUnsigned &a, const BigUnsigned &b);
+ void subtract(const BigUnsigned &a, const BigUnsigned &b);
+ void multiply(const BigUnsigned &a, const BigUnsigned &b);
+ void bitAnd(const BigUnsigned &a, const BigUnsigned &b);
+ void bitOr(const BigUnsigned &a, const BigUnsigned &b);
+ void bitXor(const BigUnsigned &a, const BigUnsigned &b);
+ /* Negative shift amounts translate to opposite-direction shifts,
+ * except for -2^(8*sizeof(int)-1) which is unimplemented. */
+ void bitShiftLeft(const BigUnsigned &a, int b);
+ void bitShiftRight(const BigUnsigned &a, int b);
+
+ /* `a.divideWithRemainder(b, q)' is like `q = a / b, a %= b'.
+ * / and % use semantics similar to Knuth's, which differ from the
+ * primitive integer semantics under division by zero. See the
+ * implementation in BigUnsigned.cc for details.
+ * `a.divideWithRemainder(b, a)' throws an exception: it doesn't make
+ * sense to write quotient and remainder into the same variable. */
+ void divideWithRemainder(const BigUnsigned &b, BigUnsigned &q);
+
+ /* `divide' and `modulo' are no longer offered. Use
+ * `divideWithRemainder' instead. */
+
+ // OVERLOADED RETURN-BY-VALUE OPERATORS
+ BigUnsigned operator +(const BigUnsigned &x) const;
+ BigUnsigned operator -(const BigUnsigned &x) const;
+ BigUnsigned operator *(const BigUnsigned &x) const;
+ BigUnsigned operator /(const BigUnsigned &x) const;
+ BigUnsigned operator %(const BigUnsigned &x) const;
+ /* OK, maybe unary minus could succeed in one case, but it really
+ * shouldn't be used, so it isn't provided. */
+ BigUnsigned operator &(const BigUnsigned &x) const;
+ BigUnsigned operator |(const BigUnsigned &x) const;
+ BigUnsigned operator ^(const BigUnsigned &x) const;
+ BigUnsigned operator <<(int b) const;
+ BigUnsigned operator >>(int b) const;
+
+ // OVERLOADED ASSIGNMENT OPERATORS
+ void operator +=(const BigUnsigned &x);
+ void operator -=(const BigUnsigned &x);
+ void operator *=(const BigUnsigned &x);
+ void operator /=(const BigUnsigned &x);
+ void operator %=(const BigUnsigned &x);
+ void operator &=(const BigUnsigned &x);
+ void operator |=(const BigUnsigned &x);
+ void operator ^=(const BigUnsigned &x);
+ void operator <<=(int b);
+ void operator >>=(int b);
+
+ /* INCREMENT/DECREMENT OPERATORS
+ * To discourage messy coding, these do not return *this, so prefix
+ * and postfix behave the same. */
+ void operator ++( );
+ void operator ++(int);
+ void operator --( );
+ void operator --(int);
+
+ // Helper function that needs access to BigUnsigned internals
+ friend Blk getShiftedBlock(const BigUnsigned &num, Index x,
+ unsigned int y);
+
+ // See BigInteger.cc.
+ template <class X>
+ friend X convertBigUnsignedToPrimitiveAccess(const BigUnsigned &a);
+};
+
+/* Implementing the return-by-value and assignment operators in terms of the
+ * copy-less operations. The copy-less operations are responsible for making
+ * any necessary temporary copies to work around aliasing. */
+
+inline BigUnsigned BigUnsigned::operator +(const BigUnsigned &x) const {
+ BigUnsigned ans;
+ ans.add(*this, x);
+ return ans;
+}
+inline BigUnsigned BigUnsigned::operator -(const BigUnsigned &x) const {
+ BigUnsigned ans;
+ ans.subtract(*this, x);
+ return ans;
+}
+inline BigUnsigned BigUnsigned::operator *(const BigUnsigned &x) const {
+ BigUnsigned ans;
+ ans.multiply(*this, x);
+ return ans;
+}
+inline BigUnsigned BigUnsigned::operator /(const BigUnsigned &x) const {
+ if (x.isZero()) throw "BigUnsigned::operator /: division by zero";
+ BigUnsigned q, r;
+ r = *this;
+ r.divideWithRemainder(x, q);
+ return q;
+}
+inline BigUnsigned BigUnsigned::operator %(const BigUnsigned &x) const {
+ if (x.isZero()) throw "BigUnsigned::operator %: division by zero";
+ BigUnsigned q, r;
+ r = *this;
+ r.divideWithRemainder(x, q);
+ return r;
+}
+inline BigUnsigned BigUnsigned::operator &(const BigUnsigned &x) const {
+ BigUnsigned ans;
+ ans.bitAnd(*this, x);
+ return ans;
+}
+inline BigUnsigned BigUnsigned::operator |(const BigUnsigned &x) const {
+ BigUnsigned ans;
+ ans.bitOr(*this, x);
+ return ans;
+}
+inline BigUnsigned BigUnsigned::operator ^(const BigUnsigned &x) const {
+ BigUnsigned ans;
+ ans.bitXor(*this, x);
+ return ans;
+}
+inline BigUnsigned BigUnsigned::operator <<(int b) const {
+ BigUnsigned ans;
+ ans.bitShiftLeft(*this, b);
+ return ans;
+}
+inline BigUnsigned BigUnsigned::operator >>(int b) const {
+ BigUnsigned ans;
+ ans.bitShiftRight(*this, b);
+ return ans;
+}
+
+inline void BigUnsigned::operator +=(const BigUnsigned &x) {
+ add(*this, x);
+}
+inline void BigUnsigned::operator -=(const BigUnsigned &x) {
+ subtract(*this, x);
+}
+inline void BigUnsigned::operator *=(const BigUnsigned &x) {
+ multiply(*this, x);
+}
+inline void BigUnsigned::operator /=(const BigUnsigned &x) {
+ if (x.isZero()) throw "BigUnsigned::operator /=: division by zero";
+ /* The following technique is slightly faster than copying *this first
+ * when x is large. */
+ BigUnsigned q;
+ divideWithRemainder(x, q);
+ // *this contains the remainder, but we overwrite it with the quotient.
+ *this = q;
+}
+inline void BigUnsigned::operator %=(const BigUnsigned &x) {
+ if (x.isZero()) throw "BigUnsigned::operator %=: division by zero";
+ BigUnsigned q;
+ // Mods *this by x. Don't care about quotient left in q.
+ divideWithRemainder(x, q);
+}
+inline void BigUnsigned::operator &=(const BigUnsigned &x) {
+ bitAnd(*this, x);
+}
+inline void BigUnsigned::operator |=(const BigUnsigned &x) {
+ bitOr(*this, x);
+}
+inline void BigUnsigned::operator ^=(const BigUnsigned &x) {
+ bitXor(*this, x);
+}
+inline void BigUnsigned::operator <<=(int b) {
+ bitShiftLeft(*this, b);
+}
+inline void BigUnsigned::operator >>=(int b) {
+ bitShiftRight(*this, b);
+}
+
+/* Templates for conversions of BigUnsigned to and from primitive integers.
+ * BigInteger.cc needs to instantiate convertToPrimitive, and the uses in
+ * BigUnsigned.cc didn't do the trick; I think g++ inlined convertToPrimitive
+ * instead of generating linkable instantiations. So for consistency, I put
+ * all the templates here. */
+
+// CONSTRUCTION FROM PRIMITIVE INTEGERS
+
+/* Initialize this BigUnsigned from the given primitive integer. The same
+ * pattern works for all primitive integer types, so I put it into a template to
+ * reduce code duplication. (Don't worry: this is protected and we instantiate
+ * it only with primitive integer types.) Type X could be signed, but x is
+ * known to be nonnegative. */
+template <class X>
+void BigUnsigned::initFromPrimitive(X x) {
+ if (x == 0)
+ ; // NumberlikeArray already initialized us to zero.
+ else {
+ // Create a single block. blk is NULL; no need to delete it.
+ cap = 1;
+ blk = new Blk[1];
+ len = 1;
+ blk[0] = Blk(x);
+ }
+}
+
+/* Ditto, but first check that x is nonnegative. I could have put the check in
+ * initFromPrimitive and let the compiler optimize it out for unsigned-type
+ * instantiations, but I wanted to avoid the warning stupidly issued by g++ for
+ * a condition that is constant in *any* instantiation, even if not in all. */
+template <class X>
+void BigUnsigned::initFromSignedPrimitive(X x) {
+ if (x < 0)
+ throw "BigUnsigned constructor: "
+ "Cannot construct a BigUnsigned from a negative number";
+ else
+ initFromPrimitive(x);
+}
+
+// CONVERSION TO PRIMITIVE INTEGERS
+
+/* Template with the same idea as initFromPrimitive. This might be slightly
+ * slower than the previous version with the masks, but it's much shorter and
+ * clearer, which is the library's stated goal. */
+template <class X>
+X BigUnsigned::convertToPrimitive() const {
+ if (len == 0)
+ // The number is zero; return zero.
+ return 0;
+ else if (len == 1) {
+ // The single block might fit in an X. Try the conversion.
+ X x = X(blk[0]);
+ // Make sure the result accurately represents the block.
+ if (Blk(x) == blk[0])
+ // Successful conversion.
+ return x;
+ // Otherwise fall through.
+ }
+ throw "BigUnsigned::to<Primitive>: "
+ "Value is too big to fit in the requested type";
+}
+
+/* Wrap the above in an x >= 0 test to make sure we got a nonnegative result,
+ * not a negative one that happened to convert back into the correct nonnegative
+ * one. (E.g., catch incorrect conversion of 2^31 to the long -2^31.) Again,
+ * separated to avoid a g++ warning. */
+template <class X>
+X BigUnsigned::convertToSignedPrimitive() const {
+ X x = convertToPrimitive<X>();
+ if (x >= 0)
+ return x;
+ else
+ throw "BigUnsigned::to(Primitive): "
+ "Value is too big to fit in the requested type";
+}
+
+#endif
--- /dev/null
+#include "BigUnsignedInABase.hh"
+
+BigUnsignedInABase::BigUnsignedInABase(const Digit *d, Index l, Base base)
+ : NumberlikeArray<Digit>(d, l), base(base) {
+ // Check the base
+ if (base < 2)
+ throw "BigUnsignedInABase::BigUnsignedInABase(const Digit *, Index, Base): The base must be at least 2";
+
+ // Validate the digits.
+ for (Index i = 0; i < l; i++)
+ if (blk[i] >= base)
+ throw "BigUnsignedInABase::BigUnsignedInABase(const Digit *, Index, Base): A digit is too large for the specified base";
+
+ // Eliminate any leading zeros we may have been passed.
+ zapLeadingZeros();
+}
+
+namespace {
+ unsigned int bitLen(unsigned int x) {
+ unsigned int len = 0;
+ while (x > 0) {
+ x >>= 1;
+ len++;
+ }
+ return len;
+ }
+ unsigned int ceilingDiv(unsigned int a, unsigned int b) {
+ return (a + b - 1) / b;
+ }
+}
+
+BigUnsignedInABase::BigUnsignedInABase(const BigUnsigned &x, Base base) {
+ // Check the base
+ if (base < 2)
+ throw "BigUnsignedInABase(BigUnsigned, Base): The base must be at least 2";
+ this->base = base;
+
+ // Get an upper bound on how much space we need
+ int maxBitLenOfX = x.getLength() * BigUnsigned::N;
+ int minBitsPerDigit = bitLen(base) - 1;
+ int maxDigitLenOfX = ceilingDiv(maxBitLenOfX, minBitsPerDigit);
+ len = maxDigitLenOfX; // Another change to comply with `staying in bounds'.
+ allocate(len); // Get the space
+
+ BigUnsigned x2(x), buBase(base);
+ Index digitNum = 0;
+
+ while (!x2.isZero()) {
+ // Get last digit. This is like `lastDigit = x2 % buBase, x2 /= buBase'.
+ BigUnsigned lastDigit(x2);
+ lastDigit.divideWithRemainder(buBase, x2);
+ // Save the digit.
+ blk[digitNum] = lastDigit.toUnsignedShort();
+ // Move on. We can't run out of room: we figured it out above.
+ digitNum++;
+ }
+
+ // Save the actual length.
+ len = digitNum;
+}
+
+BigUnsignedInABase::operator BigUnsigned() const {
+ BigUnsigned ans(0), buBase(base), temp;
+ Index digitNum = len;
+ while (digitNum > 0) {
+ digitNum--;
+ temp.multiply(ans, buBase);
+ ans.add(temp, BigUnsigned(blk[digitNum]));
+ }
+ return ans;
+}
+
+BigUnsignedInABase::BigUnsignedInABase(const std::string &s, Base base) {
+ // Check the base.
+ if (base > 36)
+ throw "BigUnsignedInABase(std::string, Base): The default string conversion routines use the symbol set 0-9, A-Z and therefore support only up to base 36. You tried a conversion with a base over 36; write your own string conversion routine.";
+ // Save the base.
+ // This pattern is seldom seen in C++, but the analogous ``this.'' is common in Java.
+ this->base = base;
+
+ // `s.length()' is a `size_t', while `len' is a `NumberlikeArray::Index',
+ // also known as an `unsigned int'. Some compilers warn without this cast.
+ len = Index(s.length());
+ allocate(len);
+
+ Index digitNum, symbolNumInString;
+ for (digitNum = 0; digitNum < len; digitNum++) {
+ symbolNumInString = len - 1 - digitNum;
+ char theSymbol = s[symbolNumInString];
+ if (theSymbol >= '0' && theSymbol <= '9')
+ blk[digitNum] = theSymbol - '0';
+ else if (theSymbol >= 'A' && theSymbol <= 'Z')
+ blk[digitNum] = theSymbol - 'A' + 10;
+ else if (theSymbol >= 'a' && theSymbol <= 'z')
+ blk[digitNum] = theSymbol - 'a' + 10;
+ else
+ throw "BigUnsignedInABase(std::string, Base): Bad symbol in input. Only 0-9, A-Z, a-z are accepted.";
+
+ if (blk[digitNum] >= base)
+ throw "BigUnsignedInABase::BigUnsignedInABase(const Digit *, Index, Base): A digit is too large for the specified base";
+ }
+ zapLeadingZeros();
+}
+
+BigUnsignedInABase::operator std::string() const {
+ if (base > 36)
+ throw "BigUnsignedInABase ==> std::string: The default string conversion routines use the symbol set 0-9, A-Z and therefore support only up to base 36. You tried a conversion with a base over 36; write your own string conversion routine.";
+ if (len == 0)
+ return std::string("0");
+ // Some compilers don't have push_back, so use a char * buffer instead.
+ char *s = new char[len + 1];
+ s[len] = '\0';
+ Index digitNum, symbolNumInString;
+ for (symbolNumInString = 0; symbolNumInString < len; symbolNumInString++) {
+ digitNum = len - 1 - symbolNumInString;
+ Digit theDigit = blk[digitNum];
+ if (theDigit < 10)
+ s[symbolNumInString] = char('0' + theDigit);
+ else
+ s[symbolNumInString] = char('A' + theDigit - 10);
+ }
+ std::string s2(s);
+ delete [] s;
+ return s2;
+}
--- /dev/null
+#ifndef BIGUNSIGNEDINABASE_H
+#define BIGUNSIGNEDINABASE_H
+
+#include "NumberlikeArray.hh"
+#include "BigUnsigned.hh"
+#include <string>
+
+/*
+ * A BigUnsignedInABase object represents a nonnegative integer of size limited
+ * only by available memory, represented in a user-specified base that can fit
+ * in an `unsigned short' (most can, and this saves memory).
+ *
+ * BigUnsignedInABase is intended as an intermediary class with little
+ * functionality of its own. BigUnsignedInABase objects can be constructed
+ * from, and converted to, BigUnsigneds (requiring multiplication, mods, etc.)
+ * and `std::string's (by switching digit values for appropriate characters).
+ *
+ * BigUnsignedInABase is similar to BigUnsigned. Note the following:
+ *
+ * (1) They represent the number in exactly the same way, except that
+ * BigUnsignedInABase uses ``digits'' (or Digit) where BigUnsigned uses
+ * ``blocks'' (or Blk).
+ *
+ * (2) Both use the management features of NumberlikeArray. (In fact, my desire
+ * to add a BigUnsignedInABase class without duplicating a lot of code led me to
+ * introduce NumberlikeArray.)
+ *
+ * (3) The only arithmetic operation supported by BigUnsignedInABase is an
+ * equality test. Use BigUnsigned for arithmetic.
+ */
+
+class BigUnsignedInABase : protected NumberlikeArray<unsigned short> {
+
+public:
+ // The digits of a BigUnsignedInABase are unsigned shorts.
+ typedef unsigned short Digit;
+ // That's also the type of a base.
+ typedef Digit Base;
+
+protected:
+ // The base in which this BigUnsignedInABase is expressed
+ Base base;
+
+ // Creates a BigUnsignedInABase with a capacity; for internal use.
+ BigUnsignedInABase(int, Index c) : NumberlikeArray<Digit>(0, c) {}
+
+ // Decreases len to eliminate any leading zero digits.
+ void zapLeadingZeros() {
+ while (len > 0 && blk[len - 1] == 0)
+ len--;
+ }
+
+public:
+ // Constructs zero in base 2.
+ BigUnsignedInABase() : NumberlikeArray<Digit>(), base(2) {}
+
+ // Copy constructor
+ BigUnsignedInABase(const BigUnsignedInABase &x) : NumberlikeArray<Digit>(x), base(x.base) {}
+
+ // Assignment operator
+ void operator =(const BigUnsignedInABase &x) {
+ NumberlikeArray<Digit>::operator =(x);
+ base = x.base;
+ }
+
+ // Constructor that copies from a given array of digits.
+ BigUnsignedInABase(const Digit *d, Index l, Base base);
+
+ // Destructor. NumberlikeArray does the delete for us.
+ ~BigUnsignedInABase() {}
+
+ // LINKS TO BIGUNSIGNED
+ BigUnsignedInABase(const BigUnsigned &x, Base base);
+ operator BigUnsigned() const;
+
+ /* LINKS TO STRINGS
+ *
+ * These use the symbols ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'' to
+ * represent digits of 0 through 35. When parsing strings, lowercase is
+ * also accepted.
+ *
+ * All string representations are big-endian (big-place-value digits
+ * first). (Computer scientists have adopted zero-based counting; why
+ * can't they tolerate little-endian numbers?)
+ *
+ * No string representation has a ``base indicator'' like ``0x''.
+ *
+ * An exception is made for zero: it is converted to ``0'' and not the
+ * empty string.
+ *
+ * If you want different conventions, write your own routines to go
+ * between BigUnsignedInABase and strings. It's not hard.
+ */
+ operator std::string() const;
+ BigUnsignedInABase(const std::string &s, Base base);
+
+public:
+
+ // ACCESSORS
+ Base getBase() const { return base; }
+
+ // Expose these from NumberlikeArray directly.
+ using NumberlikeArray<Digit>::getCapacity;
+ using NumberlikeArray<Digit>::getLength;
+
+ /* Returns the requested digit, or 0 if it is beyond the length (as if
+ * the number had 0s infinitely to the left). */
+ Digit getDigit(Index i) const { return i >= len ? 0 : blk[i]; }
+
+ // The number is zero if and only if the canonical length is zero.
+ bool isZero() const { return NumberlikeArray<Digit>::isEmpty(); }
+
+ /* Equality test. For the purposes of this test, two BigUnsignedInABase
+ * values must have the same base to be equal. */
+ bool operator ==(const BigUnsignedInABase &x) const {
+ return base == x.base && NumberlikeArray<Digit>::operator ==(x);
+ }
+ bool operator !=(const BigUnsignedInABase &x) const { return !operator ==(x); }
+
+};
+
+#endif
--- /dev/null
+ Change Log
+
+These entries tell you what was added, fixed, or improved in each version as
+compared to the previous one. In case you haven't noticed, a version number
+roughly corresponds to the release date of that version in `YYYY.MM.DD[.N]'
+format, where `.N' goes `.2', `.3', etc. if there are multiple versions on the
+same day. The topmost version listed is the one you have.
+
+2010.04.30
+----------
+- Strengthen the advice about build/IDE configuration in the README.
+
+2009.05.03
+----------
+- BigUnsigned::{get,set}Bit: Change two remaining `1 <<' to `Blk(1) <<' to work
+ on systems where sizeof(unsigned int) != sizeof(Blk). Bug reported by Brad
+ Spencer.
+- dataToBigInteger: Change a `delete' to `delete []' to avoid leaking memory.
+ Bug reported by Nicolás Carrasco.
+
+2009.03.26
+----------
+- BigUnsignedInABase(std::string) Reject digits too big for the base.
+ Bug reported by Niakam Kazemi.
+
+2008.07.20
+----------
+Dennis Yew pointed out serious problems with ambiguities and unwanted
+conversions when mixing BigInteger/BigUnsigned and primitive integers. To fix
+these, I removed the implicit conversions from BigInteger/BigUnsigned to
+primitive integers and from BigInteger to BigUnsigned. Removing the
+BigInteger-to-BigUnsigned conversion required changing BigInteger to have a
+BigUnsigned field instead of inheriting from it; this was a complex task but
+ultimately gave a saner design. At the same time, I went through the entire
+codebase, making the formatting and comments prettier and reworking anything I
+thought was unclear. I also added a testsuite (currently for 32-bit systems
+only); it doesn't yet cover the entire library but should help to ensure that
+things work the way they should.
+
+A number of changes from version 2007.07.07 break compatibility with existing
+code that uses the library, but updating that code should be pretty easy:
+- BigInteger can no longer be implicitly converted to BigUnsigned. Use
+ getMagnitude() instead.
+- BigUnsigned and BigInteger can no longer be implicitly converted to primitive
+ integers. Use the toInt() family of functions instead.
+- The easy* functions have been renamed to more mature names:
+ bigUnsignedToString, bigIntegerToString, stringToBigUnsigned,
+ stringToBigInteger, dataToBigInteger.
+- BigInteger no longer supports bitwise operations. Get the magnitude with
+ getMagnitude() and operate on that instead.
+- The old {BigUnsigned,BigInteger}::{divide,modulo} copy-less options have been
+ removed. Use divideWithRemainder instead.
+- Added a base argument to BigUnsignedInABase's digit-array constructor. I
+ ope no one used that constructor in its broken state anyway.
+
+Other notable changes:
+- Added BigUnsigned functions setBlock, bitLength, getBit, setBit.
+- The bit-shifting operations now support negative shift amounts, which shift in
+ the other direction.
+- Added some big-integer algorithms in BigIntegerAlgorithms.hh: gcd,
+ extendedEuclidean, modinv, modexp.
+
+2007.07.07
+----------
+Update the "Running the sample program produces this output:" comment in
+sample.cc for the bitwise operators.
+
+2007.06.14
+----------
+- Implement << and >> for BigUnsigned in response to email from Marco Schulze.
+- Fix name: DOTR_ALIASED -> DTRT_ALIASED.
+- Demonstrate all bitwise operators (&, |, ^, <<, >>) in sample.cc.
+
+2007.02.16
+----------
+Boris Dessy pointed out that the library threw an exception on "a *= a", so I changed all the put-here operations to handle aliased calls correctly using a temporary copy instead of throwing exceptions.
+
+2006.08.14
+----------
+In BigUnsigned::bitXor, change allocate(b2->len) to allocate(a2->len): we should allocate enough space for the longer number, not the shorter one! Thanks to Sriram Sankararaman for pointing this out.
+
+2006.05.03
+----------
+I ran the sample program using valgrind and discovered a `delete s' that should be `delete [] s' and a `len++' before an `allocateAndCopy(len)' that should have been after an `allocateAndCopy(len + 1)'. I fixed both. Yay for valgrind!
+
+2006.05.01
+----------
+I fixed incorrect results reported by Mohand Mezmaz and related memory corruption on platforms where Blk is bigger than int. I replaced (1 << x) with (Blk(1) << x) in two places in BigUnsigned.cc.
+
+2006.04.24
+----------
+Two bug fixes: BigUnsigned "++x" no longer segfaults when x grows in length, and BigUnsigned == and != are now redeclared so as to be usable. I redid the Makefile: I removed the *.tag mechanism and hard-coded the library's header dependencies, I added comments, and I made the Makefile more useful for building one's own programs instead of just the sample.
+
+2006.02.26
+----------
+A few tweaks in preparation for a group to distribute the library. The project Web site has moved; I updated the references. I fixed a typo and added a missing function in NumberlikeArray.hh. I'm using Eclipse now, so you get Eclipse project files.
+
+2005.03.30
+----------
+Sam Larkin found a bug in `BigInteger::subtract'; I fixed it.
+
+2005.01.18
+----------
+I fixed some problems with `easyDataToBI'. Due to some multiply declared variables, this function would not compile. However, it is a template function, so the compiler parses it and doesn't compile the parsed representation until something uses the function; this is how I missed the problems. I also removed debugging output from this function.
+
+2005.01.17
+----------
+A fix to some out-of-bounds accesses reported by Milan Tomic (see the comment under `BigUnsigned::divideWithRemainder'). `BigUnsigned::multiply' and `BigUnsigned::divideWithRemainder' implementations neatened up a bit with the help of a function `getShiftedBlock'. I (finally!) introduced a constant `BigUnsigned::N', the number of bits in a `BigUnsigned::Blk', which varies depending on machine word size. In both code and comments, it replaces the much clunkier `8*sizeof(Blk)'. Numerous other small changes. There's a new conversion routine `easyDataToBI' that will convert almost any format of binary data to a `BigInteger'.
+
+I have inserted a significant number of new comments. Most explain unobvious aspects of the code.
+
+2005.01.06
+----------
+Some changes to the way zero-length arrays are handled by `NumberlikeArray', which fixed a memory leak reported by Milan Tomic.
+
+2004.12.24.2
+------------
+I tied down a couple of loose ends involving division/modulo. I added an explanation of put-here vs. overloaded operators in the sample program; this has confused too many people. Miscellaneous other improvements.
+
+I believe that, at this point, the Big Integer Library makes no assumptions about the word size of the machine it is using. `BigUnsigned::Blk' is always an `unsigned long', whatever that may be, and its size is computed with `sizeof' when necessary. However, just in case, I would be interested to have someone test the library on a non-32-bit machine to see if it works.
+
+2004.12.24
+----------
+This is a _major_ upgrade to the library. Among the things that have changed:
+
+I wrote the original version of the library, particularly the four ``classical algorithms'' in `BigUnsigned.cc', using array indexing. Then I rewrote it to use pointers because I thought that would be faster. But recently, I revisited the code in `BigUnsigned.cc' and found that I could not begin to understand what it was doing.
+
+I have decided that the drawbacks of pointers, increased coding difficulty and reduced code readability, far outweigh their speed benefits. Plus, any modern optimizing compiler should produce fast code either way. Therefore, I rewrote the library to use array indexing again. (Thank goodness for regular-expression find-and-replace. It saved me a lot of time.)
+
+The put-here operations `divide' and `modulo' of each of `BigUnsigned' and `BigInteger' have been supplanted by a single operation `divideWithRemainder'. Read the profuse comments for more information on its exact behavior.
+
+There is a new class `BigUnsignedInABase' that is like `BigUnsigned' but uses a user-specified, small base instead of `256 ^ sizeof(unsigned long)'. Much of the code common to the two has been factored out into `NumberlikeArray'.
+
+`BigUnsignedInABase' facilitates conversion between `BigUnsigned's and digit-by-digit string representations using `std::string'. Convenience routines to do this conversion are in `BigIntegerUtils.hh'. `iostream' compatibility has been improved.
+
+I would like to thank Chris Morbitzer for the e-mail message that catalyzed this major upgrade. He wanted a way to convert a string to a BigInteger. One thing just led to another, roughly in reverse order from how they are listed here.
+
+2004.1216
+---------
+Brad Spencer pointed out a memory leak in `BigUnsigned::divide'. It is fixed in the December 16, 2004 version.
+
+2004.1205
+---------
+After months of inactivity, I fixed a bug in the `BigInteger' division routine; thanks to David Allen for reporting the bug. I also added simple routines for decimal output to `std::ostream's, and there is a demo that prints out powers of 3.
+
+~~~~
--- /dev/null
+# Mention default target.
+all:
+
+# Implicit rule to compile C++ files. Modify to your taste.
+%.o: %.cc
+ g++ -c -O2 -Wall -Wextra -pedantic $<
+
+# Components of the library.
+library-objects = \
+ BigUnsigned.o \
+ BigInteger.o \
+ BigIntegerAlgorithms.o \
+ BigUnsignedInABase.o \
+ BigIntegerUtils.o \
+
+library-headers = \
+ NumberlikeArray.hh \
+ BigUnsigned.hh \
+ BigInteger.hh \
+ BigIntegerAlgorithms.hh \
+ BigUnsignedInABase.hh \
+ BigIntegerLibrary.hh \
+
+# To ``make the library'', make all its objects using the implicit rule.
+library: $(library-objects)
+
+# Conservatively assume that all the objects depend on all the headers.
+$(library-objects): $(library-headers)
+
+# TESTSUITE (NOTE: Currently expects a 32-bit system)
+# Compiling the testsuite.
+testsuite.o: $(library-headers)
+testsuite: testsuite.o $(library-objects)
+ g++ $^ -o $@
+# Extract the expected output from the testsuite source.
+testsuite.expected: testsuite.cc
+ nl -ba -p -s: $< | sed -nre 's,^ +([0-9]+):.*//([^ ]),Line \1: \2,p' >$@
+# Run the testsuite.
+.PHONY: test
+test: testsuite testsuite.expected
+ ./run-testsuite
+testsuite-cleanfiles = \
+ testsuite.o testsuite testsuite.expected \
+ testsuite.out testsuite.err
+
+# The rules below build a program that uses the library. They are preset to
+# build ``sample'' from ``sample.cc''. You can change the name(s) of the
+# source file(s) and program file to build your own program, or you can write
+# your own Makefile.
+
+# Components of the program.
+program = sample
+program-objects = sample.o
+
+# Conservatively assume all the program source files depend on all the library
+# headers. You can change this if it is not the case.
+$(program-objects) : $(library-headers)
+
+# How to link the program. The implicit rule covers individual objects.
+$(program) : $(program-objects) $(library-objects)
+ g++ $^ -o $@
+
+# Delete all generated files we know about.
+clean :
+ rm -f $(library-objects) $(testsuite-cleanfiles) $(program-objects) $(program)
+
+# I removed the *.tag dependency tracking system because it had few advantages
+# over manually entering all the dependencies. If there were a portable,
+# reliable dependency tracking system, I'd use it, but I know of no such;
+# cons and depcomp are almost good enough.
+
+# Come back and define default target.
+all : library $(program)
--- /dev/null
+#ifndef NUMBERLIKEARRAY_H
+#define NUMBERLIKEARRAY_H
+
+// Make sure we have NULL.
+#ifndef NULL
+#define NULL 0
+#endif
+
+/* A NumberlikeArray<Blk> object holds a heap-allocated array of Blk with a
+ * length and a capacity and provides basic memory management features.
+ * BigUnsigned and BigUnsignedInABase both subclass it.
+ *
+ * NumberlikeArray provides no information hiding. Subclasses should use
+ * nonpublic inheritance and manually expose members as desired using
+ * declarations like this:
+ *
+ * public:
+ * NumberlikeArray< the-type-argument >::getLength;
+ */
+template <class Blk>
+class NumberlikeArray {
+public:
+
+ // Type for the index of a block in the array
+ typedef unsigned int Index;
+ // The number of bits in a block, defined below.
+ static const unsigned int N;
+
+ // The current allocated capacity of this NumberlikeArray (in blocks)
+ Index cap;
+ // The actual length of the value stored in this NumberlikeArray (in blocks)
+ Index len;
+ // Heap-allocated array of the blocks (can be NULL if len == 0)
+ Blk *blk;
+
+ // Constructs a ``zero'' NumberlikeArray with the given capacity.
+ NumberlikeArray(Index c) : cap(c), len(0) {
+ blk = (cap > 0) ? (new Blk[cap]) : NULL;
+ }
+
+ /* Constructs a zero NumberlikeArray without allocating a backing array.
+ * A subclass that doesn't know the needed capacity at initialization
+ * time can use this constructor and then overwrite blk without first
+ * deleting it. */
+ NumberlikeArray() : cap(0), len(0) {
+ blk = NULL;
+ }
+
+ // Destructor. Note that `delete NULL' is a no-op.
+ ~NumberlikeArray() {
+ delete [] blk;
+ }
+
+ /* Ensures that the array has at least the requested capacity; may
+ * destroy the contents. */
+ void allocate(Index c);
+
+ /* Ensures that the array has at least the requested capacity; does not
+ * destroy the contents. */
+ void allocateAndCopy(Index c);
+
+ // Copy constructor
+ NumberlikeArray(const NumberlikeArray<Blk> &x);
+
+ // Assignment operator
+ void operator=(const NumberlikeArray<Blk> &x);
+
+ // Constructor that copies from a given array of blocks
+ NumberlikeArray(const Blk *b, Index blen);
+
+ // ACCESSORS
+ Index getCapacity() const { return cap; }
+ Index getLength() const { return len; }
+ Blk getBlock(Index i) const { return blk[i]; }
+ bool isEmpty() const { return len == 0; }
+
+ /* Equality comparison: checks if both objects have the same length and
+ * equal (==) array elements to that length. Subclasses may wish to
+ * override. */
+ bool operator ==(const NumberlikeArray<Blk> &x) const;
+
+ bool operator !=(const NumberlikeArray<Blk> &x) const {
+ return !operator ==(x);
+ }
+};
+
+/* BEGIN TEMPLATE DEFINITIONS. They are present here so that source files that
+ * include this header file can generate the necessary real definitions. */
+
+template <class Blk>
+const unsigned int NumberlikeArray<Blk>::N = 8 * sizeof(Blk);
+
+template <class Blk>
+void NumberlikeArray<Blk>::allocate(Index c) {
+ // If the requested capacity is more than the current capacity...
+ if (c > cap) {
+ // Delete the old number array
+ delete [] blk;
+ // Allocate the new array
+ cap = c;
+ blk = new Blk[cap];
+ }
+}
+
+template <class Blk>
+void NumberlikeArray<Blk>::allocateAndCopy(Index c) {
+ // If the requested capacity is more than the current capacity...
+ if (c > cap) {
+ Blk *oldBlk = blk;
+ // Allocate the new number array
+ cap = c;
+ blk = new Blk[cap];
+ // Copy number blocks
+ Index i;
+ for (i = 0; i < len; i++)
+ blk[i] = oldBlk[i];
+ // Delete the old array
+ delete [] oldBlk;
+ }
+}
+
+template <class Blk>
+NumberlikeArray<Blk>::NumberlikeArray(const NumberlikeArray<Blk> &x)
+ : len(x.len) {
+ // Create array
+ cap = len;
+ blk = new Blk[cap];
+ // Copy blocks
+ Index i;
+ for (i = 0; i < len; i++)
+ blk[i] = x.blk[i];
+}
+
+template <class Blk>
+void NumberlikeArray<Blk>::operator=(const NumberlikeArray<Blk> &x) {
+ /* Calls like a = a have no effect; catch them before the aliasing
+ * causes a problem */
+ if (this == &x)
+ return;
+ // Copy length
+ len = x.len;
+ // Expand array if necessary
+ allocate(len);
+ // Copy number blocks
+ Index i;
+ for (i = 0; i < len; i++)
+ blk[i] = x.blk[i];
+}
+
+template <class Blk>
+NumberlikeArray<Blk>::NumberlikeArray(const Blk *b, Index blen)
+ : cap(blen), len(blen) {
+ // Create array
+ blk = new Blk[cap];
+ // Copy blocks
+ Index i;
+ for (i = 0; i < len; i++)
+ blk[i] = b[i];
+}
+
+template <class Blk>
+bool NumberlikeArray<Blk>::operator ==(const NumberlikeArray<Blk> &x) const {
+ if (len != x.len)
+ // Definitely unequal.
+ return false;
+ else {
+ // Compare corresponding blocks one by one.
+ Index i;
+ for (i = 0; i < len; i++)
+ if (blk[i] != x.blk[i])
+ return false;
+ // No blocks differed, so the objects are equal.
+ return true;
+ }
+}
+
+#endif
--- /dev/null
+
+Note by Clifford Wolf:
+This version of bigint was downloaded at 2012-08-29 from
+https://mattmccutchen.net/bigint/bigint-2010.04.30.tar.bz2
+
+Some minor changes were made to the source code (e.g. "using"
+was added to access declarations to prohibit compiler warnings).
+
+
+==============================================================================
+
+ C++ Big Integer Library
+ (see ChangeLog for version)
+
+ http://mattmccutchen.net/bigint/
+
+ Written and maintained by Matt McCutchen <matt@mattmccutchen.net>
+
+You can use this library in a C++ program to do arithmetic on integers of size
+limited only by your computer's memory. The library provides BigUnsigned and
+BigInteger classes that represent nonnegative integers and signed integers,
+respectively. Most of the C++ arithmetic operators are overloaded for these
+classes, so big-integer calculations are as easy as:
+
+ #include "BigIntegerLibrary.hh"
+
+ BigInteger a = 65536;
+ cout << (a * a * a * a * a * a * a * a);
+
+ (prints 340282366920938463463374607431768211456)
+
+The code in `sample.cc' demonstrates the most important features of the library.
+To get started quickly, read the code and explanations in that file and run it.
+If you want more detail or a feature not shown in `sample.cc', consult the
+consult the actual header and source files, which are thoroughly commented.
+
+This library emphasizes ease of use and clarity of implementation over speed;
+some users will prefer GMP (http://swox.com/gmp/), which is faster. The code is
+intended to be reasonably portable across computers and modern C++ compilers; in
+particular, it uses whatever word size the computer provides (32-bit, 64-bit, or
+otherwise).
+
+Compiling programs that use the library
+---------------------------------------
+The library consists of a folder full of C++ header files (`.hh') and source
+files (`.cc'). Your own programs should `#include' the necessary header files
+and link with the source files. A makefile that builds the sample program
+(`sample.cc') is included; you can adapt it to replace the sample with your own
+program.
+
+Alternatively, you can use your own build system or IDE. In that case, you must
+put the library header files where the compiler will find them and arrange to
+have your program linked with the library source files; otherwise, you will get
+errors about missing header files or "undefined references". To learn how to do
+this, consult the documentation for the build system or IDE; don't bother asking
+me. Adding all the library files to your project will work in many IDEs but may
+not be the most desirable approach.
+
+Resources
+---------
+The library's Web site (above) provides links to released versions, the current
+development version, and a mailing list for release announcements, questions,
+bug reports, and other discussion of the library. I would be delighted to hear
+from you if you like this library and/or find a good use for it.
+
+Bugs and enhancements
+---------------------
+The library has been tested by me and others but is by no means bug-free. If
+you find a bug, please report it, whether it comes in the form of compiling
+trouble, a mathematically inaccurate result, or a memory-management blooper
+(since I use Java, these are altogether too common in my C++). I generally fix
+all reported bugs. You are also welcome to request enhancements, but I am
+unlikely to do substantial amounts of work on enhancements at this point.
+
+Legal
+-----
+I, Matt McCutchen, the sole author of the original Big Integer Library, waive my
+copyright to it, placing it in the public domain. The library comes with
+absolutely no warranty.
+
+~~~~
--- /dev/null
+#!/bin/bash
+
+bad=
+
+# If you encounter the following problem with Valgrind like I did:
+# https://bugzilla.redhat.com/show_bug.cgi?id=455644
+# you can pass the environment variable NO_VALGRIND=1 to run the testsuite
+# without it.
+if [ "$NO_VALGRIND" ]; then
+ cmd=(./testsuite)
+else
+ cmd=(valgrind --error-exitcode=1 --leak-check=full ./testsuite)
+fi
+
+set -o pipefail
+# Stdout goes directly to testsuite.out; stderr goes down the pipe.
+if ! "${cmd[@]}" 2>&1 >testsuite.out | tee testsuite.err; then
+ echo >&2 'Memory errors!'
+ bad=1
+fi
+
+if grep 'LEAK SUMMARY' testsuite.err >/dev/null; then
+ echo >&2 'Memory leaks!'
+ bad=1
+fi
+
+if ! diff -u testsuite.expected testsuite.out; then
+ echo >&2 'Output is incorrect!'
+ bad=1
+fi
+
+if [ $bad ]; then
+ echo >&2 'Test suite failed!'
+ exit 1
+else
+ echo 'Test suite passed.'
+fi
--- /dev/null
+// Sample program demonstrating the use of the Big Integer Library.
+
+// Standard libraries
+#include <string>
+#include <iostream>
+
+// `BigIntegerLibrary.hh' includes all of the library headers.
+#include "BigIntegerLibrary.hh"
+
+int main() {
+ /* The library throws `const char *' error messages when things go
+ * wrong. It's a good idea to catch them using a `try' block like this
+ * one. Your C++ compiler might need a command-line option to compile
+ * code that uses exceptions. */
+ try {
+ BigInteger a; // a is 0
+ int b = 535;
+
+ /* Any primitive integer can be converted implicitly to a
+ * BigInteger. */
+ a = b;
+
+ /* The reverse conversion requires a method call (implicit
+ * conversions were previously supported but caused trouble).
+ * If a were too big for an int, the library would throw an
+ * exception. */
+ b = a.toInt();
+
+ BigInteger c(a); // Copy a BigInteger.
+
+ // The int literal is converted to a BigInteger.
+ BigInteger d(-314159265);
+
+ /* This won't compile (at least on 32-bit machines) because the
+ * number is too big to be a primitive integer literal, and
+ * there's no such thing as a BigInteger literal. */
+ //BigInteger e(3141592653589793238462643383279);
+
+ // Instead you can convert the number from a string.
+ std::string s("3141592653589793238462643383279");
+ BigInteger f = stringToBigInteger(s);
+
+ // You can convert the other way too.
+ std::string s2 = bigIntegerToString(f);
+
+ // f is implicitly stringified and sent to std::cout.
+ std::cout << f << std::endl;
+
+ /* Let's do some math! The library overloads most of the
+ * mathematical operators (including assignment operators) to
+ * work on BigIntegers. There are also ``copy-less''
+ * operations; see `BigUnsigned.hh' for details. */
+
+ // Arithmetic operators
+ BigInteger g(314159), h(265);
+ std::cout << (g + h) << '\n'
+ << (g - h) << '\n'
+ << (g * h) << '\n'
+ << (g / h) << '\n'
+ << (g % h) << std::endl;
+
+ // Bitwise operators
+ BigUnsigned i(0xFF0000FF), j(0x0000FFFF);
+ // The library's << operator recognizes base flags.
+ std::cout.flags(std::ios::hex | std::ios::showbase);
+ std::cout << (i & j) << '\n'
+ << (i | j) << '\n'
+ << (i ^ j) << '\n'
+ // Shift distances are ordinary unsigned ints.
+ << (j << 21) << '\n'
+ << (j >> 10) << '\n';
+ std::cout.flags(std::ios::dec);
+
+ // Let's do some heavy lifting and calculate powers of 314.
+ int maxPower = 10;
+ BigUnsigned x(1), big314(314);
+ for (int power = 0; power <= maxPower; power++) {
+ std::cout << "314^" << power << " = " << x << std::endl;
+ x *= big314; // A BigInteger assignment operator
+ }
+
+ // Some big-integer algorithms (albeit on small integers).
+ std::cout << gcd(BigUnsigned(60), 72) << '\n'
+ << modinv(BigUnsigned(7), 11) << '\n'
+ << modexp(BigUnsigned(314), 159, 2653) << std::endl;
+
+ // Add your own code here to experiment with the library.
+ } catch(char const* err) {
+ std::cout << "The library threw an exception:\n"
+ << err << std::endl;
+ }
+
+ return 0;
+}
+
+/*
+The original sample program produces this output:
+
+3141592653589793238462643383279
+314424
+313894
+83252135
+1185
+134
+0xFF
+0xFF00FFFF
+0xFF00FF00
+0x1FFFE00000
+0x3F
+314^0 = 1
+314^1 = 314
+314^2 = 98596
+314^3 = 30959144
+314^4 = 9721171216
+314^5 = 3052447761824
+314^6 = 958468597212736
+314^7 = 300959139524799104
+314^8 = 94501169810786918656
+314^9 = 29673367320587092457984
+314^10 = 9317437338664347031806976
+12
+8
+1931
+
+*/
--- /dev/null
+/* Test suite for the library. First, it ``tests'' that all the constructs it
+ * uses compile successfully. Then, its output to stdout is compared to the
+ * expected output automatically extracted from slash-slash comments below.
+ *
+ * NOTE: For now, the test suite expects a 32-bit system. On others, some tests
+ * may fail, and it may be ineffective at catching bugs. TODO: Remedy this. */
+
+#include "BigIntegerLibrary.hh"
+
+#include <string>
+#include <iostream>
+using namespace std;
+
+// Evaluate expr and print the result or "error" as appropriate.
+#define TEST(expr) do {\
+ cout << "Line " << __LINE__ << ": ";\
+ try {\
+ cout << (expr);\
+ } catch (const char *err) {\
+ cout << "error";\
+ }\
+ cout << endl;\
+} while (0)
+
+const BigUnsigned &check(const BigUnsigned &x) {
+ unsigned int l = x.getLength();
+ if (l != 0 && x.getBlock(l-1) == 0)
+ cout << "check: Unzapped number!" << endl;
+ if (l > x.getCapacity())
+ cout << "check: Capacity inconsistent with length!" << endl;
+ return x;
+}
+
+const BigInteger &check(const BigInteger &x) {
+ if (x.getSign() == 0 && !x.getMagnitude().isZero())
+ cout << "check: Sign should not be zero!" << endl;
+ if (x.getSign() != 0 && x.getMagnitude().isZero())
+ cout << "check: Sign should be zero!" << endl;
+ check(x.getMagnitude());
+ return x;
+}
+
+short pathologicalShort = ~((unsigned short)(~0) >> 1);
+int pathologicalInt = ~((unsigned int)(~0) >> 1);
+long pathologicalLong = ~((unsigned long)(~0) >> 1);
+
+int main() {
+
+try {
+
+BigUnsigned z(0), one(1), ten(10);
+TEST(z); //0
+TEST(1); //1
+TEST(10); //10
+
+// TODO: Comprehensively test the general and special cases of each function.
+
+// === Default constructors ===
+
+TEST(check(BigUnsigned())); //0
+TEST(check(BigInteger())); //0
+
+// === Block-array constructors ===
+
+BigUnsigned::Blk myBlocks[3];
+myBlocks[0] = 3;
+myBlocks[1] = 4;
+myBlocks[2] = 0;
+BigUnsigned bu(myBlocks, 3);
+TEST(check(bu)); //17179869187
+TEST(check(BigInteger(myBlocks, 3))); //17179869187
+TEST(check(BigInteger(bu ))); //17179869187
+
+// For nonzero magnitude, reject zero and invalid signs.
+TEST(check(BigInteger(myBlocks, 3, BigInteger::positive))); //17179869187
+TEST(check(BigInteger(myBlocks, 3, BigInteger::negative))); //-17179869187
+TEST(check(BigInteger(myBlocks, 3, BigInteger::zero ))); //error
+TEST(check(BigInteger(bu, BigInteger::positive))); //17179869187
+TEST(check(BigInteger(bu, BigInteger::negative))); //-17179869187
+TEST(check(BigInteger(bu, BigInteger::zero ))); //error
+
+// For zero magnitude, force the sign to zero without error.
+BigUnsigned::Blk myZeroBlocks[1];
+myZeroBlocks[0] = 0;
+TEST(check(BigInteger(myZeroBlocks, 1, BigInteger::positive))); //0
+TEST(check(BigInteger(myZeroBlocks, 1, BigInteger::negative))); //0
+TEST(check(BigInteger(myZeroBlocks, 1, BigInteger::zero ))); //0
+
+// === BigUnsigned conversion limits ===
+
+TEST(BigUnsigned(0).toUnsignedLong()); //0
+TEST(BigUnsigned(4294967295U).toUnsignedLong()); //4294967295
+TEST(stringToBigUnsigned("4294967296").toUnsignedLong()); //error
+
+TEST(BigUnsigned(0).toLong()); //0
+TEST(BigUnsigned(2147483647).toLong()); //2147483647
+TEST(BigUnsigned(2147483648U).toLong()); //error
+
+// int is the same as long on a 32-bit system
+TEST(BigUnsigned(0).toUnsignedInt()); //0
+TEST(BigUnsigned(4294967295U).toUnsignedInt()); //4294967295
+TEST(stringToBigUnsigned("4294967296").toUnsignedInt()); //error
+
+TEST(BigUnsigned(0).toInt()); //0
+TEST(BigUnsigned(2147483647).toInt()); //2147483647
+TEST(BigUnsigned(2147483648U).toInt()); //error
+
+TEST(BigUnsigned(0).toUnsignedShort()); //0
+TEST(BigUnsigned(65535).toUnsignedShort()); //65535
+TEST(BigUnsigned(65536).toUnsignedShort()); //error
+
+TEST(BigUnsigned(0).toShort()); //0
+TEST(BigUnsigned(32767).toShort()); //32767
+TEST(BigUnsigned(32768).toShort()); //error
+
+// === BigInteger conversion limits ===
+
+TEST(BigInteger(-1).toUnsignedLong()); //error
+TEST(BigInteger(0).toUnsignedLong()); //0
+TEST(BigInteger(4294967295U).toUnsignedLong()); //4294967295
+TEST(stringToBigInteger("4294967296").toUnsignedLong()); //error
+
+TEST(stringToBigInteger("-2147483649").toLong()); //error
+TEST(stringToBigInteger("-2147483648").toLong()); //-2147483648
+TEST(BigInteger(-2147483647).toLong()); //-2147483647
+TEST(BigInteger(0).toLong()); //0
+TEST(BigInteger(2147483647).toLong()); //2147483647
+TEST(BigInteger(2147483648U).toLong()); //error
+
+// int is the same as long on a 32-bit system
+TEST(BigInteger(-1).toUnsignedInt()); //error
+TEST(BigInteger(0).toUnsignedInt()); //0
+TEST(BigInteger(4294967295U).toUnsignedInt()); //4294967295
+TEST(stringToBigInteger("4294967296").toUnsignedInt()); //error
+
+TEST(stringToBigInteger("-2147483649").toInt()); //error
+TEST(stringToBigInteger("-2147483648").toInt()); //-2147483648
+TEST(BigInteger(-2147483647).toInt()); //-2147483647
+TEST(BigInteger(0).toInt()); //0
+TEST(BigInteger(2147483647).toInt()); //2147483647
+TEST(BigInteger(2147483648U).toInt()); //error
+
+TEST(BigInteger(-1).toUnsignedShort()); //error
+TEST(BigInteger(0).toUnsignedShort()); //0
+TEST(BigInteger(65535).toUnsignedShort()); //65535
+TEST(BigInteger(65536).toUnsignedShort()); //error
+
+TEST(BigInteger(-32769).toShort()); //error
+TEST(BigInteger(-32768).toShort()); //-32768
+TEST(BigInteger(-32767).toShort()); //-32767
+TEST(BigInteger(0).toShort()); //0
+TEST(BigInteger(32767).toShort()); //32767
+TEST(BigInteger(32768).toShort()); //error
+
+// === Negative BigUnsigneds ===
+
+// ...during construction
+TEST(BigUnsigned(short(-1))); //error
+TEST(BigUnsigned(pathologicalShort)); //error
+TEST(BigUnsigned(-1)); //error
+TEST(BigUnsigned(pathologicalInt)); //error
+TEST(BigUnsigned(long(-1))); //error
+TEST(BigUnsigned(pathologicalLong)); //error
+
+// ...during subtraction
+TEST(BigUnsigned(5) - BigUnsigned(6)); //error
+TEST(stringToBigUnsigned("314159265358979323") - stringToBigUnsigned("314159265358979324")); //error
+TEST(check(BigUnsigned(5) - BigUnsigned(5))); //0
+TEST(check(stringToBigUnsigned("314159265358979323") - stringToBigUnsigned("314159265358979323"))); //0
+TEST(check(stringToBigUnsigned("4294967296") - BigUnsigned(1))); //4294967295
+
+// === BigUnsigned addition ===
+
+TEST(check(BigUnsigned(0) + 0)); //0
+TEST(check(BigUnsigned(0) + 1)); //1
+// Ordinary carry
+TEST(check(stringToBigUnsigned("8589934591" /* 2^33 - 1*/)
+ + stringToBigUnsigned("4294967298" /* 2^32 + 2 */))); //12884901889
+// Creation of a new block
+TEST(check(BigUnsigned(0xFFFFFFFFU) + 1)); //4294967296
+
+// === BigUnsigned subtraction ===
+
+TEST(check(BigUnsigned(1) - 0)); //1
+TEST(check(BigUnsigned(1) - 1)); //0
+TEST(check(BigUnsigned(2) - 1)); //1
+// Ordinary borrow
+TEST(check(stringToBigUnsigned("12884901889")
+ - stringToBigUnsigned("4294967298"))); //8589934591
+// Borrow that removes a block
+TEST(check(stringToBigUnsigned("4294967296") - 1)); //4294967295
+
+// === BigUnsigned multiplication and division ===
+
+BigUnsigned a = check(BigUnsigned(314159265) * 358979323);
+TEST(a); //112776680263877595
+TEST(a / 123); //916883579381118
+TEST(a % 123); //81
+
+TEST(BigUnsigned(5) / 0); //error
+
+// === Block accessors ===
+
+BigUnsigned b;
+TEST(b); //0
+TEST(b.getBlock(0)); //0
+b.setBlock(1, 314);
+// Did b grow properly? And did we zero intermediate blocks?
+TEST(check(b)); //1348619730944
+TEST(b.getLength()); //2
+TEST(b.getBlock(0)); //0
+TEST(b.getBlock(1)); //314
+// Did b shrink properly?
+b.setBlock(1, 0);
+TEST(check(b)); //0
+
+BigUnsigned bb(314);
+bb.setBlock(1, 159);
+// Make sure we used allocateAndCopy, not allocate
+TEST(bb.getBlock(0)); //314
+TEST(bb.getBlock(1)); //159
+// Blocks beyond the number should be zero regardless of whether they are
+// within the capacity.
+bb.add(1, 2);
+TEST(bb.getBlock(0)); //3
+TEST(bb.getBlock(1)); //0
+TEST(bb.getBlock(2)); //0
+TEST(bb.getBlock(314159)); //0
+
+// === Bit accessors ===
+
+TEST(BigUnsigned(0).bitLength()); //0
+TEST(BigUnsigned(1).bitLength()); //1
+TEST(BigUnsigned(4095).bitLength()); //12
+TEST(BigUnsigned(4096).bitLength()); //13
+// 5 billion is between 2^32 (about 4 billion) and 2^33 (about 8 billion).
+TEST(stringToBigUnsigned("5000000000").bitLength()); //33
+
+// 25 is binary 11001.
+BigUnsigned bbb(25);
+TEST(bbb.getBit(4)); //1
+TEST(bbb.getBit(3)); //1
+TEST(bbb.getBit(2)); //0
+TEST(bbb.getBit(1)); //0
+TEST(bbb.getBit(0)); //1
+TEST(bbb.bitLength()); //5
+// Effectively add 2^32.
+bbb.setBit(32, true);
+TEST(bbb); //4294967321
+bbb.setBit(31, true);
+bbb.setBit(32, false);
+TEST(check(bbb)); //2147483673
+
+// === Combining BigUnsigned, BigInteger, and primitive integers ===
+
+BigUnsigned p1 = BigUnsigned(3) * 5;
+TEST(p1); //15
+/* In this case, we would like g++ to implicitly promote the BigUnsigned to a
+ * BigInteger, but it seems to prefer converting the -5 to a BigUnsigned, which
+ * causes an error. If I take out constructors for BigUnsigned from signed
+ * primitive integers, the BigUnsigned(3) becomes ambiguous, and if I take out
+ * all the constructors but BigUnsigned(unsigned long), g++ uses that
+ * constructor and gets a wrong (positive) answer. Thus, I think we'll just
+ * have to live with this cast. */
+BigInteger p2 = BigInteger(BigUnsigned(3)) * -5;
+TEST(p2); //-15
+
+// === Test some previous bugs ===
+
+{
+ /* Test that BigInteger division sets the sign to zero.
+ * Bug reported by David Allen. */
+ BigInteger num(3), denom(5), quotient;
+ num.divideWithRemainder(denom, quotient);
+ check(quotient);
+ num = 5;
+ num.divideWithRemainder(denom, quotient);
+ check(num);
+}
+
+{
+ /* Test that BigInteger subtraction sets the sign properly.
+ * Bug reported by Samuel Larkin. */
+ BigInteger zero(0), three(3), ans;
+ ans = zero - three;
+ TEST(check(ans).getSign()); //-1
+}
+
+{
+ /* Test that BigInteger multiplication shifts bits properly on systems
+ * where long is bigger than int. (Obviously, this would only catch the
+ * bug when run on such a system.)
+ * Bug reported by Mohand Mezmaz. */
+ BigInteger f=4; f*=3;
+ TEST(check(f)); //12
+}
+
+{
+ /* Test that bitwise XOR allocates the larger length.
+ * Bug reported by Sriram Sankararaman. */
+ BigUnsigned a(0), b(3), ans;
+ ans = a ^ b;
+ TEST(ans); //3
+}
+
+{
+ /* Test that an aliased multiplication works.
+ * Bug reported by Boris Dessy. */
+ BigInteger num(5);
+ num *= num;
+ TEST(check(num)); //25
+}
+
+{
+ /* Test that BigUnsignedInABase(std::string) constructor rejects digits
+ * too big for the specified base.
+ * Bug reported by Niakam Kazemi. */
+ TEST(BigUnsignedInABase("f", 10)); //error
+}
+
+} catch (const char *err) {
+ cout << "UNCAUGHT ERROR: " << err << endl;
+}
+
+return 0;
+}
--- /dev/null
+/*\r
+ Copyright (c) 2011, Micael Hildenborg\r
+ All rights reserved.\r
+\r
+ Redistribution and use in source and binary forms, with or without\r
+ modification, are permitted provided that the following conditions are met:\r
+ * Redistributions of source code must retain the above copyright\r
+ notice, this list of conditions and the following disclaimer.\r
+ * Redistributions in binary form must reproduce the above copyright\r
+ notice, this list of conditions and the following disclaimer in the\r
+ documentation and/or other materials provided with the distribution.\r
+ * Neither the name of Micael Hildenborg nor the\r
+ names of its contributors may be used to endorse or promote products\r
+ derived from this software without specific prior written permission.\r
+\r
+ THIS SOFTWARE IS PROVIDED BY Micael Hildenborg ''AS IS'' AND ANY\r
+ EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
+ DISCLAIMED. IN NO EVENT SHALL Micael Hildenborg BE LIABLE FOR ANY\r
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
+ */\r
+\r
+/*\r
+ Contributors:\r
+ Gustav\r
+ Several members in the gamedev.se forum.\r
+ Gregory Petrosyan\r
+ */\r
+\r
+#include "sha1.h"\r
+\r
+namespace sha1\r
+{\r
+ namespace // local\r
+ {\r
+ // Rotate an integer value to left.\r
+ inline unsigned int rol(const unsigned int value,\r
+ const unsigned int steps)\r
+ {\r
+ return ((value << steps) | (value >> (32 - steps)));\r
+ }\r
+\r
+ // Sets the first 16 integers in the buffert to zero.\r
+ // Used for clearing the W buffert.\r
+ inline void clearWBuffert(unsigned int* buffert)\r
+ {\r
+ for (int pos = 16; --pos >= 0;)\r
+ {\r
+ buffert[pos] = 0;\r
+ }\r
+ }\r
+\r
+ void innerHash(unsigned int* result, unsigned int* w)\r
+ {\r
+ unsigned int a = result[0];\r
+ unsigned int b = result[1];\r
+ unsigned int c = result[2];\r
+ unsigned int d = result[3];\r
+ unsigned int e = result[4];\r
+\r
+ int round = 0;\r
+\r
+ #define sha1macro(func,val) \\r
+ { \\r
+ const unsigned int t = rol(a, 5) + (func) + e + val + w[round]; \\r
+ e = d; \\r
+ d = c; \\r
+ c = rol(b, 30); \\r
+ b = a; \\r
+ a = t; \\r
+ }\r
+\r
+ while (round < 16)\r
+ {\r
+ sha1macro((b & c) | (~b & d), 0x5a827999)\r
+ ++round;\r
+ }\r
+ while (round < 20)\r
+ {\r
+ w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
+ sha1macro((b & c) | (~b & d), 0x5a827999)\r
+ ++round;\r
+ }\r
+ while (round < 40)\r
+ {\r
+ w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
+ sha1macro(b ^ c ^ d, 0x6ed9eba1)\r
+ ++round;\r
+ }\r
+ while (round < 60)\r
+ {\r
+ w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
+ sha1macro((b & c) | (b & d) | (c & d), 0x8f1bbcdc)\r
+ ++round;\r
+ }\r
+ while (round < 80)\r
+ {\r
+ w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);\r
+ sha1macro(b ^ c ^ d, 0xca62c1d6)\r
+ ++round;\r
+ }\r
+\r
+ #undef sha1macro\r
+\r
+ result[0] += a;\r
+ result[1] += b;\r
+ result[2] += c;\r
+ result[3] += d;\r
+ result[4] += e;\r
+ }\r
+ } // namespace\r
+\r
+ void calc(const void* src, const int bytelength, unsigned char* hash)\r
+ {\r
+ // Init the result array.\r
+ unsigned int result[5] = { 0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0 };\r
+\r
+ // Cast the void src pointer to be the byte array we can work with.\r
+ const unsigned char* sarray = (const unsigned char*) src;\r
+\r
+ // The reusable round buffer\r
+ unsigned int w[80];\r
+\r
+ // Loop through all complete 64byte blocks.\r
+ const int endOfFullBlocks = bytelength - 64;\r
+ int endCurrentBlock;\r
+ int currentBlock = 0;\r
+\r
+ while (currentBlock <= endOfFullBlocks)\r
+ {\r
+ endCurrentBlock = currentBlock + 64;\r
+\r
+ // Init the round buffer with the 64 byte block data.\r
+ for (int roundPos = 0; currentBlock < endCurrentBlock; currentBlock += 4)\r
+ {\r
+ // This line will swap endian on big endian and keep endian on little endian.\r
+ w[roundPos++] = (unsigned int) sarray[currentBlock + 3]\r
+ | (((unsigned int) sarray[currentBlock + 2]) << 8)\r
+ | (((unsigned int) sarray[currentBlock + 1]) << 16)\r
+ | (((unsigned int) sarray[currentBlock]) << 24);\r
+ }\r
+ innerHash(result, w);\r
+ }\r
+\r
+ // Handle the last and not full 64 byte block if existing.\r
+ endCurrentBlock = bytelength - currentBlock;\r
+ clearWBuffert(w);\r
+ int lastBlockBytes = 0;\r
+ for (;lastBlockBytes < endCurrentBlock; ++lastBlockBytes)\r
+ {\r
+ w[lastBlockBytes >> 2] |= (unsigned int) sarray[lastBlockBytes + currentBlock] << ((3 - (lastBlockBytes & 3)) << 3);\r
+ }\r
+ w[lastBlockBytes >> 2] |= 0x80 << ((3 - (lastBlockBytes & 3)) << 3);\r
+ if (endCurrentBlock >= 56)\r
+ {\r
+ innerHash(result, w);\r
+ clearWBuffert(w);\r
+ }\r
+ w[15] = bytelength << 3;\r
+ innerHash(result, w);\r
+\r
+ // Store hash in result pointer, and make sure we get in in the correct order on both endian models.\r
+ for (int hashByte = 20; --hashByte >= 0;)\r
+ {\r
+ hash[hashByte] = (result[hashByte >> 2] >> (((3 - hashByte) & 0x3) << 3)) & 0xff;\r
+ }\r
+ }\r
+\r
+ void toHexString(const unsigned char* hash, char* hexstring)\r
+ {\r
+ const char hexDigits[] = { "0123456789abcdef" };\r
+\r
+ for (int hashByte = 20; --hashByte >= 0;)\r
+ {\r
+ hexstring[hashByte << 1] = hexDigits[(hash[hashByte] >> 4) & 0xf];\r
+ hexstring[(hashByte << 1) + 1] = hexDigits[hash[hashByte] & 0xf];\r
+ }\r
+ hexstring[40] = 0;\r
+ }\r
+} // namespace sha1\r
--- /dev/null
+/*\r
+ Copyright (c) 2011, Micael Hildenborg\r
+ All rights reserved.\r
+\r
+ Redistribution and use in source and binary forms, with or without\r
+ modification, are permitted provided that the following conditions are met:\r
+ * Redistributions of source code must retain the above copyright\r
+ notice, this list of conditions and the following disclaimer.\r
+ * Redistributions in binary form must reproduce the above copyright\r
+ notice, this list of conditions and the following disclaimer in the\r
+ documentation and/or other materials provided with the distribution.\r
+ * Neither the name of Micael Hildenborg nor the\r
+ names of its contributors may be used to endorse or promote products\r
+ derived from this software without specific prior written permission.\r
+\r
+ THIS SOFTWARE IS PROVIDED BY Micael Hildenborg ''AS IS'' AND ANY\r
+ EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
+ DISCLAIMED. IN NO EVENT SHALL Micael Hildenborg BE LIABLE FOR ANY\r
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
+ */\r
+\r
+#ifndef SHA1_DEFINED\r
+#define SHA1_DEFINED\r
+\r
+namespace sha1\r
+{\r
+\r
+ /**\r
+ @param src points to any kind of data to be hashed.\r
+ @param bytelength the number of bytes to hash from the src pointer.\r
+ @param hash should point to a buffer of at least 20 bytes of size for storing the sha1 result in.\r
+ */\r
+ void calc(const void* src, const int bytelength, unsigned char* hash);\r
+\r
+ /**\r
+ @param hash is 20 bytes of sha1 hash. This is the same data that is the result from the calc function.\r
+ @param hexstring should point to a buffer of at least 41 bytes of size for storing the hexadecimal representation of the hash. A zero will be written at position 40, so the buffer will be a valid zero ended string.\r
+ */\r
+ void toHexString(const unsigned char* hash, char* hexstring);\r
+\r
+} // namespace sha1\r
+\r
+#endif // SHA1_DEFINED\r
--- /dev/null
+
+CONFIG := clang-debug
+# CONFIG := gcc-debug
+# CONFIG := profile
+# CONFIG := release
+
+CC = clang
+CXX = clang
+CXXFLAGS = -MD -Wall -Wextra -ggdb
+LDLIBS = -lstdc++
+
+ifeq ($(CONFIG),clang-debug)
+CXXFLAGS += -std=c++11 -O0
+endif
+
+ifeq ($(CONFIG),gcc-debug)
+CC = gcc
+CXX = gcc
+CXXFLAGS += -std=gnu++0x -O0
+endif
+
+ifeq ($(CONFIG),profile)
+CC = gcc
+CXX = gcc
+CXXFLAGS += -std=gnu++0x -Os -DNDEBUG
+endif
+
+ifeq ($(CONFIG),release)
+CC = gcc
+CXX = gcc
+CXXFLAGS += -std=gnu++0x -march=native -O3 -DNDEBUG
+endif
+
+all: demo scshell
+
+demo: demo.o subcircuit.o
+
+scshell: scshell.o subcircuit.o
+
+test: scshell
+ ./scshell < test_macc22.txt
+ perl test_perm.pl | ./scshell
+ splrun test_shorts.spl | ./scshell
+ splrun test_large.spl | ./scshell
+
+clean:
+ rm -f demo scshell *.o *.d
+
+.PHONY: all test clean
+
+-include *.d
+
--- /dev/null
+
+ **************************************************************************
+ * *
+ * The SubCircuit C++11 library *
+ * *
+ * An implementation of a modified Ullmann Subgraph Isomorphism Algorithm *
+ * for coarse grain logic networks. by Clifford Wolf *
+ * *
+ **************************************************************************
+
+============
+Introduction
+============
+
+This is a library that implements a modified Ullmann Subgraph Isomorphism
+Algorithm with additional features aimed at working with coarse grain logic
+networks.
+
+A simple command line tool that exposes the features of the library is also
+included.
+
+
+Under-Construction Warning
+--------------------------
+
+This work is under constructions. It is likely that they are bugs in the
+library that need fixing. Feel free to contact me at clifford@clifford.at
+if you have found a bug.
+
+
+C++11 Warning
+-------------
+
+This project is written in C++11. Use appropriate compiler switches to compile
+it. Tested with clang version 3.0 and option -std=c++11. Also tested with gcc
+version 4.6.3 and option -std=c++0x.
+
+
+========
+Features
+========
+
+The input is two graphs (needle and haystack) that represent coarse grain
+logic networks. The algorithm identifies all subgraphs of haystack that are
+isomorphic to needle.
+
+The following additional features over the regular Ullmann Subgraph Isomorphism
+Algorithm are provided by the library.
+
+ * The graphs are attributed hypergraphs capable of representing netlists:
+
+ - Nodes represent the logic cells:
+ - Nodes have types and only match compatible types
+ - Nodes have ports with variable bit-width
+
+ - Hyperedges represent the signals:
+ - Each hyperedge connects one to many bits on ports on nodes
+
+ - Callback functions for advanced attributes and compatibility rules:
+ Any set of node-node compatibility rules and edge-edge
+ compatibility rules can be implemented by providing
+ the necessary callback functions.
+
+ * The algorithm is very efficient when all or many bits of one port are
+ connected to bits of the same other port. This is usually the case
+ in coarse grain logic networks. But the algorithm does not add any
+ restrictions in this area; it is just optimized for this scenario.
+
+ * The algorithm can be configured to allow larger ports in needle cells to
+ match smaller ports in haystack cells in certain situations. This way it
+ is possible to e.g. have a 32-bit adder cell in the needle match a
+ 16-bit adder cell in the haystack.
+
+ * The algorithm can be configured to perform port-swapping on certain
+ ports on certain cell types to match commutative operations properly.
+
+ This is, however, not implemented very efficiently when a larger number
+ of permutations is possible on a cell type. Therefore it is recommended
+ to only use swap groups with only a few members and a few such groups
+ on one cell type type.
+
+ Also note, that the algorithm can not resolve complex dependencies
+ between the port swappings of different cells. Therefore it is
+ recommended to only use port swapping on input pins of commutative
+ operations, where such complex dependencies can not emerge.
+
+ * The algorithm can be configured to distinguish between internal signals
+ of the needle and externally visible signals. The needle will only
+ match a subgraph of the haystack if that subgraph does not expose the
+ internal signal to nodes in the haystack outside the matching subgraph.
+
+ * The algorithm can recognize a subcircuit even if some or all of its
+ inputs and/or outputs are shorted together.
+
+ * Explicit fast support for constant signals without extra nodes for
+ constant drivers.
+
+ * Support for finding only non-overlapping matches.
+
+ * The public API of the library is using std::string identifiers for
+ nodes, node types and ports. Internally the costly part of the
+ algorithm is only using integer values, thus speeding up the
+ algorithm without exposing complex internal encodings to the caller.
+
+
+=================
+API Documentation
+=================
+
+This section gives a brief overview of the API. For a working example, have a
+look at the demo.cc example program in this directory.
+
+
+Setting up graphs
+-----------------
+
+Instanciate the SubCircuit::Graph class and use the methods of this class to
+set up the circuit.
+
+ SubCircuit::Graph myGraph;
+
+For each node in the circuit call the createNode() method. Specify the
+identifier for the node and also the type of function implemented by the node.
+Then call createPort() for each port of this node.
+
+E.g. the following code adds a node "myAdder" of type "add" with three 32 bit
+wide ports "A", "B" and "Y". Note that SubCircuit does not care which port is
+an input and which port is an output. The last (and optional) argument to
+createPort() specifies the minimum number of bits required for this port in the
+haystack (this field is only used in the needle graph). So in this example the
+node would e.g. also match any adder with a bit width smaller 32.
+
+ myGraph.createNode("myAdder", "add");
+ myGraph.createPort("myAdder", "A", 32, 1);
+ myGraph.createPort("myAdder", "B", 32, 1);
+ myGraph.createPort("myAdder", "Y", 32, 1);
+
+The createConnection() method can be used to connect the nodes. It internally
+creates a hypergraph. So the following code does not only connect cell1.Y with
+cell2.A and cell3.A but also implicitly cell2.A with cell3.A.
+
+ myGraph.createConnection("cell1", "Y", "cell2", "A");
+ myGraph.createConnection("cell1", "Y", "cell3", "A");
+
+Redundent calls to createConnection() are ignored. As long as the method is
+called after the relevant nodes and ports are created, the order in which the
+createConnection() calls are performed is irrelevant.
+
+The createConnection() method can also be used to connect single bit signals.
+In this case the start bit for both ports must be provided as well as an
+optional width (which defaults to 1). E.g. the following calls can be used to
+connect the 32 bit port cell4.Y to the 32 bit port cell5.A with a one bit left
+rotate shift,
+
+ myGraph.createConnection("cell4", "Y", 0, "cell5", "A", 1, 31);
+ myGraph.createConnection("cell4", "Y", 31, "cell5", "A", 0);
+
+The method createConstant() can be used to add a constant driver to a signal.
+The signal value is encoded as one char by bit, allowing for multi-valued
+logic matching. The follwoing command sets the lowest bit of cell6.A to a
+logic 1:
+
+ myGraph.createConnection("cell6", "A", 0, '1');
+
+It is also possible to set an entire port to a integer value, using the
+encodings '0' and '1' for the binary digits:
+
+ myGraph.createConnection("cell6", "A", 42);
+
+The method markExtern() can be used to mark a signal as externally visible. In
+a needle graph this means, this signal may match a signal in the haystack that
+is used outside the matching subgraph. In a haystack graph this means, this
+signal is used outside the haystack graph. I.e. an internal signal of the
+needle won't match an external signal of the haystack regardless where the
+signal is used in the haystack.
+
+In some application one may disable this extern/intern checks. This can easily
+be achieved by marking all signals in the needle as extern. This can be done
+using the Graph::markAllExtern() method.
+
+
+Setting up and running solvers
+------------------------------
+
+To actually run the subgraph isomorphism algorithm, an instance of
+SubCircuit::Solver must be created.
+
+ SubCircuit::Solver mySolver;
+
+The addGraph() method can be used to register graphs with the solver:
+
+ mySolver.addGraph("graph1", myGraph);
+ mySolver.addGraph("graph2", myOtherGraph);
+
+Usually nodes in the needle and the haystack must have the same type identifier
+to match each other. Additionally pairs of compatible needle and haystack node
+pairs can be registered using the addCompatibleTypes() method:
+
+ mySolver.addCompatibleTypes("alu", "add");
+ mySolver.addCompatibleTypes("alu", "sub");
+ mySolver.addCompatibleTypes("alu", "and");
+ mySolver.addCompatibleTypes("alu", "or");
+ mySolver.addCompatibleTypes("alu", "xor");
+
+Note that nodes in needle and haystack must also use the same naming convention
+for their ports in order to be considered compatible by the algorithm.
+
+Similarly the method addCompatibleConstants() can be used the specify which
+constant values in the needle should match which constant value in the haystack.
+Equal values always do match.
+
+ mySolver.addCompatibleConstants('x', '0');
+ mySolver.addCompatibleConstants('x', '1');
+
+Some cells implement commutative operations that don't care if their input
+operands are swapped. For this cell types it is possible to register groups
+of swappable ports. Let's consider a cell "macc23" that implements the
+function Y = (A * B) + (C * D * E):
+
+ mySolver.addSwappablePorts("macc23", "A", "B");
+ mySolver.addSwappablePorts("macc23", "C", "D", "E");
+
+Sometimes the rules for port swapping are a more complicated and the swapping
+of one port is related to the swapping of another port. Let's consider a cell
+"macc22" that implements the function Y = (A * B) + (C * D):
+
+ mySolver.addSwappablePorts("macc22", "A", "B");
+ mySolver.addSwappablePorts("macc22", "C", "D");
+
+ std::map<std::string, std::string> portMapping;
+ portMapping["A"] = "C";
+ portMapping["B"] = "D";
+ portMapping["C"] = "A";
+ portMapping["D"] = "B";
+ mySolver.addSwappablePortsPermutation("macc22", portMapping);
+
+I.e. the method mySolver.addSwappablePortsPermutation() can be used to register
+additional permutations for a node type of which one or none is applied on top
+of the permutations yielded by the permutations generated by the swap groups.
+
+Note that two solutions that differ only in the applied port swapping are not
+reported as separate solutions. Instead only one of them is selected (in most
+cases the one with less port swapping as it is usually identified first).
+
+Once everything has been set up, the solve() method can be used to actually
+search for isomorphic subgraphs. The first argument to solve() is an
+std::vector<SubCircuit::Solver::Result> objects to which all found solutions
+are appended. The second argument is the identifier under which the needle
+graph has been registered and the third argument is the identifier under which
+the haystack graph has been registered:
+
+ std::vector<SubCircuit::Solver::Result> results;
+ mySolver.solve(results, "graph1", "graph2");
+
+The SubCircuit::Solver::Result object is a simple data structure that contains
+the mappings between needle and haystack nodes, port mappings after the port
+swapping and some additional metadata. See "subcircuit.h" and "demo.cc" for
+details.
+
+The solve() method has a third optional boolean argument. If it is set to
+false, solve will not return any solutions that contain haystack nodes that
+have been part of a previously found solution. This way it is e.g. easy
+to implement a greedy macro cell matching algorithm:
+
+ std::vector<SubCircuit::Solver::Result> results;
+ mySolver.solve(results, "macroCell1", "circuit", false);
+ mySolver.solve(results, "macroCell2", "circuit", false);
+ mySolver.solve(results, "macroCell3", "circuit", false);
+
+After this code has been executed, the results vector contains all
+non-overlapping matches of the three macrocells. The method
+clearOverlapHistory() can be used to reset the internal state used
+for this feature. The default value for the third argument to solve()
+is true (allow overlapping).
+
+The solve() method also has a fourth optional integer argument. If it is set to
+a positive integer, this integer specifies the maximum number of solutions to
+be appended to the results vector, i.e. to terminate the algorithm early when
+the set number of matches is found. When this fourth argument is negative or
+omitted all matches are found and appended.
+
+An alternative version of the solve() method supports an additional argument
+after they haystack graph identifier that specifies initial mappings for
+the algorithm. In the following example only the haystack nodes cell_1 and
+cell_2 are considered as mappings for the needle node cell_A:
+
+ std::map<std::string, std::set<std::string>> initialMappings;
+ initialMappings["cell_A"].insert("cell_1");
+ initialMappings["cell_A"].insert("cell_2");
+
+ std::vector<SubCircuit::Solver::Result> results;
+ mySolver.solve(results, "graph1", "graph2", initialMappings);
+
+The clearConfig() method can be used to clear all data registered using
+addCompatibleTypes(), addCompatibleConstants(), addSwappablePorts() and
+addSwappablePortsPermutation() but retaining the graphs and the overlap state.
+
+
+Using user callback function
+----------------------------
+
+For more complex tasks it is possible to derive a class from SubCircuit::Solver
+that overloads one or more of the following virtual methods. The userData
+arguments to the following methods are void pointers that can be passed as
+third argument to Graph::createNode() and are simly passed thru to the user
+callback functions together with the node id whenever a node is referenced.
+
+bool userCompareNodes(needleGraphId, needleNodeId, needleUserData, haystackGraphId, haystackNodeId, haystackUserData):
+
+ Perform additional checks on a pair of nodes (one from the needle, one
+ from the haystack) to determine if the nodes are compatible. The default
+ implementation always returns true.
+
+
+bool userCompareEdge(needleGraphId, needleFromNodeId, needleFromUserData, needleToNodeId, needleToUserData,
+ haystackGraphId, haystackFromNodeId, haystackFromUserData, haystackToNodeId, haystackToUserData):
+
+ Perform additional checks on a pair of a pair of adjacent nodes (one
+ adjacent pair from the needle and one adjacent pair from the haystack)
+ to determine wheter this edge from the needle is compatible with
+ that edge from the haystack. The default implementation always
+ returns true.
+
+bool userCheckSolution(result):
+
+ Perform additional checks on a solution before appending it to the
+ results vector. When this function returns false, the solution is
+ ignored. The default implementation always returns true.
+
+
+Debugging
+---------
+
+For debugging purposes the SubCircuit::Solver class implements a setVerbose()
+method. When called once, all further calls to the solve() method cause the
+algorithm to dump out a lot of debug information to stdout.
+
+In conjunction with setVerbose() one can also overload the userAnnotateEdge()
+method in order to add additional information about the edges to the debug
+output.
+
+
+===================
+Shell Documentation
+===================
+
+This package also contains a small command-line tool called "scshell" that can
+be used for experimentation with the algorithm. This program reads a series of
+commands from stdin and reports its findings to stdout on exit.
+
+ $ ./scshell < test_macc22.txt
+
+ ...
+
+ Match #3: (macc22 in macc4x2)
+ add_1 -> add_2 A:B B:A Y:Y
+ mul_1 -> mul_4 A:A B:B Y:Y
+ mul_2 -> mul_3 A:A B:B Y:Y
+
+The following commands can be used in scshell to specify graphs:
+
+ graph <graph_name>
+ ...
+ endgraph
+
+ Used to specify a graph with the given name. Only the commands
+ "node", "connect" and "extern" may be used within the graph ...
+ endgraph block.
+
+ node <node_name> [<port_name> [<bits> [<min_bits>]]]+
+
+ Used to create a node and ports. This command is a direct frontend
+ to the Graph::createNode() and Graph::createPort() methods.
+
+ connect <from_node> <from_port> <to_node> <to_port>
+ connect <from_node> <from_port> <from_bit> <to_node> <to_port> <to_bit>
+ connect <from_node> <from_port> <from_bit> <to_node> <to_port> <to_bit> <width>
+
+ Used to connect the nodes in the graph via Graph::createConnection().
+
+ constant <node> <port> [<bit>] <value>
+
+ Call Graph::createConstant().
+
+ extern <node> [<port> [<bit>]]+
+
+ Mark signals as extern via Graph::markExtern().
+
+ allextern
+
+ Mark all signals as extern via Graph::markAllExtern().
+
+The following commands can be used in scshell outside a graph ... endgraph block:
+
+ compatible <needle_type> <haystack_type>
+
+ Call Solver::addCompatibleTypes().
+
+ constcompat <needle_value> <haystack_value>
+
+ Call Solver::addCompatibleConstants().
+
+ swapgroup <needle_type> <port>+
+
+ Call Solver::addSwappablePorts().
+
+ swapperm <needle_type> <ports>+ : <ports>+
+
+ Call Solver::addSwappablePortsPermutation(). Both port lists must
+ have the same length and the second one must be a permutation of the
+ first one.
+
+ initmap <needle_node> <haystack_node>+
+
+ Add an entry to the initial mappings for the next solve command.
+ This mappings are automatically reset after the solve command.
+
+ solve <needle_graph> <haystack_graph> [<allow_overlap> [<max_solutions>]]
+
+ Call Solver::solve(). The <allow_overlap> must be "1" or "true"
+ for true and "0" or "false" for false.
+
+ expect <number>
+
+ Print all results so far since the last call to expect. Expect
+ <number> results and exit with error code 1 if a different number
+ of results have been found.
+
+ clearoverlap
+
+ Call Solver::clearOverlapHistory().
+
+ clearconfig
+
+ Call Solver::clearConfig().
+
+ verbose
+
+ Call Solver::setVerbose().
+
--- /dev/null
+#include "subcircuit.h"
+#include <stdio.h>
+
+#define VERBOSE
+
+int main()
+{
+ SubCircuit::Graph needle, haystack;
+
+ // create needle graph
+
+ needle.createNode("mul_1", "product");
+ needle.createPort("mul_1", "A", 4);
+ needle.createPort("mul_1", "B", 4);
+ needle.createPort("mul_1", "Y", 4);
+ needle.markExtern("mul_1", "A");
+ needle.markExtern("mul_1", "B");
+
+ needle.createNode("mul_2", "product");
+ needle.createPort("mul_2", "A", 4);
+ needle.createPort("mul_2", "B", 4);
+ needle.createPort("mul_2", "Y", 4);
+ needle.markExtern("mul_2", "A");
+ needle.markExtern("mul_2", "B");
+
+ needle.createNode("add_1", "sum");
+ needle.createPort("add_1", "A", 4);
+ needle.createPort("add_1", "B", 4);
+ needle.createPort("add_1", "Y", 4);
+ needle.markExtern("add_1", "Y");
+
+ needle.createConnection("mul_1", "Y", "add_1", "A");
+ needle.createConnection("mul_2", "Y", "add_1", "B");
+
+#ifdef VERBOSE
+ printf("\n");
+ needle.print();
+#endif
+
+ // create haystack graph
+
+#if 0
+ for (int i = 0; i < 4; i++) {
+ char id[100];
+ snprintf(id, 100, "mul_%d", i);
+ haystack.createNode(id, "mul");
+ haystack.createPort(id, "A", 4);
+ haystack.createPort(id, "B", 4);
+ haystack.createPort(id, "Y", 4);
+ haystack.markExtern(id, "A");
+ haystack.markExtern(id, "B");
+ }
+
+ for (int i = 0; i < 3; i++) {
+ char id[100];
+ snprintf(id, 100, "add_%d", i);
+ haystack.createNode(id, "add");
+ haystack.createPort(id, "A", 4);
+ haystack.createPort(id, "B", 4);
+ haystack.createPort(id, "Y", 4);
+ }
+
+ haystack.createConnection("mul_0", "Y", "add_0", "A");
+ haystack.createConnection("mul_1", "Y", "add_0", "B");
+
+ haystack.createConnection("mul_2", "Y", "add_1", "A");
+ haystack.createConnection("mul_3", "Y", "add_1", "B");
+
+ haystack.createConnection("add_0", "Y", "add_2", "A");
+ haystack.createConnection("add_1", "Y", "add_2", "B");
+ haystack.markExtern("add_2", "Y");
+#else
+ std::vector<std::string> cellIds;
+ srand48(12345);
+
+ for (int i = 0; i < 45; i++) {
+ char id[100];
+ snprintf(id, 100, "cell_%02d", i);
+ haystack.createNode(id, i < 30 ? "mul" : "add");
+ haystack.createPort(id, "A", 4);
+ haystack.createPort(id, "B", 4);
+ haystack.createPort(id, "Y", 4);
+ cellIds.push_back(id);
+ }
+
+ for (int i = 0; i < int(cellIds.size()); i++) {
+ if (lrand48() % (i < 20 ? 3 : 2) != 0)
+ continue;
+ const std::string &id = cellIds[i];
+ const std::string &id_left = cellIds[lrand48() % cellIds.size()];
+ const std::string &id_right = cellIds[lrand48() % cellIds.size()];
+ haystack.createConnection(id_left, "Y", id, "A");
+ haystack.createConnection(id_right, "Y", id, "B");
+ }
+#endif
+
+#ifdef VERBOSE
+ printf("\n");
+ haystack.print();
+#endif
+
+ // search needle in haystack
+
+ SubCircuit::Solver solver;
+ std::vector<SubCircuit::Solver::Result> results;
+
+#ifdef VERBOSE
+ solver.setVerbose();
+#endif
+
+ solver.addCompatibleTypes("product", "mul");
+ solver.addCompatibleTypes("sum", "add");
+
+ solver.addSwappablePorts("product", "A", "B");
+ solver.addSwappablePorts("sum", "A", "B");
+
+ solver.addGraph("needle", needle);
+ solver.addGraph("haystack", haystack);
+ solver.solve(results, "needle", "haystack");
+
+ for (int i = 0; i < int(results.size()); i++) {
+ printf("\nMatch #%d: (%s in %s)\n", i, results[i].needleGraphId.c_str(), results[i].haystackGraphId.c_str());
+ for (const auto &it : results[i].mappings) {
+ printf(" %s -> %s", it.first.c_str(), it.second.haystackNodeId.c_str());
+ for (const auto &it2 : it.second.portMapping)
+ printf(" %s:%s", it2.first.c_str(), it2.second.c_str());
+ printf("\n");
+ }
+ }
+
+ printf("\n");
+ return 0;
+}
+
--- /dev/null
+#include "subcircuit.h"
+#include <string.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+std::vector<std::string> readLine()
+{
+ char buffer[4096];
+ std::vector<std::string> tokenList;
+
+ while (tokenList.size() == 0 && fgets(buffer, sizeof(buffer), stdin) != NULL) {
+ for (char *p = buffer; char *tok = strtok(p, " \t\r\n"); p = NULL) {
+ if (p != NULL && tok[0] == '#')
+ break;
+ tokenList.push_back(tok);
+ }
+ }
+
+ return tokenList;
+}
+
+int main()
+{
+ std::string graphId;
+ SubCircuit::Graph *graph = NULL;
+ SubCircuit::Solver solver;
+ std::map<std::string, std::set<std::string>> initialMappings;
+ std::vector<SubCircuit::Solver::Result> results;
+ std::vector<std::string> cmdBuffer;
+ bool lastCommandExpect = false;
+
+ while (1)
+ {
+ cmdBuffer = readLine();
+ if (cmdBuffer.empty())
+ break;
+
+ printf(graph == NULL || cmdBuffer[0] == "endgraph" ? ">" : "> ");
+ for (const auto &tok : cmdBuffer)
+ printf(" %s", tok.c_str());
+ printf("\n");
+
+ lastCommandExpect = false;
+
+ if (graph != NULL)
+ {
+ if (cmdBuffer[0] == "node" && cmdBuffer.size() >= 3) {
+ graph->createNode(cmdBuffer[1], cmdBuffer[2]);
+ for (int i = 3; i < int(cmdBuffer.size()); i++) {
+ std::string portId = cmdBuffer[i];
+ int width = 1, minWidth = -1;
+ if (i+1 < int(cmdBuffer.size()) && '0' <= cmdBuffer[i+1][0] && cmdBuffer[i+1][0] <= '9')
+ width = atoi(cmdBuffer[++i].c_str());
+ if (i+1 < int(cmdBuffer.size()) && '0' <= cmdBuffer[i+1][0] && cmdBuffer[i+1][0] <= '9')
+ minWidth = atoi(cmdBuffer[++i].c_str());
+ graph->createPort(cmdBuffer[1], portId, width, minWidth);
+ }
+ continue;
+ }
+
+ if (cmdBuffer[0] == "connect" && cmdBuffer.size() == 5) {
+ graph->createConnection(cmdBuffer[1], cmdBuffer[2], cmdBuffer[3], cmdBuffer[4]);
+ continue;
+ }
+
+ if (cmdBuffer[0] == "connect" && cmdBuffer.size() == 7) {
+ graph->createConnection(cmdBuffer[1], cmdBuffer[2], atoi(cmdBuffer[3].c_str()), cmdBuffer[4], cmdBuffer[5], atoi(cmdBuffer[6].c_str()));
+ continue;
+ }
+
+ if (cmdBuffer[0] == "connect" && cmdBuffer.size() == 8) {
+ graph->createConnection(cmdBuffer[1], cmdBuffer[2], atoi(cmdBuffer[3].c_str()), cmdBuffer[4], cmdBuffer[5], atoi(cmdBuffer[6].c_str()), atoi(cmdBuffer[7].c_str()));
+ continue;
+ }
+
+ if (cmdBuffer[0] == "constant" && cmdBuffer.size() == 5) {
+ int constValue = cmdBuffer[4].size() > 1 && cmdBuffer[4][0] == '#' ? atoi(cmdBuffer[4].c_str()+1) : cmdBuffer[4][0];
+ graph->createConstant(cmdBuffer[1], cmdBuffer[2], atoi(cmdBuffer[3].c_str()), constValue);
+ continue;
+ }
+
+ if (cmdBuffer[0] == "constant" && cmdBuffer.size() == 4) {
+ graph->createConstant(cmdBuffer[1], cmdBuffer[2], atoi(cmdBuffer[3].c_str()));
+ continue;
+ }
+
+ if (cmdBuffer[0] == "extern" && cmdBuffer.size() >= 3) {
+ for (int i = 2; i < int(cmdBuffer.size()); i++) {
+ std::string portId = cmdBuffer[i];
+ int bit = -1;
+ if (i+1 < int(cmdBuffer.size()) && '0' <= cmdBuffer[i+1][0] && cmdBuffer[i+1][0] <= '9')
+ bit = atoi(cmdBuffer[++i].c_str());
+ graph->markExtern(cmdBuffer[1], portId, bit);
+ }
+ continue;
+ }
+
+ if (cmdBuffer[0] == "allextern" && cmdBuffer.size() == 1) {
+ graph->markAllExtern();
+ continue;
+ }
+
+ if (cmdBuffer[0] == "endgraph" && cmdBuffer.size() == 1) {
+ solver.addGraph(graphId, *graph);
+ delete graph;
+ graph = NULL;
+ continue;
+ }
+ }
+ else
+ {
+ if (cmdBuffer[0] == "graph" && cmdBuffer.size() == 2) {
+ graph = new SubCircuit::Graph;
+ graphId = cmdBuffer[1];
+ continue;
+ }
+
+ if (cmdBuffer[0] == "compatible" && cmdBuffer.size() == 3) {
+ solver.addCompatibleTypes(cmdBuffer[1], cmdBuffer[2]);
+ continue;
+ }
+
+ if (cmdBuffer[0] == "constcompat" && cmdBuffer.size() == 3) {
+ int needleConstValue = cmdBuffer[1].size() > 1 && cmdBuffer[1][0] == '#' ? atoi(cmdBuffer[1].c_str()+1) : cmdBuffer[1][0];
+ int haystackConstValue = cmdBuffer[2].size() > 1 && cmdBuffer[2][0] == '#' ? atoi(cmdBuffer[2].c_str()+1) : cmdBuffer[2][0];
+ solver.addCompatibleConstants(needleConstValue, haystackConstValue);
+ continue;
+ }
+
+ if (cmdBuffer[0] == "swapgroup" && cmdBuffer.size() >= 4) {
+ std::set<std::string> ports;
+ for (int i = 2; i < int(cmdBuffer.size()); i++)
+ ports.insert(cmdBuffer[i]);
+ solver.addSwappablePorts(cmdBuffer[1], ports);
+ continue;
+ }
+
+ if (cmdBuffer[0] == "swapperm" && cmdBuffer.size() >= 4 && cmdBuffer.size() % 2 == 1 && cmdBuffer[cmdBuffer.size()/2 + 1] == ":") {
+ std::map<std::string, std::string> portMapping;
+ int n = (cmdBuffer.size()-3) / 2;
+ for (int i = 0; i < n; i++)
+ portMapping[cmdBuffer[i+2]] = cmdBuffer[i+3+n];
+ solver.addSwappablePortsPermutation(cmdBuffer[1], portMapping);
+ continue;
+ }
+
+ if (cmdBuffer[0] == "initmap" && cmdBuffer.size() >= 4) {
+ for (int i = 2; i < int(cmdBuffer.size()); i++)
+ initialMappings[cmdBuffer[1]].insert(cmdBuffer[i]);
+ continue;
+ }
+
+ if (cmdBuffer[0] == "solve" && 3 <= cmdBuffer.size() && cmdBuffer.size() <= 5) {
+ bool allowOverlap = true;
+ int maxSolutions = -1;
+ if (cmdBuffer.size() >= 4)
+ allowOverlap = cmdBuffer[3] == "true" || atoi(cmdBuffer[3].c_str()) ? true : false;
+ if (cmdBuffer.size() >= 5)
+ maxSolutions = atoi(cmdBuffer[4].c_str());
+ solver.solve(results, cmdBuffer[1], cmdBuffer[2], initialMappings, allowOverlap, maxSolutions);
+ initialMappings.clear();
+ continue;
+ }
+
+ if (cmdBuffer[0] == "clearoverlap" && cmdBuffer.size() == 1) {
+ solver.clearOverlapHistory();
+ continue;
+ }
+
+ if (cmdBuffer[0] == "clearconfig" && cmdBuffer.size() == 1) {
+ solver.clearConfig();
+ continue;
+ }
+
+ if (cmdBuffer[0] == "verbose" && cmdBuffer.size() == 1) {
+ solver.setVerbose();
+ continue;
+ }
+
+ if (cmdBuffer[0] == "expect" && cmdBuffer.size() == 2) {
+ int expected = atoi(cmdBuffer[1].c_str());
+ printf("\n-- Expected %d, Got %d --\n", expected, int(results.size()));
+ for (int i = 0; i < int(results.size()); i++) {
+ printf("\nMatch #%d: (%s in %s)\n", i, results[i].needleGraphId.c_str(), results[i].haystackGraphId.c_str());
+ for (const auto &it : results[i].mappings) {
+ printf(" %s -> %s", it.first.c_str(), it.second.haystackNodeId.c_str());
+ for (const auto &it2 : it.second.portMapping)
+ printf(" %s:%s", it2.first.c_str(), it2.second.c_str());
+ printf("\n");
+ }
+ }
+ printf("\n");
+ if (expected != int(results.size())) {
+ printf("^^ expected %d, Got %d ^^\n\n", expected, int(results.size()));
+ printf(" +----------------+\n");
+ printf(" | \\|/ ____ \\|/ |\n");
+ printf(" | \"@'/ ,. \\`@\" |\n");
+ printf(" | /_| \\__/ |_\\ |\n");
+ printf(" | \\__U_/ |\n");
+ printf(" | | | |\n");
+ printf(" +----------------+\n\n");
+ return 1;
+ }
+ results.clear();
+ lastCommandExpect = true;
+ continue;
+ }
+ }
+
+ printf("Invalid input command!\n");
+ return 1;
+ }
+
+ if (graph)
+ delete graph;
+
+ if (!lastCommandExpect) {
+ printf("\n-- Got %d --\n", int(results.size()));
+ for (int i = 0; i < int(results.size()); i++) {
+ printf("\nMatch #%d: (%s in %s)\n", i, results[i].needleGraphId.c_str(), results[i].haystackGraphId.c_str());
+ for (const auto &it : results[i].mappings) {
+ printf(" %s -> %s", it.first.c_str(), it.second.haystackNodeId.c_str());
+ for (const auto &it2 : it.second.portMapping)
+ printf(" %s:%s", it2.first.c_str(), it2.second.c_str());
+ printf("\n");
+ }
+ }
+ } else
+ printf("PASSED.\n");
+
+ printf("\n");
+
+ return 0;
+}
+
--- /dev/null
+/*
+ * SubCircuit -- An implementation of the Ullmann Subgraph Isomorphism
+ * algorithm for coarse grain logic networks
+ *
+ * Copyright (C) 2013 Clifford Wolf <clifford@clifford.at>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ */
+
+#include "subcircuit.h"
+
+#include <algorithm>
+#include <assert.h>
+#include <stdarg.h>
+#include <stdio.h>
+
+using namespace SubCircuit;
+
+static std::string stringf(const char *fmt, ...)
+{
+ std::string string;
+ char *str = NULL;
+ va_list ap;
+
+ va_start(ap, fmt);
+ if (vasprintf(&str, fmt, ap) < 0)
+ str = NULL;
+ va_end(ap);
+
+ if (str != NULL) {
+ string = str;
+ free(str);
+ }
+
+ return string;
+}
+
+bool SubCircuit::Graph::BitRef::operator < (const BitRef &other) const
+{
+ if (nodeIdx != other.nodeIdx)
+ return nodeIdx < other.nodeIdx;
+ if (portIdx != other.portIdx)
+ return portIdx < other.portIdx;
+ return bitIdx < other.bitIdx;
+}
+
+void SubCircuit::Graph::createNode(std::string nodeId, std::string typeId, void *userData)
+{
+ assert(nodeMap.count(nodeId) == 0);
+ nodeMap[nodeId] = nodes.size();
+ nodes.push_back(Node());
+
+ Node &newNode = nodes.back();
+ newNode.nodeId = nodeId;
+ newNode.typeId = typeId;
+ newNode.userData = userData;
+}
+
+void SubCircuit::Graph::createPort(std::string nodeId, std::string portId, int width, int minWidth)
+{
+ assert(nodeMap.count(nodeId) != 0);
+ int nodeIdx = nodeMap[nodeId];
+ Node &node = nodes[nodeIdx];
+
+ assert(node.portMap.count(portId) == 0);
+
+ int portIdx = node.ports.size();
+ node.portMap[portId] = portIdx;
+ node.ports.push_back(Port());
+ Port &port = node.ports.back();
+
+ port.portId = portId;
+ port.minWidth = minWidth < 0 ? width : minWidth;
+ port.bits.insert(port.bits.end(), width, PortBit());
+
+ for (int i = 0; i < width; i++) {
+ port.bits[i].edgeIdx = edges.size();
+ edges.push_back(Edge());
+ edges.back().portBits.insert(BitRef(nodeIdx, portIdx, i));
+ }
+}
+
+void SubCircuit::Graph::createConnection(std::string fromNodeId, std::string fromPortId, int fromBit, std::string toNodeId, std::string toPortId, int toBit, int width)
+{
+ assert(nodeMap.count(fromNodeId) != 0);
+ assert(nodeMap.count(toNodeId) != 0);
+
+ int fromNodeIdx = nodeMap[fromNodeId];
+ Node &fromNode = nodes[fromNodeIdx];
+
+ int toNodeIdx = nodeMap[toNodeId];
+ Node &toNode = nodes[toNodeIdx];
+
+ assert(fromNode.portMap.count(fromPortId) != 0);
+ assert(toNode.portMap.count(toPortId) != 0);
+
+ int fromPortIdx = fromNode.portMap[fromPortId];
+ Port &fromPort = fromNode.ports[fromPortIdx];
+
+ int toPortIdx = toNode.portMap[toPortId];
+ Port &toPort = toNode.ports[toPortIdx];
+
+ if (width < 0) {
+ assert(fromBit == 0 && toBit == 0);
+ assert(fromPort.bits.size() == toPort.bits.size());
+ width = fromPort.bits.size();
+ }
+
+ assert(fromBit >= 0 && toBit >= 0);
+ for (int i = 0; i < width; i++)
+ {
+ assert(fromBit + i < int(fromPort.bits.size()));
+ assert(toBit + i < int(toPort.bits.size()));
+
+ int fromEdgeIdx = fromPort.bits[fromBit + i].edgeIdx;
+ int toEdgeIdx = toPort.bits[toBit + i].edgeIdx;
+
+ if (fromEdgeIdx == toEdgeIdx)
+ continue;
+
+ // merge toEdge into fromEdge
+ if (edges[toEdgeIdx].isExtern)
+ edges[fromEdgeIdx].isExtern = true;
+ if (edges[toEdgeIdx].constValue) {
+ assert(edges[fromEdgeIdx].constValue == 0);
+ edges[fromEdgeIdx].constValue = edges[toEdgeIdx].constValue;
+ }
+ for (const auto &ref : edges[toEdgeIdx].portBits) {
+ edges[fromEdgeIdx].portBits.insert(ref);
+ nodes[ref.nodeIdx].ports[ref.portIdx].bits[ref.bitIdx].edgeIdx = fromEdgeIdx;
+ }
+
+ // remove toEdge (move last edge over toEdge if needed)
+ if (toEdgeIdx+1 != int(edges.size())) {
+ edges[toEdgeIdx] = edges.back();
+ for (const auto &ref : edges[toEdgeIdx].portBits)
+ nodes[ref.nodeIdx].ports[ref.portIdx].bits[ref.bitIdx].edgeIdx = toEdgeIdx;
+ }
+ edges.pop_back();
+ }
+}
+
+void SubCircuit::Graph::createConnection(std::string fromNodeId, std::string fromPortId, std::string toNodeId, std::string toPortId)
+{
+ createConnection(fromNodeId, fromPortId, 0, toNodeId, toPortId, 0, -1);
+}
+
+void SubCircuit::Graph::createConstant(std::string toNodeId, std::string toPortId, int toBit, int constValue)
+{
+ assert(nodeMap.count(toNodeId) != 0);
+ int toNodeIdx = nodeMap[toNodeId];
+ Node &toNode = nodes[toNodeIdx];
+
+ assert(toNode.portMap.count(toPortId) != 0);
+ int toPortIdx = toNode.portMap[toPortId];
+ Port &toPort = toNode.ports[toPortIdx];
+
+ assert(toBit >= 0 && toBit < int(toPort.bits.size()));
+ int toEdgeIdx = toPort.bits[toBit].edgeIdx;
+
+ assert(edges[toEdgeIdx].constValue == 0);
+ edges[toEdgeIdx].constValue = constValue;
+}
+
+void SubCircuit::Graph::createConstant(std::string toNodeId, std::string toPortId, int constValue)
+{
+ assert(nodeMap.count(toNodeId) != 0);
+ int toNodeIdx = nodeMap[toNodeId];
+ Node &toNode = nodes[toNodeIdx];
+
+ assert(toNode.portMap.count(toPortId) != 0);
+ int toPortIdx = toNode.portMap[toPortId];
+ Port &toPort = toNode.ports[toPortIdx];
+
+ for (int i = 0; i < int(toPort.bits.size()); i++) {
+ int toEdgeIdx = toPort.bits[i].edgeIdx;
+ assert(edges[toEdgeIdx].constValue == 0);
+ edges[toEdgeIdx].constValue = constValue % 2 ? '1' : '0';
+ constValue = constValue >> 1;
+ }
+}
+
+void SubCircuit::Graph::markExtern(std::string nodeId, std::string portId, int bit)
+{
+ assert(nodeMap.count(nodeId) != 0);
+ Node &node = nodes[nodeMap[nodeId]];
+
+ assert(node.portMap.count(portId) != 0);
+ Port &port = node.ports[node.portMap[portId]];
+
+ if (bit < 0) {
+ for (const auto portBit : port.bits)
+ edges[portBit.edgeIdx].isExtern = true;
+ } else {
+ assert(bit < int(port.bits.size()));
+ edges[port.bits[bit].edgeIdx].isExtern = true;
+ }
+}
+
+void SubCircuit::Graph::markAllExtern()
+{
+ allExtern = true;
+}
+
+void SubCircuit::Graph::print()
+{
+ for (int i = 0; i < int(nodes.size()); i++) {
+ const Node &node = nodes[i];
+ printf("NODE %d: %s (%s)\n", i, node.nodeId.c_str(), node.typeId.c_str());
+ for (int j = 0; j < int(node.ports.size()); j++) {
+ const Port &port = node.ports[j];
+ printf(" PORT %d: %s (%d/%d)\n", j, port.portId.c_str(), port.minWidth, int(port.bits.size()));
+ for (int k = 0; k < int(port.bits.size()); k++) {
+ int edgeIdx = port.bits[k].edgeIdx;
+ printf(" BIT %d (%d):", k, edgeIdx);
+ for (const auto &ref : edges[edgeIdx].portBits)
+ printf(" %d.%d.%d", ref.nodeIdx, ref.portIdx, ref.bitIdx);
+ if (edges[edgeIdx].isExtern)
+ printf(" [extern]");
+ printf("\n");
+ }
+ }
+ }
+}
+
+class SubCircuit::SolverWorker
+{
+ // basic internal data structures
+
+ typedef std::vector<std::map<int, int>> adjMatrix_t;
+
+ struct GraphData {
+ std::string graphId;
+ Graph graph;
+ adjMatrix_t adjMatrix;
+ std::vector<bool> usedNodes;
+ };
+
+ static void printAdjMatrix(const adjMatrix_t &matrix)
+ {
+ printf("%7s", "");
+ for (int i = 0; i < int(matrix.size()); i++)
+ printf("%4d:", i);
+ printf("\n");
+ for (int i = 0; i < int(matrix.size()); i++) {
+ printf("%5d:", i);
+ for (int j = 0; j < int(matrix.size()); j++)
+ if (matrix.at(i).count(j) == 0)
+ printf("%5s", "-");
+ else
+ printf("%5d", matrix.at(i).at(j));
+ printf("\n");
+ }
+ }
+
+ // helper functions for handling permutations
+
+ static const int maxPermutationsLimit = 1000000;
+
+ static int numberOfPermutations(const std::vector<std::string> &list)
+ {
+ int numPermutations = 1;
+ for (int i = 0; i < int(list.size()); i++) {
+ assert(numPermutations < maxPermutationsLimit);
+ numPermutations *= i+1;
+ }
+ return numPermutations;
+ }
+
+ static void permutateVectorToMap(std::map<std::string, std::string> &map, const std::vector<std::string> &list, int idx)
+ {
+ // convert idx to a list.size() digits factoradic number
+
+ std::vector<int> factoradicDigits;
+ for (int i = 0; i < int(list.size()); i++) {
+ factoradicDigits.push_back(idx % (i+1));
+ idx = idx / (i+1);
+ }
+
+ // construct permutation
+
+ std::vector<std::string> pool = list;
+ std::vector<std::string> permutation;
+
+ while (!factoradicDigits.empty()) {
+ int i = factoradicDigits.back();
+ factoradicDigits.pop_back();
+ permutation.push_back(pool[i]);
+ pool.erase(pool.begin() + i);
+ }
+
+ // update map
+
+ for (int i = 0; i < int(list.size()); i++)
+ map[list[i]] = permutation[i];
+ }
+
+ static int numberOfPermutationsArray(const std::vector<std::vector<std::string>> &list)
+ {
+ int numPermutations = 1;
+ for (const auto &it : list) {
+ int thisPermutations = numberOfPermutations(it);
+ assert(float(numPermutations) * float(thisPermutations) < maxPermutationsLimit);
+ numPermutations *= thisPermutations;
+ }
+ return numPermutations;
+ }
+
+ static void permutateVectorToMapArray(std::map<std::string, std::string> &map, const std::vector<std::vector<std::string>> &list, int idx)
+ {
+ for (const auto &it : list) {
+ int thisPermutations = numberOfPermutations(it);
+ int thisIdx = idx % thisPermutations;
+ permutateVectorToMap(map, it, thisIdx);
+ idx /= thisPermutations;
+ }
+ }
+
+ static void applyPermutation(std::map<std::string, std::string> &map, const std::map<std::string, std::string> &permutation)
+ {
+ std::vector<std::pair<std::string, std::string>> changeLog;
+ for (const auto &it : permutation)
+ if (map.count(it.second))
+ changeLog.push_back(std::pair<std::string, std::string>(it.first, map.at(it.second)));
+ else
+ changeLog.push_back(std::pair<std::string, std::string>(it.first, it.second));
+ for (const auto &it : changeLog)
+ map[it.first] = it.second;
+ }
+
+ // classes for internal digraph representation
+
+ struct DiBit
+ {
+ std::string fromPort, toPort;
+ int fromBit, toBit;
+
+ DiBit() : fromPort(), toPort(), fromBit(-1), toBit(-1) { }
+ DiBit(std::string fromPort, int fromBit, std::string toPort, int toBit) : fromPort(fromPort), toPort(toPort), fromBit(fromBit), toBit(toBit) { }
+
+ bool operator < (const DiBit &other) const
+ {
+ if (fromPort != other.fromPort)
+ return fromPort < other.fromPort;
+ if (toPort != other.toPort)
+ return toPort < other.toPort;
+ if (fromBit != other.fromBit)
+ return fromBit < other.fromBit;
+ return toBit < other.toBit;
+ }
+
+ std::string toString() const
+ {
+ return stringf("%s[%d]:%s[%d]", fromPort.c_str(), fromBit, toPort.c_str(), toBit);
+ }
+ };
+
+ struct DiNode
+ {
+ std::string typeId;
+ std::map<std::string, int> portSizes;
+
+ DiNode()
+ {
+ }
+
+ DiNode(const Graph &graph, int nodeIdx)
+ {
+ const Graph::Node &node = graph.nodes.at(nodeIdx);
+ typeId = node.typeId;
+ for (const auto &port : node.ports)
+ portSizes[port.portId] = port.bits.size();
+ }
+
+ bool operator < (const DiNode &other) const
+ {
+ if (typeId != other.typeId)
+ return typeId < other.typeId;
+ return portSizes < other.portSizes;
+ }
+
+ std::string toString() const
+ {
+ std::string str;
+ bool firstPort = true;
+ for (const auto &it : portSizes) {
+ str += stringf("%s%s[%d]", firstPort ? "" : ",", it.first.c_str(), it.second);
+ firstPort = false;
+ }
+ return typeId + "(" + str + ")";
+ }
+ };
+
+ struct DiEdge
+ {
+ DiNode fromNode, toNode;
+ std::set<DiBit> bits;
+ std::string userAnnotation;
+
+ bool operator < (const DiEdge &other) const
+ {
+ if (fromNode < other.fromNode || other.fromNode < fromNode)
+ return fromNode < other.fromNode;
+ if (toNode < other.toNode || other.toNode < toNode)
+ return toNode < other.toNode;
+ if (bits < other.bits || other.bits < bits)
+ return bits < other.bits;
+ return userAnnotation < other.userAnnotation;
+ }
+
+ bool compare(const DiEdge &other, const std::map<std::string, std::string> &mapFromPorts, const std::map<std::string, std::string> &mapToPorts) const
+ {
+ // Rules for matching edges:
+ //
+ // For all bits in the needle edge:
+ // - ignore if needle ports don't exist in haystack edge
+ // - otherwise: matching bit in haystack edge must exist
+ //
+ // There is no need to check in the other direction, as checking
+ // of the isExtern properties is already performed in node matching.
+ //
+ // Note: "this" is needle, "other" is haystack
+
+ for (auto bit : bits)
+ {
+ if (mapFromPorts.count(bit.fromPort) > 0)
+ bit.fromPort = mapFromPorts.at(bit.fromPort);
+ if (mapToPorts.count(bit.toPort) > 0)
+ bit.toPort = mapToPorts.at(bit.toPort);
+
+ if (other.fromNode.portSizes.count(bit.fromPort) == 0)
+ continue;
+ if (other.toNode.portSizes.count(bit.toPort) == 0)
+ continue;
+
+ if (bit.fromBit >= other.fromNode.portSizes.at(bit.fromPort))
+ continue;
+ if (bit.toBit >= other.toNode.portSizes.at(bit.toPort))
+ continue;
+
+ if (other.bits.count(bit) == 0)
+ return false;
+ }
+
+ return true;
+ }
+
+ bool compareWithFromAndToPermutations(const DiEdge &other, const std::map<std::string, std::string> &mapFromPorts, const std::map<std::string, std::string> &mapToPorts,
+ const std::map<std::string, std::set<std::map<std::string, std::string>>> &swapPermutations) const
+ {
+ if (swapPermutations.count(fromNode.typeId) > 0)
+ for (const auto &permutation : swapPermutations.at(fromNode.typeId)) {
+ std::map<std::string, std::string> thisMapFromPorts = mapFromPorts;
+ applyPermutation(thisMapFromPorts, permutation);
+ if (compareWithToPermutations(other, thisMapFromPorts, mapToPorts, swapPermutations))
+ return true;
+ }
+ return compareWithToPermutations(other, mapFromPorts, mapToPorts, swapPermutations);
+ }
+
+ bool compareWithToPermutations(const DiEdge &other, const std::map<std::string, std::string> &mapFromPorts, const std::map<std::string, std::string> &mapToPorts,
+ const std::map<std::string, std::set<std::map<std::string, std::string>>> &swapPermutations) const
+ {
+ if (swapPermutations.count(toNode.typeId) > 0)
+ for (const auto &permutation : swapPermutations.at(toNode.typeId)) {
+ std::map<std::string, std::string> thisMapToPorts = mapToPorts;
+ applyPermutation(thisMapToPorts, permutation);
+ if (compare(other, mapFromPorts, thisMapToPorts))
+ return true;
+ }
+ return compare(other, mapFromPorts, mapToPorts);
+ }
+
+ bool compare(const DiEdge &other, const std::map<std::string, std::set<std::set<std::string>>> &swapPorts,
+ const std::map<std::string, std::set<std::map<std::string, std::string>>> &swapPermutations) const
+ {
+ // brute force method for port swapping: try all variations
+
+ std::vector<std::vector<std::string>> swapFromPorts;
+ std::vector<std::vector<std::string>> swapToPorts;
+
+ // only use groups that are relevant for this edge
+
+ if (swapPorts.count(fromNode.typeId) > 0)
+ for (const auto &ports : swapPorts.at(fromNode.typeId)) {
+ for (const auto &bit : bits)
+ if (ports.count(bit.fromPort))
+ goto foundFromPortMatch;
+ if (0) {
+ foundFromPortMatch:
+ std::vector<std::string> portsVector;
+ for (const auto &port : ports)
+ portsVector.push_back(port);
+ swapFromPorts.push_back(portsVector);
+ }
+ }
+
+ if (swapPorts.count(toNode.typeId) > 0)
+ for (const auto &ports : swapPorts.at(toNode.typeId)) {
+ for (const auto &bit : bits)
+ if (ports.count(bit.toPort))
+ goto foundToPortMatch;
+ if (0) {
+ foundToPortMatch:
+ std::vector<std::string> portsVector;
+ for (const auto &port : ports)
+ portsVector.push_back(port);
+ swapToPorts.push_back(portsVector);
+ }
+ }
+
+ // try all permutations
+
+ std::map<std::string, std::string> mapFromPorts, mapToPorts;
+ int fromPortsPermutations = numberOfPermutationsArray(swapFromPorts);
+ int toPortsPermutations = numberOfPermutationsArray(swapToPorts);
+
+ for (int i = 0; i < fromPortsPermutations; i++)
+ {
+ permutateVectorToMapArray(mapFromPorts, swapFromPorts, i);
+
+ for (int j = 0; j < toPortsPermutations; j++) {
+ permutateVectorToMapArray(mapToPorts, swapToPorts, j);
+ if (compareWithFromAndToPermutations(other, mapFromPorts, mapToPorts, swapPermutations))
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ bool compare(const DiEdge &other, const std::map<std::string, std::string> &mapFromPorts, const std::map<std::string, std::set<std::set<std::string>>> &swapPorts,
+ const std::map<std::string, std::set<std::map<std::string, std::string>>> &swapPermutations) const
+ {
+ // strip-down version of the last function: only try permutations for mapToPorts, mapFromPorts is already provided by the caller
+
+ std::vector<std::vector<std::string>> swapToPorts;
+
+ if (swapPorts.count(toNode.typeId) > 0)
+ for (const auto &ports : swapPorts.at(toNode.typeId)) {
+ for (const auto &bit : bits)
+ if (ports.count(bit.toPort))
+ goto foundToPortMatch;
+ if (0) {
+ foundToPortMatch:
+ std::vector<std::string> portsVector;
+ for (const auto &port : ports)
+ portsVector.push_back(port);
+ swapToPorts.push_back(portsVector);
+ }
+ }
+
+ std::map<std::string, std::string> mapToPorts;
+ int toPortsPermutations = numberOfPermutationsArray(swapToPorts);
+
+ for (int j = 0; j < toPortsPermutations; j++) {
+ permutateVectorToMapArray(mapToPorts, swapToPorts, j);
+ if (compareWithToPermutations(other, mapFromPorts, mapToPorts, swapPermutations))
+ return true;
+ }
+
+ return false;
+ }
+
+ std::string toString() const
+ {
+ std::string buffer = fromNode.toString() + " " + toNode.toString();
+ for (const auto &bit : bits)
+ buffer += " " + bit.toString();
+ if (!userAnnotation.empty())
+ buffer += " " + userAnnotation;
+ return buffer;
+ }
+
+ static void findEdgesInGraph(const Graph &graph, std::map<std::pair<int, int>, DiEdge> &edges)
+ {
+ edges.clear();
+ for (const auto &edge : graph.edges) {
+ if (edge.constValue != 0)
+ continue;
+ for (const auto &fromBit : edge.portBits)
+ for (const auto &toBit : edge.portBits)
+ if (&fromBit != &toBit) {
+ DiEdge &de = edges[std::pair<int, int>(fromBit.nodeIdx, toBit.nodeIdx)];
+ de.fromNode = DiNode(graph, fromBit.nodeIdx);
+ de.toNode = DiNode(graph, toBit.nodeIdx);
+ std::string fromPortId = graph.nodes[fromBit.nodeIdx].ports[fromBit.portIdx].portId;
+ std::string toPortId = graph.nodes[toBit.nodeIdx].ports[toBit.portIdx].portId;
+ de.bits.insert(DiBit(fromPortId, fromBit.bitIdx, toPortId, toBit.bitIdx));
+ }
+ }
+ }
+ };
+
+ struct DiCache
+ {
+ std::map<DiEdge, int> edgeTypesMap;
+ std::vector<DiEdge> edgeTypes;
+ std::map<std::pair<int, int>, bool> compareCache;
+
+ void add(const Graph &graph, adjMatrix_t &adjMatrix, const std::string &graphId, Solver *userSolver)
+ {
+ std::map<std::pair<int, int>, DiEdge> edges;
+ DiEdge::findEdgesInGraph(graph, edges);
+
+ adjMatrix.clear();
+ adjMatrix.resize(graph.nodes.size());
+
+ for (auto &it : edges) {
+ const Graph::Node &fromNode = graph.nodes[it.first.first];
+ const Graph::Node &toNode = graph.nodes[it.first.second];
+ it.second.userAnnotation = userSolver->userAnnotateEdge(graphId, fromNode.nodeId, fromNode.userData, toNode.nodeId, toNode.userData);
+ }
+
+ for (const auto &it : edges) {
+ if (edgeTypesMap.count(it.second) == 0) {
+ edgeTypesMap[it.second] = edgeTypes.size();
+ edgeTypes.push_back(it.second);
+ }
+ adjMatrix[it.first.first][it.first.second] = edgeTypesMap[it.second];
+ }
+ }
+
+ bool compare(int needleEdge, int haystackEdge, const std::map<std::string, std::set<std::set<std::string>>> &swapPorts,
+ const std::map<std::string, std::set<std::map<std::string, std::string>>> &swapPermutations)
+ {
+ std::pair<int, int> key(needleEdge, haystackEdge);
+ if (!compareCache.count(key))
+ compareCache[key] = edgeTypes.at(needleEdge).compare(edgeTypes.at(haystackEdge), swapPorts, swapPermutations);
+ return compareCache[key];
+ }
+
+ bool compare(int needleEdge, int haystackEdge, const std::map<std::string, std::string> &mapFromPorts, const std::map<std::string, std::set<std::set<std::string>>> &swapPorts,
+ const std::map<std::string, std::set<std::map<std::string, std::string>>> &swapPermutations) const
+ {
+ return edgeTypes.at(needleEdge).compare(edgeTypes.at(haystackEdge), mapFromPorts, swapPorts, swapPermutations);
+ }
+
+ bool compare(int needleEdge, int haystackEdge, const std::map<std::string, std::string> &mapFromPorts, const std::map<std::string, std::string> &mapToPorts) const
+ {
+ return edgeTypes.at(needleEdge).compare(edgeTypes.at(haystackEdge), mapFromPorts, mapToPorts);
+ }
+
+ void printEdgeTypes() const
+ {
+ for (int i = 0; i < int(edgeTypes.size()); i++)
+ printf("%5d: %s\n", i, edgeTypes[i].toString().c_str());
+ }
+ };
+
+ // solver state variables
+
+ Solver *userSolver;
+ std::map<std::string, GraphData> graphData;
+ std::map<std::string, std::set<std::string>> compatibleTypes;
+ std::map<int, std::set<int>> compatibleConstants;
+ std::map<std::string, std::set<std::set<std::string>>> swapPorts;
+ std::map<std::string, std::set<std::map<std::string, std::string>>> swapPermutations;
+ DiCache diCache;
+ bool verbose;
+
+ // main solver functions
+
+ bool matchNodes(const Graph &needle, int needleNodeIdx, const Graph &haystack, int haystackNodeIdx) const
+ {
+ // Rules for matching nodes:
+ //
+ // 1. their typeId must be identical or compatible
+ // (this is checked before calling this function)
+ //
+ // 2. they must have the same ports and the haystack port
+ // widths must match the needle port width range
+ //
+ // 3. All edges from the needle must match the haystack:
+ // a) if the needle edge is extern:
+ // - the haystack edge must have at least as many components as the needle edge
+ // b) if the needle edge is not extern:
+ // - the haystack edge must have the same number of components as the needle edge
+ // - the haystack edge must not be extern
+
+ const Graph::Node &nn = needle.nodes[needleNodeIdx];
+ const Graph::Node &hn = haystack.nodes[haystackNodeIdx];
+
+ assert(nn.typeId == hn.typeId || (compatibleTypes.count(nn.typeId) > 0 && compatibleTypes.at(nn.typeId).count(hn.typeId) > 0));
+
+ if (nn.ports.size() != hn.ports.size())
+ return false;
+
+ for (int i = 0; i < int(nn.ports.size()); i++)
+ {
+ if (hn.portMap.count(nn.ports[i].portId) == 0)
+ return false;
+
+ const Graph::Port &np = nn.ports[i];
+ const Graph::Port &hp = hn.ports[hn.portMap.at(nn.ports[i].portId)];
+
+ if (int(hp.bits.size()) < np.minWidth || hp.bits.size() > np.bits.size())
+ return false;
+
+ for (int j = 0; j < int(hp.bits.size()); j++)
+ {
+ const Graph::Edge &ne = needle.edges[np.bits[j].edgeIdx];
+ const Graph::Edge &he = haystack.edges[hp.bits[j].edgeIdx];
+
+ if (ne.constValue || he.constValue) {
+ if (ne.constValue != he.constValue)
+ if (compatibleConstants.count(ne.constValue) == 0 || compatibleConstants.at(ne.constValue).count(he.constValue) == 0)
+ return false;
+ continue;
+ }
+
+ if (ne.isExtern || needle.allExtern) {
+ if (he.portBits.size() < ne.portBits.size())
+ return false;
+ } else {
+ if (he.portBits.size() != ne.portBits.size())
+ return false;
+ if (he.isExtern || haystack.allExtern)
+ return false;
+ }
+ }
+ }
+
+ return true;
+ }
+
+ void generateEnumerationMatrix(std::vector<std::set<int>> &enumerationMatrix, const GraphData &needle, const GraphData &haystack, const std::map<std::string, std::set<std::string>> &initialMappings) const
+ {
+ std::map<std::string, std::set<int>> haystackNodesByTypeId;
+ for (int i = 0; i < int(haystack.graph.nodes.size()); i++)
+ haystackNodesByTypeId[haystack.graph.nodes[i].typeId].insert(i);
+
+ enumerationMatrix.clear();
+ enumerationMatrix.resize(needle.graph.nodes.size());
+ for (int i = 0; i < int(needle.graph.nodes.size()); i++)
+ {
+ const Graph::Node &nn = needle.graph.nodes[i];
+
+ for (int j : haystackNodesByTypeId[nn.typeId]) {
+ const Graph::Node &hn = haystack.graph.nodes[j];
+ if (initialMappings.count(nn.nodeId) > 0 && initialMappings.at(nn.nodeId).count(hn.nodeId) == 0)
+ continue;
+ if (!matchNodes(needle.graph, i, haystack.graph, j))
+ continue;
+ if (userSolver->userCompareNodes(needle.graphId, nn.nodeId, nn.userData, haystack.graphId, hn.nodeId, hn.userData))
+ enumerationMatrix[i].insert(j);
+ }
+
+ if (compatibleTypes.count(nn.typeId) > 0)
+ for (const std::string &compatibleTypeId : compatibleTypes.at(nn.typeId))
+ for (int j : haystackNodesByTypeId[compatibleTypeId]) {
+ const Graph::Node &hn = haystack.graph.nodes[j];
+ if (initialMappings.count(nn.nodeId) > 0 && initialMappings.at(nn.nodeId).count(hn.nodeId) == 0)
+ continue;
+ if (!matchNodes(needle.graph, i, haystack.graph, j))
+ continue;
+ if (userSolver->userCompareNodes(needle.graphId, nn.nodeId, nn.userData, haystack.graphId, hn.nodeId, hn.userData))
+ enumerationMatrix[i].insert(j);
+ }
+ }
+ }
+
+ bool checkEnumerationMatrix(std::vector<std::set<int>> &enumerationMatrix, int i, int j, const GraphData &needle, const GraphData &haystack)
+ {
+ for (const auto &it_needle : needle.adjMatrix.at(i))
+ {
+ int needleNeighbour = it_needle.first;
+ int needleEdgeType = it_needle.second;
+
+ for (int haystackNeighbour : enumerationMatrix[needleNeighbour])
+ if (haystack.adjMatrix.at(j).count(haystackNeighbour) > 0) {
+ int haystackEdgeType = haystack.adjMatrix.at(j).at(haystackNeighbour);
+ if (diCache.compare(needleEdgeType, haystackEdgeType, swapPorts, swapPermutations)) {
+ const Graph::Node &needleFromNode = needle.graph.nodes[i];
+ const Graph::Node &needleToNode = needle.graph.nodes[needleNeighbour];
+ const Graph::Node &haystackFromNode = haystack.graph.nodes[j];
+ const Graph::Node &haystackToNode = haystack.graph.nodes[haystackNeighbour];
+ if (userSolver->userCompareEdge(needle.graphId, needleFromNode.nodeId, needleFromNode.userData, needleToNode.nodeId, needleToNode.userData,
+ haystack.graphId, haystackFromNode.nodeId, haystackFromNode.userData, haystackToNode.nodeId, haystackToNode.userData))
+ goto found_match;
+ }
+ }
+
+ return false;
+ found_match:;
+ }
+
+ return true;
+ }
+
+ bool pruneEnumerationMatrix(std::vector<std::set<int>> &enumerationMatrix, const GraphData &needle, const GraphData &haystack, int &nextRow)
+ {
+ bool didSomething = true;
+ while (didSomething)
+ {
+ nextRow = -1;
+ didSomething = false;
+ for (int i = 0; i < int(enumerationMatrix.size()); i++) {
+ std::set<int> newRow;
+ for (int j : enumerationMatrix[i]) {
+ if (checkEnumerationMatrix(enumerationMatrix, i, j, needle, haystack))
+ newRow.insert(j);
+ else
+ didSomething = true;
+ }
+ if (newRow.size() == 0)
+ return false;
+ if (newRow.size() >= 2 && (nextRow < 0 || needle.adjMatrix.at(nextRow).size() < needle.adjMatrix.at(i).size()))
+ nextRow = i;
+ enumerationMatrix[i].swap(newRow);
+ }
+ }
+ return true;
+ }
+
+ void printEnumerationMatrix(const std::vector<std::set<int>> &enumerationMatrix, int maxHaystackNodeIdx = -1) const
+ {
+ if (maxHaystackNodeIdx < 0) {
+ for (const auto &it : enumerationMatrix)
+ for (int idx : it)
+ maxHaystackNodeIdx = std::max(maxHaystackNodeIdx, idx);
+ }
+
+ printf(" ");
+ for (int j = 0; j < maxHaystackNodeIdx; j += 5)
+ printf("%-6d", j);
+ printf("\n");
+
+ for (int i = 0; i < int(enumerationMatrix.size()); i++)
+ {
+ printf("%5d:", i);
+ for (int j = 0; j < maxHaystackNodeIdx; j++) {
+ if (j % 5 == 0)
+ printf(" ");
+ printf("%c", enumerationMatrix[i].count(j) > 0 ? '*' : '.');
+ }
+ printf("\n");
+ }
+ }
+
+ bool checkPortmapCandidate(const std::vector<std::set<int>> &enumerationMatrix, const GraphData &needle, const GraphData &haystack, int idx, const std::map<std::string, std::string> ¤tCandidate)
+ {
+ assert(enumerationMatrix[idx].size() == 1);
+ int idxHaystack = *enumerationMatrix[idx].begin();
+
+ for (const auto &it_needle : needle.adjMatrix.at(idx))
+ {
+ int needleNeighbour = it_needle.first;
+ int needleEdgeType = it_needle.second;
+
+ assert(enumerationMatrix[needleNeighbour].size() == 1);
+ int haystackNeighbour = *enumerationMatrix[needleNeighbour].begin();
+
+ assert(haystack.adjMatrix.at(idxHaystack).count(haystackNeighbour) > 0);
+ int haystackEdgeType = haystack.adjMatrix.at(idxHaystack).at(haystackNeighbour);
+ if (!diCache.compare(needleEdgeType, haystackEdgeType, currentCandidate, swapPorts, swapPermutations))
+ return false;
+ }
+ return true;
+ }
+
+ void generatePortmapCandidates(std::set<std::map<std::string, std::string>> &portmapCandidates, const std::vector<std::set<int>> &enumerationMatrix,
+ const GraphData &needle, const GraphData &haystack, int idx)
+ {
+ std::map<std::string, std::string> currentCandidate;
+
+ for (const auto &port : needle.graph.nodes[idx].ports)
+ currentCandidate[port.portId] = port.portId;
+
+ if (swapPorts.count(needle.graph.nodes[idx].typeId) == 0)
+ {
+ if (checkPortmapCandidate(enumerationMatrix, needle, haystack, idx, currentCandidate))
+ portmapCandidates.insert(currentCandidate);
+
+ if (swapPermutations.count(needle.graph.nodes[idx].typeId) > 0)
+ for (const auto &permutation : swapPermutations.at(needle.graph.nodes[idx].typeId)) {
+ std::map<std::string, std::string> currentSubCandidate = currentCandidate;
+ applyPermutation(currentSubCandidate, permutation);
+ if (checkPortmapCandidate(enumerationMatrix, needle, haystack, idx, currentSubCandidate))
+ portmapCandidates.insert(currentSubCandidate);
+ }
+ }
+ else
+ {
+ std::vector<std::vector<std::string>> thisSwapPorts;
+ for (const auto &ports : swapPorts.at(needle.graph.nodes[idx].typeId)) {
+ std::vector<std::string> portsVector;
+ for (const auto &port : ports)
+ portsVector.push_back(port);
+ thisSwapPorts.push_back(portsVector);
+ }
+
+ int thisPermutations = numberOfPermutationsArray(thisSwapPorts);
+ for (int i = 0; i < thisPermutations; i++)
+ {
+ permutateVectorToMapArray(currentCandidate, thisSwapPorts, i);
+
+ if (checkPortmapCandidate(enumerationMatrix, needle, haystack, idx, currentCandidate))
+ portmapCandidates.insert(currentCandidate);
+
+ if (swapPermutations.count(needle.graph.nodes[idx].typeId) > 0)
+ for (const auto &permutation : swapPermutations.at(needle.graph.nodes[idx].typeId)) {
+ std::map<std::string, std::string> currentSubCandidate = currentCandidate;
+ applyPermutation(currentSubCandidate, permutation);
+ if (checkPortmapCandidate(enumerationMatrix, needle, haystack, idx, currentSubCandidate))
+ portmapCandidates.insert(currentSubCandidate);
+ }
+ }
+ }
+ }
+
+ bool prunePortmapCandidates(std::vector<std::set<std::map<std::string, std::string>>> &portmapCandidates, std::vector<std::set<int>> enumerationMatrix, const GraphData &needle, const GraphData &haystack)
+ {
+ bool didSomething = false;
+
+ // strategy #1: prune impossible port mappings
+
+ for (int i = 0; i < int(needle.graph.nodes.size()); i++)
+ {
+ assert(enumerationMatrix[i].size() == 1);
+ int j = *enumerationMatrix[i].begin();
+
+ std::set<std::map<std::string, std::string>> thisCandidates;
+ portmapCandidates[i].swap(thisCandidates);
+
+ for (const auto &testCandidate : thisCandidates)
+ {
+ for (const auto &it_needle : needle.adjMatrix.at(i))
+ {
+ int needleNeighbour = it_needle.first;
+ int needleEdgeType = it_needle.second;
+
+ assert(enumerationMatrix[needleNeighbour].size() == 1);
+ int haystackNeighbour = *enumerationMatrix[needleNeighbour].begin();
+
+ assert(haystack.adjMatrix.at(j).count(haystackNeighbour) > 0);
+ int haystackEdgeType = haystack.adjMatrix.at(j).at(haystackNeighbour);
+
+ for (const auto &otherCandidate : portmapCandidates[needleNeighbour]) {
+ if (diCache.compare(needleEdgeType, haystackEdgeType, testCandidate, otherCandidate))
+ goto found_match;
+ }
+
+ didSomething = true;
+ goto purgeCandidate;
+ found_match:;
+ }
+
+ portmapCandidates[i].insert(testCandidate);
+ purgeCandidate:;
+ }
+
+ if (portmapCandidates[i].size() == 0)
+ return false;
+ }
+
+ if (didSomething)
+ return true;
+
+ // strategy #2: prune a single random port mapping
+
+ for (int i = 0; i < int(needle.graph.nodes.size()); i++)
+ if (portmapCandidates[i].size() > 1) {
+ // remove last mapping. this keeps ports unswapped in don't-care situations
+ portmapCandidates[i].erase(--portmapCandidates[i].end());
+ return true;
+ }
+
+ return false;
+ }
+
+ void ullmannRecursion(std::vector<Solver::Result> &results, std::vector<std::set<int>> &enumerationMatrix, int iter, const GraphData &needle, GraphData &haystack, bool allowOverlap, int limitResults)
+ {
+ int i = -1;
+ if (!pruneEnumerationMatrix(enumerationMatrix, needle, haystack, i))
+ return;
+
+ if (i < 0)
+ {
+ Solver::Result result;
+ result.needleGraphId = needle.graphId;
+ result.haystackGraphId = haystack.graphId;
+
+ std::vector<std::set<std::map<std::string, std::string>>> portmapCandidates;
+ portmapCandidates.resize(enumerationMatrix.size());
+
+ for (int j = 0; j < int(enumerationMatrix.size()); j++) {
+ Solver::ResultNodeMapping mapping;
+ mapping.needleNodeId = needle.graph.nodes[j].nodeId;
+ mapping.needleUserData = needle.graph.nodes[j].userData;
+ mapping.haystackNodeId = haystack.graph.nodes[*enumerationMatrix[j].begin()].nodeId;
+ mapping.haystackUserData = haystack.graph.nodes[*enumerationMatrix[j].begin()].userData;
+ generatePortmapCandidates(portmapCandidates[j], enumerationMatrix, needle, haystack, j);
+ result.mappings[needle.graph.nodes[j].nodeId] = mapping;
+ }
+
+ while (prunePortmapCandidates(portmapCandidates, enumerationMatrix, needle, haystack)) { }
+
+ for (int j = 0; j < int(enumerationMatrix.size()); j++) {
+ if (portmapCandidates[j].size() == 0) {
+ if (verbose) {
+ printf("\nSolution (rejected by portmapper):\n");
+ printEnumerationMatrix(enumerationMatrix, haystack.graph.nodes.size());
+ }
+ return;
+ }
+ result.mappings[needle.graph.nodes[j].nodeId].portMapping = *portmapCandidates[j].begin();
+ }
+
+ if (!userSolver->userCheckSolution(result)) {
+ if (verbose) {
+ printf("\nSolution (rejected by userCheckSolution):\n");
+ printEnumerationMatrix(enumerationMatrix, haystack.graph.nodes.size());
+ }
+ return;
+ }
+
+ for (int j = 0; j < int(enumerationMatrix.size()); j++)
+ haystack.usedNodes[*enumerationMatrix[j].begin()] = true;
+
+ if (verbose) {
+ printf("\nSolution:\n");
+ printEnumerationMatrix(enumerationMatrix, haystack.graph.nodes.size());
+ }
+
+ results.push_back(result);
+ return;
+ }
+
+ if (verbose) {
+ printf("\n");
+ printf("Enumeration Matrix at recursion level %d (%d):\n", iter, i);
+ printEnumerationMatrix(enumerationMatrix, haystack.graph.nodes.size());
+ }
+
+ std::set<int> activeRow;
+ enumerationMatrix[i].swap(activeRow);
+
+ for (int j : activeRow)
+ {
+ // found enough?
+ if (limitResults >= 0 && int(results.size()) >= limitResults)
+ return;
+
+ // already used by other solution -> try next
+ if (!allowOverlap && haystack.usedNodes[j])
+ continue;
+
+ // create enumeration matrix for child in recursion tree
+ std::vector<std::set<int>> nextEnumerationMatrix = enumerationMatrix;
+ for (int k = 0; k < int(nextEnumerationMatrix.size()); k++)
+ nextEnumerationMatrix[k].erase(j);
+ nextEnumerationMatrix[i].insert(j);
+
+ // recursion
+ ullmannRecursion(results, nextEnumerationMatrix, iter+1, needle, haystack, allowOverlap, limitResults);
+
+ // we just have found something -> unroll to top recursion level
+ if (!allowOverlap && haystack.usedNodes[j] && iter > 0)
+ return;
+ }
+ }
+
+ // interface to the public Solver class
+
+protected:
+ SolverWorker(Solver *userSolver) : userSolver(userSolver), verbose(false)
+ {
+ }
+
+ void setVerbose()
+ {
+ verbose = true;
+ }
+
+ void addGraph(std::string graphId, const Graph &graph)
+ {
+ assert(graphData.count(graphId) == 0);
+
+ GraphData &gd = graphData[graphId];
+ gd.graphId = graphId;
+ gd.graph = graph;
+ diCache.add(gd.graph, gd.adjMatrix, graphId, userSolver);
+ }
+
+ void addCompatibleTypes(std::string needleTypeId, std::string haystackTypeId)
+ {
+ compatibleTypes[needleTypeId].insert(haystackTypeId);
+ }
+
+ void addCompatibleConstants(int needleConstant, int haystackConstant)
+ {
+ compatibleConstants[needleConstant].insert(haystackConstant);
+ }
+
+ void addSwappablePorts(std::string needleTypeId, const std::set<std::string> &ports)
+ {
+ swapPorts[needleTypeId].insert(ports);
+ diCache.compareCache.clear();
+ }
+
+ void addSwappablePortsPermutation(std::string needleTypeId, const std::map<std::string, std::string> &portMapping)
+ {
+ swapPermutations[needleTypeId].insert(portMapping);
+ diCache.compareCache.clear();
+ }
+
+ void solve(std::vector<Solver::Result> &results, std::string needleGraphId, std::string haystackGraphId,
+ const std::map<std::string, std::set<std::string>> &initialMappings, bool allowOverlap, int maxSolutions)
+ {
+ assert(graphData.count(needleGraphId) > 0);
+ assert(graphData.count(haystackGraphId) > 0);
+
+ const GraphData &needle = graphData[needleGraphId];
+ GraphData &haystack = graphData[haystackGraphId];
+
+ std::vector<std::set<int>> enumerationMatrix;
+ generateEnumerationMatrix(enumerationMatrix, needle, haystack, initialMappings);
+
+ if (verbose)
+ {
+ printf("\n");
+ printf("Needle Adjecency Matrix:\n");
+ printAdjMatrix(needle.adjMatrix);
+
+ printf("\n");
+ printf("Haystack Adjecency Matrix:\n");
+ printAdjMatrix(haystack.adjMatrix);
+
+ printf("\n");
+ printf("Edge Types:\n");
+ diCache.printEdgeTypes();
+
+ printf("\n");
+ printf("Enumeration Matrix:\n");
+ printEnumerationMatrix(enumerationMatrix, haystack.graph.nodes.size());
+ }
+
+ haystack.usedNodes.resize(haystack.graph.nodes.size());
+ ullmannRecursion(results, enumerationMatrix, 0, needle, haystack, allowOverlap, maxSolutions > 0 ? results.size() + maxSolutions : -1);
+ }
+
+ void clearOverlapHistory()
+ {
+ for (auto &it : graphData)
+ it.second.usedNodes.clear();
+ }
+
+ void clearConfig()
+ {
+ compatibleTypes.clear();
+ compatibleConstants.clear();
+ swapPorts.clear();
+ swapPermutations.clear();
+ diCache.compareCache.clear();
+ }
+
+ friend class Solver;
+};
+
+bool Solver::userCompareNodes(const std::string&, const std::string&, void*, const std::string&, const std::string&, void*)
+{
+ return true;
+}
+
+std::string Solver::userAnnotateEdge(const std::string&, const std::string&, void*, const std::string&, void*)
+{
+ return std::string();
+}
+
+bool Solver::userCompareEdge(const std::string&, const std::string&, void*, const std::string&, void*, const std::string&, const std::string&, void*, const std::string&, void*)
+{
+ return true;
+}
+
+bool Solver::userCheckSolution(const Result&)
+{
+ return true;
+}
+
+SubCircuit::Solver::Solver()
+{
+ worker = new SolverWorker(this);
+}
+
+SubCircuit::Solver::~Solver()
+{
+ delete worker;
+}
+
+void SubCircuit::Solver::setVerbose()
+{
+ worker->setVerbose();
+}
+
+void SubCircuit::Solver::addGraph(std::string graphId, const Graph &graph)
+{
+ worker->addGraph(graphId, graph);
+}
+
+void SubCircuit::Solver::addCompatibleTypes(std::string needleTypeId, std::string haystackTypeId)
+{
+ worker->addCompatibleTypes(needleTypeId, haystackTypeId);
+}
+
+void SubCircuit::Solver::addCompatibleConstants(int needleConstant, int haystackConstant)
+{
+ worker->addCompatibleConstants(needleConstant, haystackConstant);
+}
+
+void SubCircuit::Solver::addSwappablePorts(std::string needleTypeId, std::string portId1, std::string portId2, std::string portId3, std::string portId4)
+{
+ std::set<std::string> ports;
+ ports.insert(portId1);
+ ports.insert(portId2);
+ ports.insert(portId3);
+ ports.insert(portId4);
+ ports.erase(std::string());
+ addSwappablePorts(needleTypeId, ports);
+}
+
+void SubCircuit::Solver::addSwappablePorts(std::string needleTypeId, std::set<std::string> ports)
+{
+ worker->addSwappablePorts(needleTypeId, ports);
+}
+
+void SubCircuit::Solver::addSwappablePortsPermutation(std::string needleTypeId, std::map<std::string, std::string> portMapping)
+{
+ worker->addSwappablePortsPermutation(needleTypeId, portMapping);
+}
+
+void SubCircuit::Solver::solve(std::vector<Result> &results, std::string needleGraphId, std::string haystackGraphId, bool allowOverlap, int maxSolutions)
+{
+ std::map<std::string, std::set<std::string>> emptyInitialMapping;
+ worker->solve(results, needleGraphId, haystackGraphId, emptyInitialMapping, allowOverlap, maxSolutions);
+}
+
+void SubCircuit::Solver::solve(std::vector<Result> &results, std::string needleGraphId, std::string haystackGraphId,
+ const std::map<std::string, std::set<std::string>> &initialMappings, bool allowOverlap, int maxSolutions)
+{
+ worker->solve(results, needleGraphId, haystackGraphId, initialMappings, allowOverlap, maxSolutions);
+}
+
+void SubCircuit::Solver::clearOverlapHistory()
+{
+ worker->clearOverlapHistory();
+}
+
+void SubCircuit::Solver::clearConfig()
+{
+ worker->clearConfig();
+}
+
--- /dev/null
+/*
+ * SubCircuit -- An implementation of the Ullmann Subgraph Isomorphism
+ * algorithm for coarse grain logic networks
+ *
+ * Copyright (C) 2013 Clifford Wolf <clifford@clifford.at>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ */
+
+#ifndef SUBCIRCUIT_H
+#define SUBCIRCUIT_H
+
+#include <string>
+#include <vector>
+#include <set>
+#include <map>
+
+namespace SubCircuit
+{
+ class SolverWorker;
+
+ class Graph
+ {
+ protected:
+ struct BitRef {
+ int nodeIdx, portIdx, bitIdx;
+ BitRef(int nodeIdx = -1, int portIdx = -1, int bitIdx = -1) : nodeIdx(nodeIdx), portIdx(portIdx), bitIdx(bitIdx) { };
+ bool operator < (const BitRef &other) const;
+ };
+
+ struct Edge {
+ std::set<BitRef> portBits;
+ int constValue;
+ bool isExtern;
+ Edge() : constValue(0), isExtern(false) { };
+ };
+
+ struct PortBit {
+ int edgeIdx;
+ PortBit() : edgeIdx(-1) { };
+ };
+
+ struct Port {
+ std::string portId;
+ int minWidth;
+ std::vector<PortBit> bits;
+ Port() : minWidth(-1) { };
+ };
+
+ struct Node {
+ std::string nodeId, typeId;
+ std::map<std::string, int> portMap;
+ std::vector<Port> ports;
+ void *userData;
+ Node() : userData(NULL) { };
+ };
+
+ bool allExtern;
+ std::map<std::string, int> nodeMap;
+ std::vector<Node> nodes;
+ std::vector<Edge> edges;
+
+ public:
+ Graph() : allExtern(false) { };
+
+ void createNode(std::string nodeId, std::string typeId, void *userData = NULL);
+ void createPort(std::string nodeId, std::string portId, int width = 1, int minWidth = -1);
+ void createConnection(std::string fromNodeId, std::string fromPortId, int fromBit, std::string toNodeId, std::string toPortId, int toBit, int width = 1);
+ void createConnection(std::string fromNodeId, std::string fromPortId, std::string toNodeId, std::string toPortId);
+ void createConstant(std::string toNodeId, std::string toPortId, int toBit, int constValue);
+ void createConstant(std::string toNodeId, std::string toPortId, int constValue);
+ void markExtern(std::string nodeId, std::string portId, int bit = -1);
+ void markAllExtern();
+ void print();
+
+ friend class SolverWorker;
+ };
+
+ class Solver
+ {
+ public:
+ struct ResultNodeMapping {
+ std::string needleNodeId, haystackNodeId;
+ void *needleUserData, *haystackUserData;
+ std::map<std::string, std::string> portMapping;
+ };
+ struct Result {
+ std::string needleGraphId, haystackGraphId;
+ std::map<std::string, ResultNodeMapping> mappings;
+ };
+
+ private:
+ SolverWorker *worker;
+
+ protected:
+ virtual bool userCompareNodes(const std::string &needleGraphId, const std::string &needleNodeId, void *needleUserData,
+ const std::string &haystackGraphId, const std::string &haystackNodeId, void *haystackUserData);
+
+ virtual std::string userAnnotateEdge(const std::string &graphId, const std::string &fromNodeId, void *fromUserData, const std::string &toNodeId, void *toUserData);
+
+ virtual bool userCompareEdge(const std::string &needleGraphId, const std::string &needleFromNodeId, void *needleFromUserData, const std::string &needleToNodeId, void *needleToUserData,
+ const std::string &haystackGraphId, const std::string &haystackFromNodeId, void *haystackFromUserData, const std::string &haystackToNodeId, void *haystackToUserData);
+
+ virtual bool userCheckSolution(const Result &result);
+
+ friend class SolverWorker;
+
+ public:
+ Solver();
+ ~Solver();
+
+ void setVerbose();
+ void addGraph(std::string graphId, const Graph &graph);
+ void addCompatibleTypes(std::string needleTypeId, std::string haystackTypeId);
+ void addCompatibleConstants(int needleConstant, int haystackConstant);
+ void addSwappablePorts(std::string needleTypeId, std::string portId1, std::string portId2, std::string portId3 = std::string(), std::string portId4 = std::string());
+ void addSwappablePorts(std::string needleTypeId, std::set<std::string> ports);
+ void addSwappablePortsPermutation(std::string needleTypeId, std::map<std::string, std::string> portMapping);
+
+ void solve(std::vector<Result> &results, std::string needleGraphId, std::string haystackGraphId, bool allowOverlap = true, int maxSolutions = -1);
+ void solve(std::vector<Result> &results, std::string needleGraphId, std::string haystackGraphId,
+ const std::map<std::string, std::set<std::string>> &initialMapping, bool allowOverlap = true, int maxSolutions = -1);
+ void clearOverlapHistory();
+ void clearConfig();
+ };
+}
+
+#endif /* SUBCIRCUIT_H */
--- /dev/null
+#!/usr/bin/env splrun
+
+var idx = 0;
+var count_nand = 0;
+var count_nor = 0;
+
+function makeNAND(net, id)
+{
+ count_nand++;
+
+ net["${id}_VDD"] = "${id}_pa S";
+ net["${id}_VSS"] = "${id}_nb S";
+
+ net["${id}_A"] = "${id}_pa G";
+ net["${id}_B"] = "${id}_pb G";
+ net["${id}_Y"] = "${id}_pb D";
+
+ return <:>
+ : node ${id}_pa pmos S 1 D 1 G 1
+ : node ${id}_pb pmos S 1 D 1 G 1
+ : node ${id}_na nmos S 1 D 1 G 1
+ : node ${id}_nb nmos S 1 D 1 G 1
+ : connect ${id}_pa S ${id}_pb S
+ : connect ${id}_pa D ${id}_pb D
+ : connect ${id}_pa D ${id}_na D
+ : connect ${id}_na S ${id}_nb D
+ : connect ${id}_pa G ${id}_na G
+ : connect ${id}_pb G ${id}_nb G
+ </>;
+}
+
+function makeNOR(net, id)
+{
+ count_nor++;
+
+ net["${id}_VDD"] = "${id}_pa S";
+ net["${id}_VSS"] = "${id}_nb S";
+
+ net["${id}_A"] = "${id}_pa G";
+ net["${id}_B"] = "${id}_pb G";
+ net["${id}_Y"] = "${id}_pb D";
+
+ return <:>
+ : node ${id}_pa pmos S 1 D 1 G 1
+ : node ${id}_pb pmos S 1 D 1 G 1
+ : node ${id}_na nmos S 1 D 1 G 1
+ : node ${id}_nb nmos S 1 D 1 G 1
+ : connect ${id}_pa D ${id}_pb S
+ : connect ${id}_pb D ${id}_na D
+ : connect ${id}_pb D ${id}_nb D
+ : connect ${id}_na S ${id}_nb S
+ : connect ${id}_pa G ${id}_na G
+ : connect ${id}_pb G ${id}_nb G
+ </>;
+}
+
+function makeGraph(seed, gates, primaryInputs, primaryOutputs)
+{
+ srand(seed);
+
+ var code = "";
+ var net, vdd, vss, outputs;
+ var unusedOutpus;
+ for (var i = 0; i < gates; i++)
+ {
+ var id = fmt("G%d", idx++);
+ if (rand(2) == 0)
+ code ~= makeNAND(net, id);
+ else
+ code ~= makeNOR(net, id);
+
+ if (i == 0) {
+ vdd = net["${id}_VDD"];
+ vss = net["${id}_VSS"];
+ } else {
+ code ~= <:>
+ : connect $vdd ${net["${id}_VDD"]}
+ : connect $vss ${net["${id}_VSS"]}
+ </>;
+ }
+
+ var inIdx1 = rand((elementsof outputs) + 1);
+ if (inIdx1 < elementsof outputs) {
+ code ~= " connect ${outputs[inIdx1]} ${net["${id}_A"]}\n";
+ delete unusedOutpus[outputs[inIdx1]];
+ } else
+ push primaryInputs, net["${id}_A"];
+
+ var inIdx2 = rand((elementsof outputs) + 1);
+ if (inIdx2 < elementsof outputs) {
+ code ~= " connect ${outputs[inIdx2]} ${net["${id}_B"]}\n";
+ delete unusedOutpus[outputs[inIdx2]];
+ } else
+ push primaryInputs, net["${id}_B"];
+
+ unusedOutpus[net["${id}_Y"]] = 1;
+ push outputs, net["${id}_Y"];
+ }
+
+ foreach netDecl (unusedOutpus)
+ push primaryOutputs, netDecl;
+
+ return code;
+}
+
+function makeConnections(fromNets, toNets)
+{
+ var code = "";
+ foreach[] toNet (toNets) {
+ var fromNet = fromNets[rand(elementsof fromNets)];
+ code != " connect $fromNet $toNet\n";
+ }
+ return code;
+}
+
+var numNodes;
+
+write(<:>
+ : graph nand
+ <?spl var net = []; ?>
+ ${makeNAND(net, "nand")}
+ : extern ${net["nand_VDD"]}
+ : extern ${net["nand_VSS"]}
+ : extern ${net["nand_A"]}
+ : extern ${net["nand_B"]}
+ : extern ${net["nand_Y"]}
+ : endgraph
+ :
+ : graph nor
+ ${makeNOR(net, "nor")}
+ : extern ${net["nor_VDD"]}
+ : extern ${net["nor_VSS"]}
+ : extern ${net["nor_A"]}
+ : extern ${net["nor_B"]}
+ : extern ${net["nor_Y"]}
+ : endgraph
+ :
+ : graph needle_1
+ <?spl var ports; ?>
+ ${makeGraph(1, 100, ports, ports)}
+ <?spl numNodes["needle_1"] = idx*4; ?>
+ <spl:foreach var="[]net" list="ports">
+ : extern $net
+ </spl:foreach>
+ : endgraph
+ :
+ : graph needle_2
+ <?spl var ports; ?>
+ ${makeGraph(2, 200, ports, ports)}
+ <?spl numNodes["needle_2"] = idx*4; ?>
+ <spl:foreach var="[]net" list="ports">
+ : extern $net
+ </spl:foreach>
+ : endgraph
+ :
+ : graph needle_3
+ <?spl var ports; ?>
+ ${makeGraph(3, 300, ports, ports)}
+ <?spl numNodes["needle_3"] = idx*4; ?>
+ <spl:foreach var="[]net" list="ports">
+ : extern $net
+ </spl:foreach>
+ : endgraph
+ :
+ : graph haystack
+
+ <?spl count_nand=0; count_nor=0; ?>
+
+ <?spl var inPorts1, outPorts1; ?>
+ ${makeGraph(1, 100, inPorts1, outPorts1)}
+
+ <?spl var inPorts2, outPorts2; ?>
+ ${makeGraph(2, 200, inPorts2, outPorts2)}
+
+ <?spl var inPorts3, outPorts3; ?>
+ ${makeGraph(3, 300, inPorts3, outPorts3)}
+
+ <?spl var inPorts4, outPorts4; ?>
+ ${makeGraph(2, 200, inPorts4, outPorts4)}
+
+ <?spl var inPorts5, outPorts5; ?>
+ ${makeGraph(1, 100, inPorts5, outPorts5)}
+ <?spl numNodes["haystack"] = idx*4; ?>
+
+ ${makeConnections(outPorts1, inPorts2)}
+ ${makeConnections(outPorts2, inPorts3)}
+ ${makeConnections(outPorts3, inPorts4)}
+ ${makeConnections(outPorts4, inPorts5)}
+
+ : endgraph
+ :
+ : solve nand haystack false
+ : expect $count_nand
+ : clearoverlap
+ :
+ : solve nor haystack false
+ : expect $count_nor
+ : clearoverlap
+ :
+ : solve needle_1 haystack false
+ : expect 2
+ :
+ : solve needle_2 haystack false
+ : expect 2
+ :
+ : solve needle_3 haystack false
+ : expect 1
+</>);
+
+numNodes["haystack"] -= numNodes["needle_3"];
+numNodes["needle_3"] -= numNodes["needle_2"];
+numNodes["needle_2"] -= numNodes["needle_1"];
+
+write(<:>
+ :
+ : # Needle_1: ${numNodes["needle_1"]} transistors
+ : # Needle_2: ${numNodes["needle_2"]} transistors
+ : # Needle_3: ${numNodes["needle_3"]} transistors
+ : # Haystack: ${numNodes["haystack"]} transistors
+</>);
+
--- /dev/null
+
+# verbose
+
+graph macc22
+ node mul_1 mul A 32 B 32 Y 32
+ node mul_2 mul A 32 B 32 Y 32
+ node add_1 add A 32 B 32 Y 32
+ connect mul_1 Y add_1 A
+ connect mul_2 Y add_1 B
+ extern mul_1 A B
+ extern mul_2 A B
+ extern add_1 Y
+endgraph
+
+graph macc4x2
+ node mul_1 mul A 32 B 32 Y 32
+ node mul_2 mul A 32 B 32 Y 32
+ node mul_3 mul A 32 B 32 Y 32
+ node mul_4 mul A 32 B 32 Y 32
+ node add_1 add A 32 B 32 Y 32
+ node add_2 add A 32 B 32 Y 32
+ node add_3 add A 32 B 32 Y 32
+ connect mul_1 Y add_1 A
+ connect mul_2 Y add_1 B
+ connect mul_3 Y add_2 A
+ connect mul_4 Y add_2 B
+ connect add_1 Y add_3 A
+ connect add_2 Y add_3 B
+ extern mul_1 A B
+ extern mul_2 A B
+ extern mul_3 A B
+ extern mul_4 A B
+ extern add_3 Y
+endgraph
+
+solve macc22 macc4x2
+expect 2
+
+swapgroup mul A B
+
+solve macc22 macc4x2
+expect 2
+
+swapperm add A B : B A
+
+solve macc22 macc4x2
+expect 4
+
--- /dev/null
+#!/usr/bin/perl -w
+
+use strict;
+
+# let "macc" implement a function like Y = (A*B) + (C*D)
+#
+# the following permutations of the input pins exist:
+#
+# g01 | A B C D | match
+# g02 | A B D C | match
+# g03 | A C B D | not
+# g04 | A C D B | not
+# g05 | A D B C | not
+# g06 | A D C B | not
+# g07 | B A C D | match
+# g08 | B A D C | match
+# g09 | B C A D | not
+# g10 | B C D A | not
+# g11 | B D A C | not
+# g12 | B D C A | not
+# g13 | C A B D | not
+# g14 | C A D B | not
+# g15 | C B A D | not
+# g16 | C B D A | not
+# g17 | C D A B | match
+# g18 | C D B A | match
+# g19 | D A B C | not
+# g20 | D A C B | not
+# g21 | D B A C | not
+# g22 | D B C A | not
+# g23 | D C A B | match
+# g24 | D C B A | match
+
+my @matches = qw/g01 g02 g07 g08 g17 g18 g23 g24/;
+my @non_matches = qw/g03 g04 g05 g06 g09 g10 g11 g12 g13 g14 g15 g16 g19 g20 g21 g22/;
+
+print "\n";
+
+for my $i (0..3) {
+for my $j (0..2) {
+for my $k (0..1) {
+ my @t = qw/A B C D/;
+ print "# ";
+ print splice(@t,$i,1),splice(@t,$j,1),splice(@t,$k,1),$t[0];
+ print "\n";
+}}}
+
+print "\n";
+
+my $iter = 1;
+for my $i (0..3) {
+for my $j (0..2) {
+for my $k (0..1) {
+ my @t = qw/A B C D/;
+ printf "graph g%02d\n", $iter++;
+ printf " node input input A 32 1 B 32 1 C 32 1 D 32 1\n";
+ printf " node macc macc A 32 1 B 32 1 C 32 1 D 32 1\n";
+ printf " connect input A macc %s\n", splice(@t,$i,1);
+ printf " connect input B macc %s\n", splice(@t,$j,1);
+ printf " connect input C macc %s\n", splice(@t,$k,1);
+ printf " connect input D macc %s\n", splice(@t,0,1);
+ printf "endgraph\n";
+ printf "\n";
+}}}
+
+$iter = 1;
+printf "graph gXL\n";
+for my $i (0..3) {
+for my $j (0..2) {
+for my $k (0..1) {
+ my $id = sprintf "_%02d", $iter++;
+ my @t = qw/A B C D/;
+ printf " node input$id input A 16 B 16 C 16 D 16\n";
+ printf " node macc$id macc A 16 B 16 C 16 D 16\n";
+ printf " connect input$id A macc$id %s\n", splice(@t,$i,1);
+ printf " connect input$id B macc$id %s\n", splice(@t,$j,1);
+ printf " connect input$id C macc$id %s\n", splice(@t,$k,1);
+ printf " connect input$id D macc$id %s\n", splice(@t,0,1);
+}}}
+printf "endgraph\n";
+printf "\n";
+
+
+printf "swapgroup macc A B\n";
+printf "swapgroup macc C D\n";
+printf "swapperm macc A B C D : C D A B\n";
+
+for my $i (@matches) {
+for my $j (@non_matches) {
+ printf "solve %s %s\n", $i, $j;
+}}
+printf "expect 0\n\n";
+
+for my $i (@matches) {
+for my $j (@matches) {
+ printf "solve %s %s\n", $i, $j;
+}}
+printf "expect %d\n\n", @matches*@matches;
+
+printf "solve g01 gXL false\n";
+printf "expect 8\n";
+
+printf "solve g03 gXL false\n";
+printf "expect 8\n";
+
+printf "solve g04 gXL false\n";
+printf "expect 8\n";
+
--- /dev/null
+#!/usr/bin/env splrun
+//
+// Test procedure for matching Gates with shorted inputs, as suggested in
+// "SubCircuit Extraction with SubGraph Isomorphism. Zong Ling, Ph. D. IBM
+// Almaden Research Center -- EDA Shape Processing zling@us.ibm.com.":
+//
+// Four NAND gates and a NOR gate. One NAND gate (G1) has no shorted inputs,
+// one (G2) has an input shorted to VSS, one (G3) has an input shorted to VDD,
+// and one (G4) has both inputs shorted together. Th last gate (G5) is a NOR
+// gate.
+
+var net;
+
+function makeNAND(id)
+{
+ net["${id}_VDD"] = "${id}_pa S";
+ net["${id}_VSS"] = "${id}_nb S";
+
+ net["${id}_A"] = "${id}_pa G";
+ net["${id}_B"] = "${id}_pb G";
+ net["${id}_Y"] = "${id}_pb D";
+
+ return <:>
+ : node ${id}_pa pmos S 1 D 1 G 1
+ : node ${id}_pb pmos S 1 D 1 G 1
+ : node ${id}_na nmos S 1 D 1 G 1
+ : node ${id}_nb nmos S 1 D 1 G 1
+ : connect ${id}_pa S ${id}_pb S
+ : connect ${id}_pa D ${id}_pb D
+ : connect ${id}_pa D ${id}_na D
+ : connect ${id}_na S ${id}_nb D
+ : connect ${id}_pa G ${id}_na G
+ : connect ${id}_pb G ${id}_nb G
+ </>;
+}
+
+function makeNOR(id)
+{
+ net["${id}_VDD"] = "${id}_pa S";
+ net["${id}_VSS"] = "${id}_nb S";
+
+ net["${id}_A"] = "${id}_pa G";
+ net["${id}_B"] = "${id}_pb G";
+ net["${id}_Y"] = "${id}_pb D";
+
+ return <:>
+ : node ${id}_pa pmos S 1 D 1 G 1
+ : node ${id}_pb pmos S 1 D 1 G 1
+ : node ${id}_na nmos S 1 D 1 G 1
+ : node ${id}_nb nmos S 1 D 1 G 1
+ : connect ${id}_pa D ${id}_pb S
+ : connect ${id}_pb D ${id}_na D
+ : connect ${id}_pb D ${id}_nb D
+ : connect ${id}_na S ${id}_nb S
+ : connect ${id}_pa G ${id}_na G
+ : connect ${id}_pb G ${id}_nb G
+ </>;
+}
+
+write(<:>
+ : graph nand
+ : ${ makeNAND("G0") }
+ : extern ${net["G0_VDD"]}
+ : extern ${net["G0_VSS"]}
+ : extern ${net["G0_A"]}
+ : extern ${net["G0_B"]}
+ : extern ${net["G0_Y"]}
+ : endgraph
+ :
+ : graph nor
+ : ${ makeNOR("G0") }
+ : extern ${net["G0_VDD"]}
+ : extern ${net["G0_VSS"]}
+ : extern ${net["G0_A"]}
+ : extern ${net["G0_B"]}
+ : extern ${net["G0_Y"]}
+ : endgraph
+ :
+ : graph haystack
+ : ${ makeNAND("G1") }
+ : ${ makeNAND("G2") }
+ : ${ makeNAND("G3") }
+ : ${ makeNAND("G4") }
+ ${ makeNOR("G5") }
+ :
+ : node vdd vsupply V 1
+ : connect vdd V ${net["G1_VDD"]}
+ : connect vdd V ${net["G2_VDD"]}
+ : connect vdd V ${net["G3_VDD"]}
+ : connect vdd V ${net["G4_VDD"]}
+ : connect vdd V ${net["G5_VDD"]}
+ :
+ : node vss vsupply V 1
+ : connect vss V ${net["G1_VSS"]}
+ : connect vss V ${net["G2_VSS"]}
+ : connect vss V ${net["G3_VSS"]}
+ : connect vss V ${net["G4_VSS"]}
+ : connect vss V ${net["G5_VSS"]}
+ :
+ : connect ${net["G2_A"]} ${net["G1_A"]}
+ : connect ${net["G2_B"]} ${net["G2_VSS"]}
+ :
+ : connect ${net["G3_A"]} ${net["G1_VDD"]}
+ : connect ${net["G3_B"]} ${net["G2_Y"]}
+ :
+ : connect ${net["G4_A"]} ${net["G1_Y"]}
+ : connect ${net["G4_B"]} ${net["G1_Y"]}
+ :
+ : connect ${net["G5_A"]} ${net["G3_Y"]}
+ : connect ${net["G5_B"]} ${net["G4_Y"]}
+ : endgraph
+ :
+ : solve nand haystack false
+ : clearoverlap
+ : expect 4
+ :
+ : solve nor haystack false
+ : clearoverlap
+ : expect 1
+</>);
+
#include "kernel/register.h"
#include "kernel/sigtools.h"
#include "kernel/log.h"
-#include "kernel/sha1.h"
#include "kernel/celltypes.h"
+#include "libs/sha1/sha1.h"
#include <stdlib.h>
#include <assert.h>
#include <stdio.h>
#include "kernel/register.h"
#include "kernel/sigtools.h"
#include "kernel/log.h"
-#include "kernel/sha1.h"
#include "kernel/celltypes.h"
+#include "libs/sha1/sha1.h"
#include <stdlib.h>
#include <assert.h>
#include <stdio.h>
projects / yosys.git / commitdiff