summaryrefslogtreecommitdiff
path: root/integer.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2016-09-09 10:51:38 -0400
committerJeffrey Walton <noloader@gmail.com>2016-09-09 10:51:38 -0400
commitca594ff52576919df1fc32e4ff826b35c74b0af1 (patch)
tree686e4db7997823835448854fcdc833b91722404c /integer.h
parent0d66fd8f82fdbcb7c1e80e1f6c76ec712d2506e3 (diff)
downloadcryptopp-git-ca594ff52576919df1fc32e4ff826b35c74b0af1.tar.gz
Updated documentation
Diffstat (limited to 'integer.h')
-rw-r--r--integer.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/integer.h b/integer.h
index f1d393a2..f289779a 100644
--- a/integer.h
+++ b/integer.h
@@ -2,6 +2,12 @@
//! \file integer.h
//! \brief Multiple precision integer with arithmetic operations
+//! \details The Integer class can represent positive and negative integers
+//! with absolute value less than (256**sizeof(word))<sup>(256**sizeof(int))</sup>.
+//! \details Internally, the library uses a sign magnitude representation, and the class
+//! has two data members. The first is a IntegerSecBlock (a SecBlock<word>) and it is
+//! used to hold the representation. The second is a Sign, and its is used to track
+//! the sign of the Integer.
#ifndef CRYPTOPP_INTEGER_H
#define CRYPTOPP_INTEGER_H