Arbitrary precision integer. More...

#include <integer.hpp>

Public Member Functions
	integer () noexcept
	Empty constructor.

	integer (mpz_t &&raw) noexcept
	Constructor with mpz_t. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
	integer (T i) noexcept
	Constructor with unsigned integer value. More...

	integer (const std::string &s) noexcept
	Constructor with string. More...

	integer (integer &&i) noexcept
	Move constructor. More...

	integer (const integer &i) noexcept
	Copy constructor. More...

	~integer () noexcept
	Destructor.

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
void	set_number (T i) noexcept
	Overwrites the value of this integer with i. More...

void	set_integer (const integer &i) noexcept
	Overwrites the value of this integer with i. More...

void	set_str (const std::string &s) noexcept
	Overwrites the value of this integer with s. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer &	operator= (T i) noexcept
	Assignment operator. More...

integer &	operator= (const integer &i) noexcept
	Copy assignment operator. More...

integer &	operator= (integer &&i) noexcept
	Move assignment operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator== (T i) const noexcept
	Equality operator. More...

bool	operator== (const integer &i) const noexcept
	Equality operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator!= (T i) const noexcept
	Non-equality operator. More...

bool	operator!= (const integer &i) const noexcept
	Non-equality operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator< (T i) const noexcept
	Less than operator. More...

bool	operator< (const integer &i) const noexcept
	Less than operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator<= (T i) const noexcept
	Less than or equal to operator. More...

bool	operator<= (const integer &i) const noexcept
	Less than or equal to operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator> (T i) const noexcept
	Greater than operator. More...

bool	operator> (const integer &i) const noexcept
	Greater than operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator>= (T i) const noexcept
	Greater than or equal to operator. More...

bool	operator>= (const integer &i) const noexcept
	Greater than or equal to operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer	operator+ (T i) const noexcept
	Addition operator. More...

integer	operator+ (const integer &i) const noexcept
	Addition operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer &	operator+= (T i) noexcept
	Addition operator. More...

integer &	operator+= (const integer &i) noexcept
	Addition operator. More...

integer	operator- () const noexcept
	Minus unary operator. Returns a new object of type 'integer'.

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer	operator- (T i) const noexcept
	Substraction operator. More...

integer	operator- (const integer &i) const noexcept
	Substraction operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer &	operator-= (T i) noexcept
	Substraction operator. More...

integer &	operator-= (const integer &i) noexcept
	Substraction operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer	operator* (T i) const noexcept
	Product operator. More...

integer	operator* (const integer &i) const noexcept
	Product operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer &	operator*= (T i) noexcept
	Product operator. More...

integer &	operator*= (const integer &i) noexcept
	Product operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer	operator/ (T i) const noexcept
	Division operator. More...

integer	operator/ (const integer &i) const noexcept
	Product operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer &	operator/= (T i) noexcept
	Division operator. More...

integer &	operator/= (const integer &i) noexcept
	Division operator. More...

integer	power (uint64_t i) const noexcept
	Exponentiation operator. More...

integer	power (const integer &i) const noexcept
	Exponentiation operator. More...

integer &	powt (uint64_t i) noexcept
	Exponentiation operator. More...

integer &	powt (const integer &i) noexcept
	Exponentiation operator. More...

uint64_t	operator% (uint64_t i) const noexcept
	Modulus operator. More...

integer	operator% (const integer &i) const noexcept
	Modulus operator. More...

constexpr bool	is_initialized () const noexcept
	Returns whether this object is initialised or not.

int64_t	get_sign () const noexcept
	Returns the sign of this integer.

std::size_t	bytes () const noexcept
	Returns the amount of bytes this integer occupies.

const mpz_t &	get_raw_value () const noexcept
	Returns the underlying gmp data structure.

int64_t	to_int () const noexcept
	Converts this integer to a signed 64-bit integer.

uint64_t	to_uint () const noexcept
	Converts this integer to an unsigned 64-bit integer.

double	to_double () const noexcept
	Converts this integer to a double-precision floating-point value.

std::string	to_string () const noexcept
	Converts this integer to a string.

