PALISADE Lattice Crypto Library: lbcrypto::BigIntegerInterface< T

Public Member Functions
void	SetValue (const std::string &str)

T	Add (const T &b) const

const T &	AddEq (const T &b)

T	Sub (const T &b) const

const T &	SubEq (const T &b)

T	Mul (const T &b) const

const T &	MulEq (const T &b)

T	DividedBy (const T &b) const

const T &	DividedByEq (const T &b)

T	MultiplyAndRound (const T &p, const T &q) const

const T &	MultiplyAndRoundEq (const T &p, const T &q)

T	DivideAndRound (const T &q) const

const T &	DivideAndRoundEq (const T &q)

T	Mod (const T &modulus) const

const T &	ModEq (const T &modulus)

T	ComputeMu () const

T	Mod (const T &modulus, const T &mu) const

const T &	ModEq (const T &modulus, const T &mu)

T	ModAdd (const T &b, const T &modulus) const

const T &	ModAddEq (const T &b, const T &modulus)

T	ModAddFast (const T &b, const T &modulus) const

const T &	ModAddFastEq (const T &b, const T &modulus)

T	ModAdd (const T &b, const T &modulus, const T &mu) const

const T &	ModAddEq (const T &b, const T &modulus, const T &mu)

T	ModSub (const T &b, const T &modulus) const

const T &	ModSubEq (const T &b, const T &modulus)

T	ModSubFast (const T &b, const T &modulus) const

const T &	ModSubFastEq (const T &b, const T &modulus)

T	ModSub (const T &b, const T &modulus, const T &mu) const

const T &	ModSubEq (const T &b, const T &modulus, const T &mu)

T	ModMul (const T &b, const T &modulus) const

const T &	ModMulEq (const T &b, const T &modulus)

T	ModMul (const T &b, const T &modulus, const T &mu) const

const T &	ModMulEq (const T &b, const T &modulus, const T &mu)

T	ModMulFast (const T &b, const T &modulus) const

const T &	ModMulFastEq (const T &b, const T &modulus)

T	ModMulFast (const T &b, const T &modulus, const T &mu) const

const T &	ModMulFastEq (const T &b, const T &modulus, const T &mu)

T	ModMulFastConst (const T &b, const T &modulus, const T &bInv) const

const T &	ModMulFastConstEq (const T &b, const T &modulus, const T &bInv)

T	ModExp (const T &b, const T &modulus) const

const T &	ModExpEq (const T &b, const T &modulus)

T	ModInverse (const T &modulus) const

const T &	ModInverseEq (const T &modulus)

T	LShift (usshort shift) const

const T &	LShiftEq (usshort shift)

T	RShift (usshort shift) const

const T &	RShiftEq (usshort shift)

int	Compare (const T &a) const

uint64_t	ConvertToInt () const

usint	GetMSB () const

usint	GetLengthForBase (usint base) const

usint	GetDigitAtIndexForBase (usint index, usint base) const

const std::string	ToString () const

Friends
T	operator+ (const T &a, const T &b)
	inline operators for the addition operation.

const T &	operator+= (T &a, const T &b)

T	operator- (const T &a, const T &b)
	inline operators for the subtraction operation.

const T &	operator-= (T &a, const T &b)

T	operator* (const T &a, const T &b)
	inline operators for the multiplication operation.

const T &	*operator=** (T &a, const T &b)

T	operator/ (const T &a, const T &b)
	inline operators for the division operation.

const T &	operator/= (T &a, const T &b)

T	operator% (const T &a, const T &b)

const T &	operator%= (T &a, const T &b)

T	operator<< (const T &a, usshort shift)
	inline operators for the left shift operations.

const T &	operator<<= (T &a, usshort shift)

T	operator>> (const T &a, usshort shift)
	inline operators for the right shift operations.

const T &	operator>>= (T &a, usshort shift)

bool	operator== (const T &a, const T &b)

bool	operator!= (const T &a, const T &b)

bool	operator> (const T &a, const T &b)

bool	operator>= (const T &a, const T &b)

bool	operator< (const T &a, const T &b)

bool	operator<= (const T &a, const T &b)

Member Function Documentation

◆ Add()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::Add ( const T & b ) const

Addition operation.

Parameters

&b	is the value to add.

Returns: result of the addition operation.

◆ Compare()

template<typename T>

int lbcrypto::BigIntegerInterface< T >::Compare ( const T & a ) const

