hsc_snippets::RationalNumber Class Reference

#include <rational_number.hpp>

Public Member Functions
	RationalNumber (const RationalNumber &other)=default
	RationalNumber (RationalNumber &&other) noexcept=default
RationalNumber &	operator= (const RationalNumber &other)=default
RationalNumber &	operator= (RationalNumber &&other) noexcept=default
RationalNumber	operator+ (const RationalNumber &other) const
RationalNumber	operator- (const RationalNumber &other) const
RationalNumber	operator* (const RationalNumber &other) const
RationalNumber	operator/ (const RationalNumber &other) const
RationalNumber &	operator+= (const RationalNumber &other)
RationalNumber &	operator-= (const RationalNumber &other)
RationalNumber &	operator*= (const RationalNumber &other)
RationalNumber &	operator/= (const RationalNumber &other)
RationalNumber	operator- () const
RationalNumber	inverse () const
RationalNumber	negate () const
RationalNumber	abs () const
std::string	to_string () const
bool	operator== (const RationalNumber &other) const
bool	operator!= (const RationalNumber &other) const
bool	operator< (const RationalNumber &other) const
bool	operator<= (const RationalNumber &other) const
bool	operator> (const RationalNumber &other) const
bool	operator>= (const RationalNumber &other) const
const BigInteger &	getNominator () const
const BigInteger &	getDenominator () const

Static Public Member Functions
static RationalNumber	create (BigInteger nominator, BigInteger denominator)
static RationalNumber	create (BigInteger nominator)
static const RationalNumber &	zero ()
static const RationalNumber &	one ()

Constructor & Destructor Documentation

RationalNumber() [1/2]

hsc_snippets::RationalNumber::RationalNumber ( const RationalNumber & other )

default

RationalNumber() [2/2]

hsc_snippets::RationalNumber::RationalNumber ( RationalNumber && other )

defaultnoexcept

Member Function Documentation

abs()

RationalNumber hsc_snippets::RationalNumber::abs ( ) const

inlinenodiscard

create() [1/2]

static RationalNumber hsc_snippets::RationalNumber::create ( BigInteger nominator )

inlinestatic

Creates a RationalNumber with the given numerator and a denominator of 1.

Parameters

nominator

The numerator of the rational number.

Returns

A RationalNumber representing nominator/1.

create() [2/2]

static RationalNumber hsc_snippets::RationalNumber::create ( BigInteger nominator, BigInteger denominator )

inlinestatic

Creates a RationalNumber with the given numerator and denominator.

Parameters

nominator	The numerator of the rational number.
denominator	The denominator of the rational number. Must not be zero.

Returns

A RationalNumber representing nominator/denominator.

Exceptions

std::invalid_argument

if the denominator is zero.

getDenominator()

const BigInteger & hsc_snippets::RationalNumber::getDenominator ( ) const

inlinenodiscard

getNominator()

const BigInteger & hsc_snippets::RationalNumber::getNominator ( ) const

inlinenodiscard

inverse()

RationalNumber hsc_snippets::RationalNumber::inverse ( ) const

inlinenodiscard

Returns

negate()

RationalNumber hsc_snippets::RationalNumber::negate ( ) const

inlinenodiscard

one()

static const RationalNumber & hsc_snippets::RationalNumber::one ( )

inlinestatic

Returns a reference to a static RationalNumber representing 1/1.

Returns

A reference to a RationalNumber with a value of one.

operator!=()

bool hsc_snippets::RationalNumber::operator!= ( const RationalNumber & other ) const

inline

operator*()

RationalNumber hsc_snippets::RationalNumber::operator* ( const RationalNumber & other ) const

inline

operator*=()

RationalNumber & hsc_snippets::RationalNumber::operator*= ( const RationalNumber & other )

inline

operator+()

RationalNumber hsc_snippets::RationalNumber::operator+ ( const RationalNumber & other ) const

inline

operator+=()

RationalNumber & hsc_snippets::RationalNumber::operator+= ( const RationalNumber & other )

inline

operator-() [1/2]

RationalNumber hsc_snippets::RationalNumber::operator- ( ) const

inline

operator-() [2/2]

RationalNumber hsc_snippets::RationalNumber::operator- ( const RationalNumber & other ) const

inline

operator-=()

RationalNumber & hsc_snippets::RationalNumber::operator-= ( const RationalNumber & other )

inline

operator/()

RationalNumber hsc_snippets::RationalNumber::operator/ ( const RationalNumber & other ) const

inline

operator/=()

RationalNumber & hsc_snippets::RationalNumber::operator/= ( const RationalNumber & other )

inline

operator<()

bool hsc_snippets::RationalNumber::operator< ( const RationalNumber & other ) const

inline

operator<=()

bool hsc_snippets::RationalNumber::operator<= ( const RationalNumber & other ) const

inline

operator=() [1/2]

RationalNumber & hsc_snippets::RationalNumber::operator= ( const RationalNumber & other )

default

operator=() [2/2]

RationalNumber & hsc_snippets::RationalNumber::operator= ( RationalNumber && other )

defaultnoexcept

operator==()

bool hsc_snippets::RationalNumber::operator== ( const RationalNumber & other ) const

inline

operator>()

bool hsc_snippets::RationalNumber::operator> ( const RationalNumber & other ) const

inline

operator>=()

bool hsc_snippets::RationalNumber::operator>= ( const RationalNumber & other ) const

inline

to_string()

std::string hsc_snippets::RationalNumber::to_string ( ) const

inlinenodiscard

zero()

static const RationalNumber & hsc_snippets::RationalNumber::zero ( )

inlinestatic

Returns a reference to a static RationalNumber representing 0/1.

Returns

A reference to a RationalNumber with a value of zero.

---

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

• src/rational_number.hpp