lal::numeric::integer Class Reference

Arbitrary precision integer. More...

#include <integer.hpp>

Public Member Functions
	integer () noexcept
	Empty constructor.
	integer (mpz_t &&raw)
	Constructor with mpz_t.
	integer (int64_t i) noexcept
	Constructor with unsigned integer value.
	integer (const std::string &s) noexcept
	Constructor with string.
	integer (integer &&i) noexcept
	Move constructor.
	integer (const integer &i) noexcept
	Copy constructor.
	~integer () noexcept
	Destructor.
void	set_si (int64_t i) noexcept
	Overwrites the value of this integer with i.
void	set_ui (uint64_t i) noexcept
	Overwrites the value of this integer with i.
void	set_integer (const integer &i) noexcept
	Overwrites the value of this integer with i.
void	set_str (const std::string &s) noexcept
	Overwrites the value of this integer with s.
integer &	operator= (int64_t i) noexcept
	Assignment operator.
integer &	operator= (const integer &i) noexcept
	Copy assignment operator.
integer &	operator= (integer &&i) noexcept
	Move assignment operator.
bool	operator== (int64_t i) const noexcept
	Equality operator.
bool friend	operator== (int64_t i, const integer &ii) noexcept
	Equality operator.
bool	operator== (const integer &i) const noexcept
	Equality operator.
bool	operator!= (int64_t i) const noexcept
	Non-equality operator.
bool friend	operator!= (int64_t i, const integer &ii) noexcept
	Non-equality operator.
bool	operator!= (const integer &i) const noexcept
	Non-equality operator.
bool	operator< (int64_t i) const noexcept
	Less than operator.
bool	operator< (const integer &i) const noexcept
	Less than operator.
bool	operator<= (int64_t i) const noexcept
	Less than or equal to operator.
bool	operator<= (const integer &i) const noexcept
	Less than or equal to operator.
bool	operator> (int64_t i) const noexcept
	Greater than operator.
bool	operator> (const integer &i) const noexcept
	Greater than operator.
bool	operator>= (int64_t i) const noexcept
	Greater than or equal to operator.
bool	operator>= (const integer &i) const noexcept
	Greater than or equal to operator.
integer	operator+ (int64_t i) const noexcept
	Addition operator.
integer	operator+ (const integer &i) const noexcept
	Addition operator.
integer &	operator+= (int64_t i) noexcept
	Addition operator.
integer &	operator+= (const integer &i) noexcept
	Addition operator.
integer	operator- () const noexcept
	Minus unary operator. Returns a new object of type 'integer'.
integer	operator- (int64_t i) const noexcept
	Substraction operator.
integer	operator- (const integer &i) const noexcept
	Substraction operator.
integer &	operator-= (int64_t i) noexcept
	Substraction operator.
integer &	operator-= (const integer &i) noexcept
	Substraction operator.
integer	operator* (int64_t i) const noexcept
	Product operator.
integer	operator* (const integer &i) const noexcept
	Product operator.
integer &	operator*= (int64_t i) noexcept
	Product operator.
integer &	operator*= (const integer &i) noexcept
	Product operator.
integer	operator/ (int64_t i) const noexcept
	Division operator.
integer	operator/ (const integer &i) const noexcept
	Product operator.
integer &	operator/= (int64_t i) noexcept
	Division operator.
integer &	operator/= (const integer &i) noexcept
	Division operator.
integer	pow (uint64_t i) const noexcept
	Exponentiation operator.
integer	pow (const integer &i) const noexcept
	Exponentiation operator.
integer &	powt (uint64_t i) noexcept
	Exponentiation operator.
integer &	powt (const integer &i) noexcept
	Exponentiation operator.
uint64_t	operator% (uint64_t i) const noexcept
	Modulus operator.
integer	operator% (const integer &i) const noexcept
	Modulus operator.
constexpr bool	is_initialized () const noexcept
	Returns whether this object is initialised or not.
int32_t	get_sign () const noexcept
	Returns the sign of this integer.
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.
void	swap (integer &i) noexcept
	Swaps the value of this integer with integer i's value.

Private Attributes
mpz_t	m_val
	Structure from GMP storing the integer's value.
bool	m_initialized = true
	Is this integer initialised?