Compares the current BigInteger to BigInteger a.

Parameters

a	is the BigInteger to be compared with.

Returns: -1 for strictly less than, 0 for equal to and 1 for strictly greater than conditons.

◆ ComputeMu()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ComputeMu ( ) const

Precomputes a parameter mu for Barrett modular reduction.

Returns: the precomputed parameter mu.

◆ ConvertToInt()

template<typename T>

uint64_t lbcrypto::BigIntegerInterface< T >::ConvertToInt ( ) const

Convert the value to an int.

Returns: the int representation of the value.

◆ DivideAndRound()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::DivideAndRound ( const T & q ) const

Divide and Rounding operation. Returns [x/q] where [] is the rounding operation.

Parameters

&q	is the denominator to be divided.

Returns: is the result of divide and round operation.

◆ DivideAndRoundEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::DivideAndRoundEq ( const T & q )

Divide and Rounding operation. Returns [x/q] where [] is the rounding operation. In-place variant.

Parameters

&q	is the denominator to be divided.

Returns: is the result of divide and round operation.

◆ DividedBy()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::DividedBy ( const T & b ) const

Division operation.

Parameters

&b	is the value to divide by.

Returns: is the result of the division operation.

◆ DividedByEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::DividedByEq ( const T & b )

Division operation. In-place variant.

Parameters

&b	is the value to divide by.

Returns: is the result of the division operation.

◆ GetDigitAtIndexForBase()

template<typename T>

usint lbcrypto::BigIntegerInterface< T >::GetDigitAtIndexForBase	(	usint	index,
		usint	base
	)		const

Get the number of digits using a specific base - support for arbitrary base may be needed. Example: for number 83, index 2 and base 4 we have:

                    index:0,1,2,3

83 –base 4 decomposition–> (3,0,1,1) –at index 2–> 1

The return number is 1.

Parameters

index	is the location to return value from in the specific base.
base	is the base with which to determine length in.

Returns: the length of the representation in a specific base.

◆ GetLengthForBase()

template<typename T>

usint lbcrypto::BigIntegerInterface< T >::GetLengthForBase ( usint base ) const

Get the number of digits using a specific base - support for arbitrary base may be needed.

Parameters

base	is the base with which to determine length in.

Returns: the length of the representation in a specific base.

◆ GetMSB()

template<typename T>

usint lbcrypto::BigIntegerInterface< T >::GetMSB ( ) const

Returns the MSB location of the value.

Returns: the index of the most significant bit.

◆ LShift()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::LShift ( usshort shift ) const

Left shift operation.

Parameters

shift # of bits.

Returns: result of the shift operation.

◆ LShiftEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::LShiftEq ( usshort shift )

Left shift operation. In-place variant.

Parameters

shift # of bits.

Returns: result of the shift operation.