void	as_string (std::string &s) const noexcept
	Converts this integer to a string. More...

void	swap (integer &i) noexcept
	Swaps the value of this integer with integer i's value. More...

Private Attributes
mpz_t	m_val
	Structure from GMP storing the integer's value.

bool	m_initialized = true
	Is this integer initialised?

Friends
template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator== (T i, const integer &ii) noexcept
	Equality operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator!= (T i, const integer &ii) noexcept
	Non-equality operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator< (T i, const integer &ii) noexcept
	Less operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator<= (T i, const integer &ii) noexcept
	Less than or equal to operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator> (T i, const integer &ii) noexcept
	Greater than operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
bool	operator>= (T i, const integer &ii) noexcept
	Greater than or equal to operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer	operator+ (T i, const integer &ii) noexcept
	Addition operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer	operator- (T i, const integer &ii) noexcept
	Substraction operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
integer	operator* (T i, const integer &ii) noexcept
	Product operator. More...

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>
int64_t	operator/ (T i, const integer &ii) noexcept
	Division operator. More...

void	swap (integer &i, integer &j) noexcept
	Swaps two integers. More...

Detailed Description

Arbitrary precision integer.

This class wraps the mpz_t data structure from GMP with operators for an easy usage.

Constructor & Destructor Documentation

◆ integer() [1/5]

lal::numeric::integer::integer ( mpz_t && raw )

inlinenoexcept

Constructor with mpz_t.

Postcondition: Object raw will have to be initialized by the callee.

◆ integer() [2/5]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

lal::numeric::integer::integer ( T i )

inlinenoexcept

Constructor with unsigned integer value.

Parameters

i	An integer (basic type) number.

◆ integer() [3/5]

lal::numeric::integer::integer ( const std::string & s )

inlinenoexcept

Constructor with string.

Parameters

s A string.

◆ integer() [4/5]

lal::numeric::integer::integer ( integer && i )

inlinenoexcept

Move constructor.

Parameters

i	A lal::numeric::integer.

Postcondition: Object i is not initialized.

◆ integer() [5/5]

lal::numeric::integer::integer ( const integer & i )

inlinenoexcept

Copy constructor.

Parameters

i	A lal::numeric::integer.

Member Function Documentation

◆ as_string()

void lal::numeric::integer::as_string ( std::string & s ) const

inlinenoexcept

Converts this integer to a string.

Parameters

s	A reference to a string.

◆ operator!=() [1/2]

bool lal::numeric::integer::operator!= ( const integer & i ) const

inlinenoexcept

Non-equality operator.

Parameters

i	A lal::numeric::integer.

◆ operator!=() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool lal::numeric::integer::operator!= ( T i ) const

inlinenoexcept

Non-equality operator.

Parameters

i	An integer (basic type) number.

◆ operator%() [1/2]

integer lal::numeric::integer::operator% ( const integer & i ) const

inlinenoexcept

Modulus operator.

Parameters

i	A lal::numeric::integer

◆ operator%() [2/2]

uint64_t lal::numeric::integer::operator% ( uint64_t i ) const

inlinenoexcept

Modulus operator.

Parameters

i	Unsigned integer (basic type) number.

◆ operator*() [1/2]

integer lal::numeric::integer::operator* ( const integer & i ) const

inlinenoexcept

Product operator.

Parameters

i	A lal::numeric::integer.

◆ operator*() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer lal::numeric::integer::operator* ( T i ) const

inlinenoexcept

Product operator.

Parameters

i	An integer (basic type) number.

◆ operator*=() [1/2]

integer & lal::numeric::integer::operator*= ( const integer & i )

inlinenoexcept

Product operator.

Parameters

i	A lal::numeric::integer.

◆ operator*=() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer & lal::numeric::integer::operator*= ( T i )

inlinenoexcept

Product operator.

Parameters

i	A signed/unsigned integer (basic type) number.

◆ operator+() [1/2]

integer lal::numeric::integer::operator+ ( const integer & i ) const

inlinenoexcept

Addition operator.

Parameters

i	A lal::numeric::integer.

