Massive cleanup of the entire codebase. Notable changes include:

[bigint/bigint.git] / BigIntegerUtils.hh

diff --git a/BigIntegerUtils.hh b/BigIntegerUtils.hh
index 0587c96..16900f4 100644 (file)
--- a/BigIntegerUtils.hh
+++ b/BigIntegerUtils.hh
@@ -1,20 +1,15 @@
-/*
-* Matt McCutchen's Big Integer Library
-* http://hashproduct.metaesthetics.net/bigint/
-*/
-
-#ifndef BIGINTEGERUTILS
-#define BIGINTEGERUTILS
+#ifndef BIGINTEGERUTILS_H
+#define BIGINTEGERUTILS_H
 
 #include "BigInteger.hh"
 #include <string>
 #include <iostream>
 
 /*
-* This file includes:
-* (1) `std::string <=> BigUnsigned/BigInteger' conversion routines easier than `BigUnsignedInABase'
-* (2) << and >> operators for BigUnsigned/BigInteger, std::istream/std::ostream
-*/
+ * This file includes:
+ * (1) `std::string <=> BigUnsigned/BigInteger' conversion routines easier than `BigUnsignedInABase'
+ * (2) << and >> operators for BigUnsigned/BigInteger, std::istream/std::ostream
+ */
 
 // Conversion routines.  Base 10 only.
 std::string easyBUtoString(const BigUnsigned &x);
@@ -34,35 +29,35 @@ std::ostream &operator <<(std::ostream &os, const BigUnsigned &x);
 std::ostream &operator <<(std::ostream &os, const BigInteger &x);
 
 /*
-* =================================
-* BELOW THIS POINT are template definitions; above are declarations.  See `NumberlikeArray.hh'.
-*/
+ * =================================
+ * BELOW THIS POINT are template definitions; above are declarations.  See `NumberlikeArray.hh'.
+ */
 
 /*
-* 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.
-*/
+ * 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 easyDataToBI(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;
@@ -71,10 +66,10 @@ BigInteger easyDataToBI(const T* data, BigInteger::Index length, BigInteger::Sig
                        curBlock |= (BigInteger::Blk(data[pieceNum]) << (pieceSizeInBits * pieceNumHere));
                blocks[blockNum] = curBlock;
        }
-       
+
        // Create the BigInteger.
        BigInteger x(blocks, numBlocks, sign);
-       
+
        delete blocks;
        return x;
 }