README

   1 +===================================================================+
   2 | Big Integer Library                                               |
   3 | A C++ library that does arithmetic on integers of unlimited size. |
   4 | Version 2006.05.01                                                |
   5 +-------------------------------------------------------------------+
   6 | By Matt McCutchen                                                 |
   7 | E-mail: hashproduct@gmail.com                                     |
   8 | My Web site gateway: http://mysite.verizon.net/hashproduct/       |
   9 | Project Web site: http://www.kepreon.com/~matt/bigint/            |
  10 +===================================================================+
  11
  12 What the Big Integer Library provides
  13 =====================================
  14 This library contains two classes, BigUnsigned and BigInteger, that represent nonnegative integers and integers, respectively, of size limited only by your computer's memory.  Their capabilities include these operators:
  15         Math:   +  -  *  /  %  &  |  ^  unary-
  16   Assignment: = += -= *= /= %= &= |= ^= ++ --
  17   Comparison:   == != <  <= >  >=
  18 In the works are the << and >> operators, integer algorithms like `gcd', and possibly a working implementation of RSA using the library.
  19
  20 Using the features of the library
  21 =================================
  22 The file `sample.cc' explains and demonstrates the most important features of the library.  I recommend that you read `sample.cc' and then run the sample program it contains.  If you want to do something not shown in `sample.cc' or want more detail, read the actual header and source files, which are extensively commented.
  23
  24 Compiling programs with the library
  25 ===================================
  26 The library consists of a folder full of header files (`.hh') and source files (`.cc').  `#include' header files and compile with source files as necessary for your own programs.  For those who use `make', a `Makefile' is included that compiles the source code to object files (`.o') and compiles the sample program.
  27
  28 Bugs
  29 ====
  30 The library has been tested by myself and others but is by no means bug-free.  The programs you write using the library will be the best test of its correctness.  I urge you to report any problems that you find, whether they come in the form of compiling trouble, mathematically inaccurate results, or runtime memory-management bloopers (which, since I use Java, are altogether too common in my C++).
  31
  32 Keep in touch
  33 =============
  34 Feel free to e-mail me at `hashproduct@gmail.com' to report bugs or request features.  When I fix the bug or add the feature, you will generally be credited by name in the source code and/or the Change Log unless you request otherwise.  I am also curious as to what uses you find for the library.  New versions of the library will be available at the project Web site.
  35
  36 =====================================================================