◆ operator+() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer lal::numeric::integer::operator+ ( T i ) const

inlinenoexcept

Addition operator.

Parameters

i	An integer (basic type) number.

◆ operator+=() [1/2]

integer & lal::numeric::integer::operator+= ( const integer & i )

inlinenoexcept

Addition operator.

Parameters

i	A lal::numeric::integer.

◆ operator+=() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer & lal::numeric::integer::operator+= ( T i )

inlinenoexcept

Addition operator.

Parameters

i	An integer (basic type) number.

◆ operator-() [1/2]

integer lal::numeric::integer::operator- ( const integer & i ) const

inlinenoexcept

Substraction operator.

Parameters

i	A lal::numeric::integer.

◆ operator-() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer lal::numeric::integer::operator- ( T i ) const

inlinenoexcept

Substraction operator.

Parameters

i	An integer (basic type) number.

◆ operator-=() [1/2]

integer & lal::numeric::integer::operator-= ( const integer & i )

inlinenoexcept

Substraction operator.

Parameters

i	A lal::numeric::integer.

◆ operator-=() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer & lal::numeric::integer::operator-= ( T i )

inlinenoexcept

Substraction operator.

Parameters

i	An integer (basic type) number.

◆ operator/() [1/2]

integer lal::numeric::integer::operator/ ( const integer & i ) const

inlinenoexcept

Product operator.

Parameters

i	A lal::numeric::integer.

◆ operator/() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer lal::numeric::integer::operator/ ( T i ) const

inlinenoexcept

Division operator.

Parameters

i	An integer (basic type) number.

◆ operator/=() [1/2]

integer & lal::numeric::integer::operator/= ( const integer & i )

inlinenoexcept

Division operator.

Parameters

i	A lal::numeric::integer.

◆ operator/=() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer & lal::numeric::integer::operator/= ( T i )

inlinenoexcept

Division operator.

Parameters

i	An integer (basic type) number.

◆ operator<() [1/2]

bool lal::numeric::integer::operator< ( const integer & i ) const

inlinenoexcept

Less than operator.

Parameters

i	A lal::numeric::integer.

◆ operator<() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool lal::numeric::integer::operator< ( T i ) const

inlinenoexcept

Less than operator.

Parameters

i	An integer (basic type) number.

◆ operator<=() [1/2]

bool lal::numeric::integer::operator<= ( const integer & i ) const

inlinenoexcept

Less than or equal to operator.

Parameters

i	A lal::numeric::integer.

◆ operator<=() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool lal::numeric::integer::operator<= ( T i ) const

inlinenoexcept

Less than or equal to operator.

Parameters

i	An integer (basic type) number.

◆ operator=() [1/3]

integer & lal::numeric::integer::operator= ( const integer & i )

inlinenoexcept

Copy assignment operator.

Parameters

i	A lal::numeric::integer.

◆ operator=() [2/3]

integer & lal::numeric::integer::operator= ( integer && i )

inlinenoexcept

Move assignment operator.

Parameters

i	A lal::numeric::integer.

Postcondition: Object i is not initialized.

◆ operator=() [3/3]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer & lal::numeric::integer::operator= ( T i )

inlinenoexcept

Assignment operator.

Parameters

i	An integer (basic type) number.

◆ operator==() [1/2]

bool lal::numeric::integer::operator== ( const integer & i ) const

inlinenoexcept

Equality operator.

Parameters

i	A lal::numeric::integer.

◆ operator==() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool lal::numeric::integer::operator== ( T i ) const

inlinenoexcept

Equality operator.

Parameters

i	An integer (basic type) number.

◆ operator>() [1/2]

bool lal::numeric::integer::operator> ( const integer & i ) const

inlinenoexcept

Greater than operator.

Parameters

i	A lal::numeric::integer.

◆ operator>() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool lal::numeric::integer::operator> ( T i ) const

inlinenoexcept

Greater than operator.

Parameters

i	An integer (basic type) number.

◆ operator>=() [1/2]

bool lal::numeric::integer::operator>= ( const integer & i ) const

inlinenoexcept

Greater than or equal to operator.

Parameters

i	A lal::numeric::integer.