Friends
bool	operator< (int64_t i, const integer &ii) noexcept
	Less operator.
bool	operator<= (int64_t i, const integer &ii) noexcept
	Less than or equal to operator.
bool	operator> (int64_t i, const integer &ii) noexcept
	Greater than operator.
bool	operator>= (int64_t i, const integer &ii) noexcept
	Greater than or equal to operator.
integer	operator+ (int64_t i, const integer &ii) noexcept
	Addition operator.
integer	operator- (int64_t i, const integer &ii) noexcept
	Substraction operator.
integer	operator* (int64_t i, const integer &ii) noexcept
	Product operator.
int64_t	operator/ (int64_t i, const integer &ii) noexcept
	Division operator.
void	swap (integer &i, integer &j) noexcept
	Swaps two integers.

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/4]

lal::numeric::integer::integer ( int64_t i )

inlinenoexcept

Constructor with unsigned integer value.

Parameters

i	A signed integer (basic type) number.

integer() [2/4]

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

inlinenoexcept

Constructor with string.

Parameters

s

A string.

integer() [3/4]

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

noexcept

Move constructor.

Parameters

i	A lal::numeric::integer.

integer() [4/4]

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/3]

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

inlinenoexcept

Non-equality operator.

Parameters

i	A lal::numeric::integer.

operator!=() [2/3]

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

inlinenoexcept

Non-equality operator.

Parameters

i	A signed integer (basic type) number.

operator!=() [3/3]

bool friend lal::numeric::integer::operator!= ( int64_t i, const integer & ii )

inlinenoexcept

Non-equality operator.

Parameters

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

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]

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

inlinenoexcept

Product operator.

Parameters

i	A signed 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]

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

inlinenoexcept

Product operator.

Parameters

i	A signed 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]

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

inlinenoexcept

Addition operator.

Parameters

i	A signed 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]

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

noexcept

Addition operator.

Parameters

i	A signed 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]

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

inlinenoexcept

Substraction operator.

Parameters

i	A signed 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]

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

noexcept

Substraction operator.

Parameters

i	A signed 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]

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

inlinenoexcept

Division operator.

Parameters

i	A signed 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]

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

noexcept

Division operator.

Parameters

i	A signed 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]

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

inlinenoexcept

Less than operator.

Parameters

i	A signed 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]

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

inlinenoexcept

Less than or equal to operator.

Parameters

i	A signed 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= ( int64_t i )

inlinenoexcept

Assignment operator.

Parameters

i	A signed integer (basic type) number.

operator=() [3/3]

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

noexcept

Move assignment operator.

Parameters

i	A lal::numeric::integer.

operator==() [1/3]

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

inlinenoexcept

Equality operator.

Parameters

i	A lal::numeric::integer.

operator==() [2/3]

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

inlinenoexcept

Equality operator.

Parameters

i	A signed integer (basic type) number.

operator==() [3/3]

bool friend lal::numeric::integer::operator== ( int64_t i, const integer & ii )

inlinenoexcept

Equality operator.

Parameters

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

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]

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

inlinenoexcept

Greater than operator.

Parameters

i	A signed 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]

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

inlinenoexcept

Greater than or equal to operator.

Parameters

i	A signed integer (basic type) number.

pow() [1/2]

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

inlinenoexcept

Exponentiation operator.

Parameters

i	A lal::numeric::integer.

pow() [2/2]

integer lal::numeric::integer::pow ( 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_si()

void lal::numeric::integer::set_si ( int64_t i )

inlinenoexcept

Overwrites the value of this integer with i.

Parameters

i	A signed 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.

set_ui()

void lal::numeric::integer::set_ui ( uint64_t i )

inlinenoexcept

Overwrites the value of this integer with i.

Parameters

i	Unsigned integer (basic type) number.

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 Symbol Documentation

operator*

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

friend

Product operator.

Parameters

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

operator+

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

friend

Addition operator.

Parameters

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

operator-

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

friend

Substraction operator.

Parameters

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

operator/

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

friend

Division operator.

Parameters

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

operator<

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

friend

Less operator.

Parameters

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

operator<=

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

friend

Less than or equal to operator.

Parameters

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

operator>

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

friend

Greater than operator.

Parameters

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

operator>=

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

friend

Greater than or equal to operator.

Parameters

i	A signed 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