◆ Mod() [1/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::Mod ( const T & modulus ) const

Naive modulus operation.

Parameters

&modulus is the modulus to perform.

Returns: is the result of the modulus operation.

◆ Mod() [2/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::Mod	(	const T &	modulus,
		const T &	mu
	)		const

Barrett modulus operation. Implements generalized Barrett modular reduction algorithm. Uses one precomputed value of mu.

Parameters

&modulus	is the modulus to perform.
&mu	is the Barrett value.

Returns: is the result of the modulus operation.

◆ ModAdd() [1/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModAdd	(	const T &	b,
		const T &	modulus
	)		const

Modulus addition operation.

Parameters

&b	is the scalar to add.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus addition operation.

◆ ModAdd() [2/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModAdd	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)		const

Barrett modulus addition operation.

Parameters

&b	is the scalar to add.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus addition operation.

◆ ModAddEq() [1/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModAddEq	(	const T &	b,
		const T &	modulus
	)

Modulus addition operation. In-place variant.

Parameters

&b	is the scalar to add.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus addition operation.

◆ ModAddEq() [2/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModAddEq	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)

Barrett modulus addition operation. In-place variant.

Parameters

&b	is the scalar to add.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus addition operation.

◆ ModAddFast()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModAddFast	(	const T &	b,
		const T &	modulus
	)		const

Modulus addition where operands are < modulus.

Parameters

&b	is the scalar to add.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus addition operation.

◆ ModAddFastEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModAddFastEq	(	const T &	b,
		const T &	modulus
	)

Modulus addition where operands are < modulus. In-place variant.

Parameters

&b	is the scalar to add.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus addition operation.

◆ ModEq() [1/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModEq ( const T & modulus )

Naive modulus operation. In-place variant.

Parameters

&modulus is the modulus to perform.

Returns: is the result of the modulus operation.

◆ ModEq() [2/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModEq	(	const T &	modulus,
		const T &	mu
	)

Barrett modulus operation. In-place variant. Implements generalized Barrett modular reduction algorithm. Uses one precomputed value of mu.

Parameters

&modulus	is the modulus to perform.
&mu	is the Barrett value.

Returns: is the result of the modulus operation.

◆ ModExp()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModExp	(	const T &	b,
		const T &	modulus
	)		const

Modulus exponentiation operation.

Parameters

&b	is the scalar to exponentiate at all locations.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus exponentiation operation.

◆ ModExpEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModExpEq	(	const T &	b,
		const T &	modulus
	)

Modulus exponentiation operation. In-place variant.

Parameters

&b	is the scalar to exponentiate at all locations.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus exponentiation operation.

◆ ModInverse()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModInverse ( const T & modulus ) const

Modulus inverse operation.

Parameters

&modulus is the modulus to perform.

Returns: is the result of the modulus inverse operation.

◆ ModInverseEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModInverseEq ( const T & modulus )

Modulus inverse operation. In-place variant.

Parameters

&modulus is the modulus to perform.

Returns: is the result of the modulus inverse operation.

◆ ModMul() [1/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModMul	(	const T &	b,
		const T &	modulus
	)		const

Modulus multiplication operation.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus multiplication operation.

◆ ModMul() [2/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModMul	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)		const

Barrett modulus multiplication.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus multiplication operation.

◆ ModMulEq() [1/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModMulEq	(	const T &	b,
		const T &	modulus
	)

Modulus multiplication operation. In-place variant.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus multiplication operation.

◆ ModMulEq() [2/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModMulEq	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)

Barrett modulus multiplication. In-place variant.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus multiplication operation.

◆ ModMulFast() [1/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModMulFast	(	const T &	b,
		const T &	modulus
	)		const

Modulus multiplication that assumes the operands are < modulus.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus multiplication operation.

◆ ModMulFast() [2/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModMulFast	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)		const

Barrett modulus multiplication that assumes the operands are < modulus.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus multiplication operation.

◆ ModMulFastConst()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModMulFastConst	(	const T &	b,
		const T &	modulus,
		const T &	bInv
	)		const

NTL-optimized modular multiplication using a precomputation for the multiplicand. Assumes operands are < modulus.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.
&bInv	NTL precomputation for b.

Returns: is the result of the modulus multiplication operation.

◆ ModMulFastConstEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModMulFastConstEq	(	const T &	b,
		const T &	modulus,
		const T &	bInv
	)

NTL-optimized modular multiplication using a precomputation for the multiplicand. Assumes operands are < modulus. In-place variant.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.
&bInv	NTL precomputation for b.

Returns: is the result of the modulus multiplication operation.

◆ ModMulFastEq() [1/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModMulFastEq	(	const T &	b,
		const T &	modulus
	)

Modulus multiplication that assumes the operands are < modulus. In-place variant.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus multiplication operation.

◆ ModMulFastEq() [2/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModMulFastEq	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)

Barrett modulus multiplication that assumes the operands are < modulus. In-place variant.

Parameters

&b	is the scalar to multiply.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus multiplication operation.

◆ ModSub() [1/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModSub	(	const T &	b,
		const T &	modulus
	)		const

Modulus subtraction operation.

Parameters

&b	is the scalar to subtract.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus subtraction operation.

◆ ModSub() [2/2]

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModSub	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)		const

Barrett modulus subtraction operation.

Parameters

&b	is the scalar to subtract.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus subtraction operation.

◆ ModSubEq() [1/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModSubEq	(	const T &	b,
		const T &	modulus
	)

Modulus subtraction operation. In-place variant.

Parameters

&b	is the scalar to subtract.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus subtraction operation.

◆ ModSubEq() [2/2]

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModSubEq	(	const T &	b,
		const T &	modulus,
		const T &	mu
	)

Barrett modulus subtraction operation. In-place variant.

Parameters

&b	is the scalar to subtract.
&modulus	is the modulus to perform operations with.
&mu	is the Barrett value.

Returns: is the result of the modulus subtraction operation.

◆ ModSubFast()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::ModSubFast	(	const T &	b,
		const T &	modulus
	)		const

Modulus subtraction where operands are < modulus.

Parameters

&b	is the scalar to subtract.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus subtraction operation.

◆ ModSubFastEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::ModSubFastEq	(	const T &	b,
		const T &	modulus
	)

Modulus subtraction where operands are < modulus. In-place variant.

Parameters

&b	is the scalar to subtract.
&modulus	is the modulus to perform operations with.

Returns: is the result of the modulus subtraction operation.

◆ Mul()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::Mul ( const T & b ) const

Multiplication operation.

Parameters

&b	is the value to multiply with.

Returns: is the result of the multiplication operation.

◆ MulEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::MulEq ( const T & b )

Multiplication operation. In-place variant.

Parameters

&b	is the value to multiply with.

Returns: is the result of the multiplication operation.

◆ MultiplyAndRound()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::MultiplyAndRound	(	const T &	p,
		const T &	q
	)		const

Multiply and Rounding operation. Returns [x*p/q] where [] is the rounding operation.

Parameters

&p	is the numerator to be multiplied.
&q	is the denominator to be divided.

Returns: is the result of multiply and round operation.

◆ MultiplyAndRoundEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::MultiplyAndRoundEq	(	const T &	p,
		const T &	q
	)

Multiply and Rounding operation. Returns [x*p/q] where [] is the rounding operation. In-place variant.

Parameters

&p	is the numerator to be multiplied.
&q	is the denominator to be divided.

Returns: is the result of multiply and round operation.

◆ RShift()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::RShift ( usshort shift ) const

Right shift operation.

Parameters

shift # of bits.

Returns: result of the shift operation.

◆ RShiftEq()

template<typename T>

const T& lbcrypto::BigIntegerInterface< T >::RShiftEq ( usshort shift )

Right shift operation. In-place variant.

Parameters

shift # of bits.

Returns: result of the shift operation.

◆ SetValue()

template<typename T>

void lbcrypto::BigIntegerInterface< T >::SetValue ( const std::string & str )

Set from a string

Parameters

str	is the string representation of the value

◆ Sub()

template<typename T>

T lbcrypto::BigIntegerInterface< T >::Sub ( const T & b ) const

Subtraction operation.

Parameters

&b	is the value to subtract.

Returns: is the result of the subtraction operation.

◆ ToString()

template<typename T>

const std::string lbcrypto::BigIntegerInterface< T >::ToString ( ) const

Convert this integer into a std::string, for serialization

Returns: the value of this T as a string.

The documentation for this class was generated from the following file:

src/core/include/math/interface.h

Public Member Functions

Friends

Member Function Documentation

◆ Add()

◆ Compare()

◆ ComputeMu()

◆ ConvertToInt()

◆ DivideAndRound()

◆ DivideAndRoundEq()

◆ DividedBy()

◆ DividedByEq()

◆ GetDigitAtIndexForBase()

◆ GetLengthForBase()

◆ GetMSB()

◆ LShift()

◆ LShiftEq()

◆ Mod() [1/2]

◆ Mod() [2/2]

◆ ModAdd() [1/2]

◆ ModAdd() [2/2]

◆ ModAddEq() [1/2]

◆ ModAddEq() [2/2]

◆ ModAddFast()

◆ ModAddFastEq()

◆ ModEq() [1/2]

◆ ModEq() [2/2]

◆ ModExp()

◆ ModExpEq()

◆ ModInverse()

◆ ModInverseEq()

◆ ModMul() [1/2]

◆ ModMul() [2/2]

◆ ModMulEq() [1/2]

◆ ModMulEq() [2/2]

◆ ModMulFast() [1/2]

◆ ModMulFast() [2/2]

◆ ModMulFastConst()

◆ ModMulFastConstEq()

◆ ModMulFastEq() [1/2]

◆ ModMulFastEq() [2/2]

◆ ModSub() [1/2]

◆ ModSub() [2/2]

◆ ModSubEq() [1/2]

◆ ModSubEq() [2/2]

◆ ModSubFast()

◆ ModSubFastEq()

◆ Mul()

◆ MulEq()

◆ MultiplyAndRound()

◆ MultiplyAndRoundEq()

◆ RShift()

◆ RShiftEq()

◆ SetValue()

◆ Sub()

◆ ToString()