Security Scol plugin
Classes | Typedefs | Functions
integer.h File Reference

Multiple precision integer with arithmetic operations. More...

#include "cryptlib.h"
#include "secblock.h"
#include "stdcpp.h"
#include <iosfwd>

Go to the source code of this file.

Classes

struct  InitializeInteger
 Performs static initialization 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 CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Comparison.
 
bool operator!= (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Comparison.
 
bool operator> (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Comparison.
 
bool operator>= (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Comparison.
 
bool operator< (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Comparison.
 
bool operator<= (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Comparison.
 
CryptoPP::Integer operator+ (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Addition.
 
CryptoPP::Integer operator- (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Subtraction.
 
CryptoPP::Integer operator* (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Multiplication.
 
CryptoPP::Integer operator/ (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Division.
 
CryptoPP::Integer operator% (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Remainder.
 
CryptoPP::Integer operator/ (const CryptoPP::Integer &a, CryptoPP::word b)
 Division.
 
CryptoPP::word operator% (const CryptoPP::Integer &a, CryptoPP::word b)
 Remainder.
 
CryptoPP::Integer operator& (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Bitwise AND.
 
CryptoPP::Integer operator| (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Bitwise OR.
 
CryptoPP::Integer operator^ (const CryptoPP::Integer &a, const CryptoPP::Integer &b)
 Bitwise XOR.
 
NAMESPACE_END void swap (CryptoPP::Integer &a, CryptoPP::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.

For details on how the Integer class initializes its function pointers using InitializeInteger and how it creates Integer::Zero(), Integer::One(), and Integer::Two(), then see the comments at the top of integer.cpp.

Since
Crypto++ 1.0

Definition in file integer.h.

Typedef Documentation

◆ IntegerSecBlock

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

Definition at line 35 of file integer.h.

Function Documentation

◆ operator!=()

bool operator!= ( const CryptoPP::Integer &  a,
const CryptoPP::Integer &  b 
)
inline

Comparison.

Definition at line 759 of file integer.h.

◆ operator%() [1/2]

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

Remainder.

See also
a_times_b_mod_c() and a_exp_b_mod_c()

Definition at line 779 of file integer.h.

◆ operator%() [2/2]

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

Remainder.

See also
a_times_b_mod_c() and a_exp_b_mod_c()

Definition at line 784 of file integer.h.

◆ operator&()

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

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++ 6.0

Definition at line 798 of file integer.h.

◆ operator*()

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

Multiplication.

See also
a_times_b_mod_c() and a_exp_b_mod_c()

Definition at line 774 of file integer.h.

◆ operator+()

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

Addition.

Definition at line 769 of file integer.h.

◆ operator-()

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

Subtraction.

Definition at line 771 of file integer.h.

◆ operator/() [1/2]

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

Division.

Definition at line 776 of file integer.h.

◆ operator/() [2/2]

CryptoPP::Integer operator/ ( const CryptoPP::Integer &  a,
CryptoPP::word  b 
)
inline

Division.

Definition at line 781 of file integer.h.

◆ operator<()

bool operator< ( const CryptoPP::Integer &  a,
const CryptoPP::Integer &  b 
)
inline

Comparison.

Definition at line 765 of file integer.h.

◆ operator<=()

bool operator<= ( const CryptoPP::Integer &  a,
const CryptoPP::Integer &  b 
)
inline

Comparison.

Definition at line 767 of file integer.h.

◆ operator==()

bool operator== ( const CryptoPP::Integer &  a,
const CryptoPP::Integer &  b 
)
inline

Comparison.

Definition at line 757 of file integer.h.

◆ operator>()

bool operator> ( const CryptoPP::Integer &  a,
const CryptoPP::Integer &  b 
)
inline

Comparison.

Definition at line 761 of file integer.h.

◆ operator>=()

bool operator>= ( const CryptoPP::Integer &  a,
const CryptoPP::Integer &  b 
)
inline

Comparison.

Definition at line 763 of file integer.h.

◆ operator^()

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

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++ 6.0

Definition at line 826 of file integer.h.

◆ operator|()

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

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++ 6.0

Definition at line 812 of file integer.h.

◆ swap()

NAMESPACE_END void swap ( CryptoPP::Integer &  a,
CryptoPP::Integer &  b 
)
inline

Definition at line 832 of file integer.h.