Represents a number with arbitrary precision. It basically stores the value as a string. More...

#include <number.hpp>

Public Member Functions
	Number (std::string value="0", size_t prec=10, RoundingMode mode=RoundingMode::USE_CURRENT_PREC)
	Initializes a number with a specified value.
template<concepts::Numeric ValueT>
	Number (ValueT value, size_t prec=10, RoundingMode mode=RoundingMode::USE_CURRENT_PREC)
	Initializes a number with a C/C++ long double value.
void	set (std::string newVal)
void	setPrec (size_t newPrec, RoundingMode mode=RoundingMode::USE_CURRENT_PREC)
Number	operator+ (const Number &rhs) const
	Adds two numbers together.
Number	operator- (const Number &rhs) const
	Subtracts two numbers.
Number	operator* (const Number &rhs) const
	Multiplies two numbers.
Number	operator/ (const Number &rhs) const
	Divides two numbers.
Number	mod (const Number &rhs) const
	Takes a modulus operation.
Number	operator% (const Number &rhs) const
	Calculates the remainder of two numbers. (Modulus)
Number	operator^ (const Number &rhs)
	Raises the number to a power.
Number &	operator+= (const Number &rhs)
	Adds the number to another number and assigns the result to the current number.
Number &	operator-= (const Number &rhs)
	Subtracts the number from another number and assigns the result to the current number.
Number &	operator*= (const Number &rhs)
	Multiplies the number by another number and assigns the result to the current number.
Number &	operator/= (const Number &rhs)
	Divides the number by another number and assigns the result to the current number.
Number &	operator%= (const Number &rhs)
	Calculates the remainder of two numbers and assigns the result to the current number.
Number &	operator^= (const Number &rhs)
	Raises the number to a power and assigns the result to the current number.
bool	operator== (const Number &rhs) const
	Compares two numbers for equality.
bool	operator!= (const Number &rhs) const
	Compares two numbers for inequality.
bool	operator< (const Number &rhs) const
	Compares two numbers for less than.
bool	operator> (const Number &rhs) const
	Compares two numbers for greater than.
bool	operator<= (const Number &rhs) const
	Compares two numbers for less than or equal to.
bool	operator>= (const Number &rhs) const
	Compares two numbers for greater than or equal to.
Number	operator++ ()
	Increments the number by one.
Number	operator-- ()
	Decrements the number by one.
Number	operator- () const
	Unary minus operator.
Number	operator+ () const
	Unary plus operator.
std::string	present () const
	Presents the number in a human-readable format.
Number	abs () const
	Gets the absolute value of the number.

Private Member Functions
template<__internals::utils::StringLiteral fnName>
size_t	determinePrec (const Number &rhs) const

Private Attributes
std::string	value
	The value of the number.
size_t	prec
	The precision of the number.
RoundingMode	mode = RoundingMode::USE_CURRENT_PREC
	The rounding mode of the number.

Detailed Description

Represents a number with arbitrary precision. It basically stores the value as a string.

Constructor & Destructor Documentation

◆ Number() [1/2]

steppable::Number::Number	(	std::string	value = "0",
		size_t	prec = 10,
		RoundingMode	mode = RoundingMode::USE_CURRENT_PREC )

Initializes a number with a specified value.

Note: By default, the value is 0.

Here is the caller graph for this function:

◆ Number() [2/2]

template<concepts::Numeric ValueT>

steppable::Number::Number	(	ValueT	value,
		size_t	prec = 10,
		RoundingMode	mode = RoundingMode::USE_CURRENT_PREC )

inline

Initializes a number with a C/C++ long double value.

Note: No matter how the number is specified, it will always be converted to a string for storage.

Member Function Documentation

◆ abs()

Number steppable::Number::abs ( ) const

inlinenodiscard

Gets the absolute value of the number.

Returns: The absolute value of the current number.

Here is the call graph for this function:

◆ determinePrec()

template<__internals::utils::StringLiteral fnName>

size_t steppable::Number::determinePrec ( const Number & rhs ) const

inlinenodiscardprivate

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mod()

Number steppable::Number::mod ( const Number & rhs ) const

nodiscard

Takes a modulus operation.

Divides and takes the nearest quotient.

Parameters

rhs	The other number.

Returns: The modulus of the two numbers.

Here is the call graph for this function:

◆ operator!=()

bool steppable::Number::operator!= ( const Number & rhs ) const

Compares two numbers for inequality.

Parameters

rhs	The number to compare.

Returns: True if the numbers are not equal, false otherwise.

Here is the call graph for this function:

◆ operator%()

Number steppable::Number::operator% ( const Number & rhs ) const

Calculates the remainder of two numbers. (Modulus)

Parameters

rhs	The number to divide.

Returns: The remainder of the two numbers.

Here is the call graph for this function:

◆ operator%=()

Number & steppable::Number::operator%= ( const Number & rhs )

Calculates the remainder of two numbers and assigns the result to the current number.

Parameters

rhs	The number to divide.

Returns: The remainder of the two numbers.

Here is the call graph for this function:

◆ operator*()

Number steppable::Number::operator* ( const Number & rhs ) const

Multiplies two numbers.

Parameters

rhs	The number to multiply.

Returns: The product of the two numbers.

Here is the call graph for this function:

◆ operator*=()