◆ operator>=() [2/2]

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool lal::numeric::integer::operator>= ( T i ) const

inlinenoexcept

Greater than or equal to operator.

Parameters

i	An integer (basic type) number.

◆ power() [1/2]

integer lal::numeric::integer::power ( const integer & i ) const

inlinenoexcept

Exponentiation operator.

Parameters

i	A lal::numeric::integer.

◆ power() [2/2]

integer lal::numeric::integer::power ( uint64_t i ) const

inlinenoexcept

Exponentiation operator.

Parameters

i	An unsigned integer (basic type).

◆ powt() [1/2]

integer & lal::numeric::integer::powt ( const integer & i )

noexcept

Exponentiation operator.

Modifies the current object.

Parameters

i	A lal::numeric::integer.

◆ powt() [2/2]

integer & lal::numeric::integer::powt ( uint64_t i )

inlinenoexcept

Exponentiation operator.

Modifies the current object.

Parameters

i	Unsigned integer (basic type) number.

◆ set_integer()

void lal::numeric::integer::set_integer ( const integer & i )

inlinenoexcept

Overwrites the value of this integer with i.

Parameters

i	A lal::numeric::integer.

◆ set_number()

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

void lal::numeric::integer::set_number ( T i )

inlinenoexcept

Overwrites the value of this integer with i.

Parameters

i	An integer (basic type) number.

◆ set_str()

void lal::numeric::integer::set_str ( const std::string & s )

inlinenoexcept

Overwrites the value of this integer with s.

Parameters

s A string.

◆ swap()

void lal::numeric::integer::swap ( integer & i )

inlinenoexcept

Swaps the value of this integer with integer i's value.

If none of the integers is initialised, it does nothing.
If only one of the integers is initialised, moves the contents of the initialised integer to the other. At the end, one of the two integers is left uninitiliased.
If both integers are initialised, swaps the values they contain.

Parameters

i	A lal::numeric::integer

Friends And Related Function Documentation

◆ operator!=

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool operator!=	(	T	i,
		const integer &	ii
	)

friend

Non-equality operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator*

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer operator*	(	T	i,
		const integer &	ii
	)

friend

Product operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator+

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer operator+	(	T	i,
		const integer &	ii
	)

friend

Addition operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator-

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

integer operator-	(	T	i,
		const integer &	ii
	)

friend

Substraction operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator/

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

int64_t operator/	(	T	i,
		const integer &	ii
	)

friend

Division operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator<

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool operator<	(	T	i,
		const integer &	ii
	)

friend

Less operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator<=

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool operator<=	(	T	i,
		const integer &	ii
	)

friend

Less than or equal to operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator==

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool operator==	(	T	i,
		const integer &	ii
	)

friend

Equality operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator>

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool operator>	(	T	i,
		const integer &	ii
	)

friend

Greater than operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ operator>=

template<typename T , std::enable_if_t< std::is_integral_v< T >, bool > = true>

bool operator>=	(	T	i,
		const integer &	ii
	)

friend

Greater than or equal to operator.

Parameters

i	An integer (basic type) number.
ii	A lal::numeric::integer.

◆ swap

void swap	(	integer &	i,
		integer &	j
	)

friend

Swaps two integers.

Parameters

i	Input lal::numeric::integer.
j	Input lal::numeric::integer.

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

lal/numeric/integer.hpp

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ integer() [1/5]

◆ integer() [2/5]

◆ integer() [3/5]

◆ integer() [4/5]

◆ integer() [5/5]

Member Function Documentation

◆ as_string()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator%() [1/2]

◆ operator%() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator<=() [1/2]

◆ operator<=() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>() [1/2]

◆ operator>() [2/2]

◆ operator>=() [1/2]

◆ operator>=() [2/2]

◆ power() [1/2]

◆ power() [2/2]

◆ powt() [1/2]

◆ powt() [2/2]

◆ set_integer()

◆ set_number()

◆ set_str()

◆ swap()

Friends And Related Function Documentation

◆ operator!=

◆ operator*

◆ operator+

◆ operator-

◆ operator/

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

◆ swap