Crypto++  5.6.5
Free C++ class library of cryptographic schemes
Classes | Typedefs | Functions
integer.h File Reference

Multiple precision integer with arithmetic operations. More...

Go to the source code of this file.

Classes

struct  InitializeInteger
 Performs static intialization of the Integer class. More...
 
class  Integer
 Multiple precision integer with arithmetic operations. More...
 
class  Integer::DivideByZero
 Exception thrown when division by 0 is encountered. More...
 
class  Integer::RandomNumberNotFound
 Exception thrown when a random number cannot be found that satisfies the condition. More...
 
class  Integer::OpenPGPDecodeErr
 Exception thrown when an error is encountered decoding an OpenPGP integer. More...
 

Typedefs

typedef SecBlock< word, AllocatorWithCleanup< word, true > > IntegerSecBlock
 

Functions

bool operator== (const ::Integer &a, const ::Integer &b)
 Comparison.
 
bool operator!= (const ::Integer &a, const ::Integer &b)
 Comparison.
 
bool operator> (const ::Integer &a, const ::Integer &b)
 Comparison.
 
bool operator>= (const ::Integer &a, const ::Integer &b)
 Comparison.
 
bool operator< (const ::Integer &a, const ::Integer &b)
 Comparison.
 
bool operator<= (const ::Integer &a, const ::Integer &b)
 Comparison.
 
inline::Integer operator+ (const ::Integer &a, const ::Integer &b)
 Addition.
 
inline::Integer operator- (const ::Integer &a, const ::Integer &b)
 Subtraction.
 
inline::Integer operator* (const ::Integer &a, const ::Integer &b)
 Multiplication. More...
 
inline::Integer operator/ (const ::Integer &a, const ::Integer &b)
 Division.
 
inline::Integer operator% (const ::Integer &a, const ::Integer &b)
 Remainder. More...
 
inline::Integer operator/ (const ::Integer &a,::word b)
 Division.
 
inline::word operator% (const ::Integer &a,::word b)
 Remainder. More...
 
inline::Integer operator& (const ::Integer &a, const ::Integer &b)
 Bitwise AND. More...
 
inline::Integer operator| (const ::Integer &a, const ::Integer &b)
 Bitwise OR. More...
 
inline::Integer operator^ (const ::Integer &a, const ::Integer &b)
 Bitwise XOR. More...
 
void swap (::Integer &a,::Integer &b)
 

Detailed Description

Multiple precision integer with arithmetic operations.

The Integer class can represent positive and negative integers with absolute value less than (256**sizeof(word))(256**sizeof(int)).

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 (an enumeration), and it is used to track the sign of the Integer.

Since
Crypto++ 1.0

Definition in file integer.h.

Function Documentation

inline ::Integer operator* ( const ::Integer a,
const ::Integer b 
)

Multiplication.

See also
a_times_b_mod_c() and a_exp_b_mod_c()

Definition at line 665 of file integer.h.

inline ::Integer operator% ( const ::Integer a,
const ::Integer b 
)

Remainder.

See also
a_times_b_mod_c() and a_exp_b_mod_c()

Definition at line 670 of file integer.h.

inline ::word operator% ( const ::Integer a,
::word  b 
)

Remainder.

See also
a_times_b_mod_c() and a_exp_b_mod_c()

Definition at line 675 of file integer.h.

inline ::Integer operator& ( const ::Integer a,
const ::Integer b 
)

Bitwise AND.

Parameters
athe first Integer
bthe second Integer
Returns
the result of a & b

operator&() performs a bitwise AND on the operands. Missing bits are truncated at the most significant bit positions, so the result is as small as the smaller of the operands.

Internally, Crypto++ uses a sign-magnitude representation. The library does not attempt to interpret bits, and the result is always POSITIVE. If needed, the integer should be converted to a 2's compliment representation before performing the operation.

Since
Crypto++ 5.7

Definition at line 689 of file integer.h.

inline ::Integer operator| ( const ::Integer a,
const ::Integer b 
)

Bitwise OR.

Parameters
athe first Integer
bthe second Integer
Returns
the result of a | b

operator|() performs a bitwise OR on the operands. Missing bits are shifted in at the most significant bit positions, so the result is as large as the larger of the operands.

Internally, Crypto++ uses a sign-magnitude representation. The library does not attempt to interpret bits, and the result is always POSITIVE. If needed, the integer should be converted to a 2's compliment representation before performing the operation.

Since
Crypto++ 5.7

Definition at line 703 of file integer.h.

inline ::Integer operator^ ( const ::Integer a,
const ::Integer b 
)

Bitwise XOR.

Parameters
athe first Integer
bthe second Integer
Returns
the result of a ^ b

operator^() performs a bitwise XOR on the operands. Missing bits are shifted in at the most significant bit positions, so the result is as large as the larger of the operands.

Internally, Crypto++ uses a sign-magnitude representation. The library does not attempt to interpret bits, and the result is always POSITIVE. If needed, the integer should be converted to a 2's compliment representation before performing the operation.

Since
Crypto++ 5.7

Definition at line 717 of file integer.h.