Number & steppable::Number::operator*= ( const Number & rhs )

Multiplies the number by another number and assigns the result to the current number.

Parameters

rhs	The number to multiply.

Returns: The product of the two numbers.

Here is the call graph for this function:

◆ operator+() [1/2]

Number steppable::Number::operator+ ( ) const

Unary plus operator.

Does nothing. Simply returns a new instance of the number.

Returns: A number equal in value and equal in sign.

Here is the call graph for this function:

◆ operator+() [2/2]

Number steppable::Number::operator+ ( const Number & rhs ) const

Adds two numbers together.

Parameters

rhs	The number to add.

Returns: The sum of the two numbers.

Here is the call graph for this function:

◆ operator++()

Number steppable::Number::operator++ ( )

Increments the number by one.

Returns: The number after incrementing.

Here is the call graph for this function:

◆ operator+=()

Number & steppable::Number::operator+= ( const Number & rhs )

Adds the number to another number and assigns the result to the current number.

Parameters

rhs	The number to add.

Returns: The sum of the two numbers.

Here is the call graph for this function:

◆ operator-() [1/2]

Number steppable::Number::operator- ( ) const

Unary minus operator.

Converts the number to itself with the opposite sign. Returns a new instance of the number.

Returns: A number equal in value but opposite in sign.

Here is the call graph for this function:

◆ operator-() [2/2]

Number steppable::Number::operator- ( const Number & rhs ) const

Subtracts two numbers.

Parameters

rhs	The number to subtract.

Returns: The difference of the two numbers.

Here is the call graph for this function:

◆ operator--()

Number steppable::Number::operator-- ( )

Decrements the number by one.

Returns: The number after decrementing.

Here is the call graph for this function:

◆ operator-=()

Number & steppable::Number::operator-= ( const Number & rhs )

Subtracts the number from another number and assigns the result to the current number.

Parameters

rhs	The number to subtract.

Returns: The difference of the two numbers.

Here is the call graph for this function:

◆ operator/()

Number steppable::Number::operator/ ( const Number & rhs ) const

Divides two numbers.

Parameters

rhs	The number to divide.

Returns: The quotient of the two numbers.

Here is the call graph for this function:

◆ operator/=()

Number & steppable::Number::operator/= ( const Number & rhs )

Divides the number by another number and assigns the result to the current number.

Parameters

rhs	The number to divide.

Returns: The quotient of the two numbers.

Here is the call graph for this function:

◆ operator<()

bool steppable::Number::operator< ( const Number & rhs ) const

Compares two numbers for less than.

Parameters

rhs	The number to compare.

Returns: True if the current number is less than the other number, false otherwise.

Here is the call graph for this function:

◆ operator<=()

bool steppable::Number::operator<= ( const Number & rhs ) const

Compares two numbers for less than or equal to.

Parameters

rhs	The number to compare.

Returns: True if the current number is less than or equal to the other number, false otherwise.

Here is the call graph for this function:

◆ operator==()

bool steppable::Number::operator== ( const Number & rhs ) const

Compares two numbers for equality.

Parameters

rhs	The number to compare.

Returns: True if the numbers are equal, false otherwise.

Here is the call graph for this function:

◆ operator>()

bool steppable::Number::operator> ( const Number & rhs ) const

Compares two numbers for greater than.

Parameters

rhs	The number to compare.

Returns: True if the current number is greater than the other number, false otherwise.

Here is the call graph for this function:

◆ operator>=()

bool steppable::Number::operator>= ( const Number & rhs ) const

Compares two numbers for greater than or equal to.

Parameters

rhs	The number to compare.

Returns: True if the current number is greater than or equal to the other number, false otherwise.

Here is the call graph for this function:

◆ operator^()

Number steppable::Number::operator^ ( const Number & rhs )

Raises the number to a power.

Parameters

rhs	The power to raise the number to.

Returns: The result of the power operation.

Here is the call graph for this function:

◆ operator^=()

Number & steppable::Number::operator^= ( const Number & rhs )

Raises the number to a power and assigns the result to the current number.

Parameters

rhs	The power to raise the number to.

Returns: The result of the power operation.

Here is the call graph for this function:

◆ present()

std::string steppable::Number::present ( ) const

nodiscard

Presents the number in a human-readable format.

Returns: The number as a string.

Here is the caller graph for this function:

◆ set()

void steppable::Number::set ( std::string newVal )

inline

◆ setPrec()

void steppable::Number::setPrec	(	size_t	newPrec,
		RoundingMode	mode = RoundingMode::USE_CURRENT_PREC )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mode

RoundingMode steppable::Number::mode = RoundingMode::USE_CURRENT_PREC

private

The rounding mode of the number.

◆ prec

size_t steppable::Number::prec

private

The precision of the number.

◆ value

std::string steppable::Number::value

private

The value of the number.

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

include/steppable/number.hpp
src/steppable/number.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Number() [1/2]

◆ Number() [2/2]

Member Function Documentation

◆ abs()

◆ determinePrec()

◆ mod()

◆ operator!=()

◆ operator%()

◆ operator%=()

◆ operator*()

◆ operator*=()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator++()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator--()

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator^()

◆ operator^=()

◆ present()

◆ set()

◆ setPrec()

Member Data Documentation

◆ mode

◆ prec

◆ value