diff --git a/.gitignore b/.gitignore index 6d0cf62..2368036 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Doxygen folder +docs/html + # Binaries bin diff --git a/docs/Doxyfile b/docs/Doxyfile index 22254e8..4a7e1b3 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -983,7 +983,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/docs/html/_big_int_8hpp.html b/docs/html/_big_int_8hpp.html deleted file mode 100644 index 55c2869..0000000 --- a/docs/html/_big_int_8hpp.html +++ /dev/null @@ -1,103 +0,0 @@ - - -
- - - - -- |
- Big Integer library for C++
- |
-
Contains class declaration for BigInt. -More...
-#include <iostream>
Go to the source code of this file.
--Classes | |
class | BigInt |
Class that contains an arbitrarily sized integer. More... | |
Contains class declaration for BigInt.
-- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
CBigInt | Class that contains an arbitrarily sized integer |
- |
- Big Integer library for C++
- |
-
Arithmetic-assignment operators. -More...
-#include "BigInt.hpp"
#include "constructors/constructors.hpp"
#include "operators/assignment.hpp"
#include "operators/binary_arithmetic.hpp"
Go to the source code of this file.
-Arithmetic-assignment operators.
-- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
Assignment operators of BigInt. -More...
- -Go to the source code of this file.
-Assignment operators of BigInt.
-- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
Binary arithmetic operators for BigInt. -More...
-#include <climits>
#include <cmath>
#include <string>
#include "BigInt.hpp"
#include "constructors/constructors.hpp"
#include "functions/math.hpp"
#include "functions/utility.hpp"
#include "operators/arithmetic_assignment.hpp"
#include "operators/assignment.hpp"
#include "operators/increment_decrement.hpp"
#include "operators/relational.hpp"
#include "operators/unary_arithmetic.hpp"
Go to the source code of this file.
--Functions | |
BigInt | operator+ (const long long &lhs, const BigInt &rhs) |
Overloaded operator for adding BigInt to long long More... | |
BigInt | operator- (const long long &lhs, const BigInt &rhs) |
Overloaded operator for subtracting BigInt by long long More... | |
BigInt | operator* (const long long &lhs, const BigInt &rhs) |
Overloaded operator for multiplying long long and BigInt. More... | |
BigInt | operator/ (const long long &lhs, const BigInt &rhs) |
Overloaded operator for integer dividing long long by BigInt. More... | |
BigInt | operator% (const long long &lhs, const BigInt &rhs) |
Overloaded operator for performing long long modulo BigInt. More... | |
BigInt | operator+ (const std::string &lhs, const BigInt &rhs) |
Overloaded operator for adding BigInt to std::string More... | |
BigInt | operator- (const std::string &lhs, const BigInt &rhs) |
Overloaded operator for subtracting BigInt by std::string More... | |
BigInt | operator* (const std::string &lhs, const BigInt &rhs) |
Overloaded operator for multiplying std::string and BigInt. More... | |
BigInt | operator/ (const std::string &lhs, const BigInt &rhs) |
Overloaded operator for integer dividing std::string by BigInt. More... | |
BigInt | operator% (const std::string &lhs, const BigInt &rhs) |
Overloaded operator for performing std::string modulo BigInt. More... | |
-Variables | |
const long long | FLOOR_SQRT_LLONG_MAX = 3037000499 |
Binary arithmetic operators for BigInt.
-const long long FLOOR_SQRT_LLONG_MAX = 3037000499 | -
Square root of LLONG_MAX
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
This is the complete list of members for BigInt, including all inherited members.
-big_random(size_t) | BigInt | friend |
BigInt() | BigInt | |
BigInt(const BigInt &) | BigInt | |
BigInt(const long long &) | BigInt | |
BigInt(const std::string &) | BigInt | |
divide(const BigInt ÷nd, const BigInt &divisor) | BigInt | related |
operator!=(const BigInt &) const | BigInt | |
operator!=(const long long &) const | BigInt | |
operator!=(const std::string &) const | BigInt | |
operator%(const BigInt &) const | BigInt | |
operator%(const long long &) const | BigInt | |
operator%(const std::string &) const | BigInt | |
operator%=(const BigInt &) | BigInt | |
operator%=(const long long &) | BigInt | |
operator%=(const std::string &) | BigInt | |
operator*(const BigInt &) const | BigInt | |
operator*(const long long &) const | BigInt | |
operator*(const std::string &) const | BigInt | |
operator*=(const BigInt &) | BigInt | |
operator*=(const long long &) | BigInt | |
operator*=(const std::string &) | BigInt | |
operator+() const | BigInt | |
operator+(const BigInt &) const | BigInt | |
operator+(const long long &) const | BigInt | |
operator+(const std::string &) const | BigInt | |
operator++() | BigInt | |
operator++(int) | BigInt | |
operator+=(const BigInt &) | BigInt | |
operator+=(const long long &) | BigInt | |
operator+=(const std::string &) | BigInt | |
operator-() const | BigInt | |
operator-(const BigInt &) const | BigInt | |
operator-(const long long &) const | BigInt | |
operator-(const std::string &) const | BigInt | |
operator--() | BigInt | |
operator--(int) | BigInt | |
operator-=(const BigInt &) | BigInt | |
operator-=(const long long &) | BigInt | |
operator-=(const std::string &) | BigInt | |
operator/(const BigInt &) const | BigInt | |
operator/(const long long &) const | BigInt | |
operator/(const std::string &) const | BigInt | |
operator/=(const BigInt &) | BigInt | |
operator/=(const long long &) | BigInt | |
operator/=(const std::string &) | BigInt | |
operator<(const BigInt &) const | BigInt | |
operator<(const long long &) const | BigInt | |
operator<(const std::string &) const | BigInt | |
operator<<(std::ostream &, const BigInt &) | BigInt | friend |
operator<=(const BigInt &) const | BigInt | |
operator<=(const long long &) const | BigInt | |
operator<=(const std::string &) const | BigInt | |
operator=(const BigInt &) | BigInt | |
operator=(const long long &) | BigInt | |
operator=(const std::string &) | BigInt | |
operator==(const BigInt &) const | BigInt | |
operator==(const long long &) const | BigInt | |
operator==(const std::string &) const | BigInt | |
operator>(const BigInt &) const | BigInt | |
operator>(const long long &) const | BigInt | |
operator>(const std::string &) const | BigInt | |
operator>=(const BigInt &) const | BigInt | |
operator>=(const long long &) const | BigInt | |
operator>=(const std::string &) const | BigInt | |
operator>>(std::istream &, BigInt &) | BigInt | friend |
to_int() const | BigInt | |
to_long() const | BigInt | |
to_long_long() const | BigInt | |
to_string() const | BigInt |
- |
- Big Integer library for C++
- |
-
Class that contains an arbitrarily sized integer. - More...
- -#include <BigInt.hpp>
-Public Member Functions | |
BigInt () | |
Default constructor for BigInt. More... | |
BigInt (const BigInt &) | |
Copy constructor for BigInt. More... | |
BigInt (const long long &) | |
Constructor that converts long long to BigInt. More... | |
BigInt (const std::string &) | |
Constructor that converts std::string to BigInt. More... | |
-BigInt & | operator= (const BigInt &) |
Assigns BigInt value to BigInt object. | |
BigInt & | operator= (const long long &) |
Assigns long long value to BigInt object. More... | |
BigInt & | operator= (const std::string &) |
Assigns std::string value to BigInt object. More... | |
BigInt | operator+ () const |
Performs unary + operation on BigInt. More... | |
BigInt | operator- () const |
Performs unary - operation on BigInt. More... | |
BigInt | operator+ (const BigInt &) const |
Performs addition on two BigInt values. More... | |
BigInt | operator- (const BigInt &) const |
Performs subtraction on two BigInt values. More... | |
BigInt | operator* (const BigInt &) const |
Performs multiplication on two BigInt values. More... | |
BigInt | operator/ (const BigInt &) const |
Performs integer division on two BigInt values and returns quotient. More... | |
BigInt | operator% (const BigInt &) const |
Returns remainder after performing integer division (modulo) on the two BigInt values. More... | |
BigInt | operator+ (const long long &) const |
Adds BigInt with long long value. More... | |
BigInt | operator- (const long long &) const |
Subtracts long long from BigInt value. More... | |
BigInt | operator* (const long long &) const |
Perform multiplication of BigInt and long long value. More... | |
BigInt | operator/ (const long long &) const |
Quotient of integer division of BigInt with long long value. More... | |
BigInt | operator% (const long long &) const |
Remainder of integer division of BigInt with long long value (modulus) More... | |
BigInt | operator+ (const std::string &) const |
Adds BigInt with std::string value. More... | |
BigInt | operator- (const std::string &) const |
Subtracts std::string from BigInt value. More... | |
BigInt | operator* (const std::string &) const |
Perform multiplication of BigInt and std::string value. More... | |
BigInt | operator/ (const std::string &) const |
Quotient of integer division of BigInt with std::string value. More... | |
BigInt | operator% (const std::string &) const |
Remainder of integer division of BigInt with std::string value (modulus) More... | |
-BigInt & | operator+= (const BigInt &) |
Shorthand for BigInt::operator+(const BigInt &) const. | |
-BigInt & | operator-= (const BigInt &) |
Shorthand for BigInt::operator-(const BigInt &) const. | |
-BigInt & | operator*= (const BigInt &) |
Shorthand for BigInt::operator*(const BigInt &) const. | |
-BigInt & | operator/= (const BigInt &) |
Shorthand for BigInt::operator/(const BigInt &) const. | |
-BigInt & | operator%= (const BigInt &) |
Shorthand for BigInt::operator%(const BigInt &) const. | |
-BigInt & | operator+= (const long long &) |
Shorthand for BigInt::operator+(const long long &) const. | |
-BigInt & | operator-= (const long long &) |
Shorthand for BigInt::operator-(const long long &) const. | |
-BigInt & | operator*= (const long long &) |
Shorthand for BigInt::operator*(const long long &) const. | |
-BigInt & | operator/= (const long long &) |
Shorthand for BigInt::operator/(const long long &) const. | |
-BigInt & | operator%= (const long long &) |
Shorthand for BigInt::operator%(const long long &) const. | |
-BigInt & | operator+= (const std::string &) |
Shorthand for BigInt::operator+(const std::string &) const. | |
-BigInt & | operator-= (const std::string &) |
Shorthand for BigInt::operator-(const std::string &) const. | |
-BigInt & | operator*= (const std::string &) |
Shorthand for BigInt::operator*(const std::string &) const. | |
-BigInt & | operator/= (const std::string &) |
Shorthand for BigInt::operator/(const std::string &) const. | |
-BigInt & | operator%= (const std::string &) |
Shorthand for BigInt::operator%(const std::string &) const. | |
-BigInt & | operator++ () |
Pre-increments the BigInt by 1. | |
-BigInt & | operator-- () |
Pre-decrements the BigInt by 1. | |
-BigInt | operator++ (int) |
Post-increments the BigInt by 1. | |
-BigInt | operator-- (int) |
Post-decrements the BigInt by 1. | |
-bool | operator< (const BigInt &) const |
Less than operator for two BigInt values. | |
-bool | operator> (const BigInt &) const |
Greater than operator for two BigInt values. | |
-bool | operator<= (const BigInt &) const |
Less than equal to operator for two BigInt values. | |
-bool | operator>= (const BigInt &) const |
Greater than equal to operator for two BigInt values. | |
-bool | operator== (const BigInt &) const |
Equal To operator for two BigInt values. | |
-bool | operator!= (const BigInt &) const |
Not Equal To operator for two BigInt values. | |
-bool | operator< (const long long &) const |
Less Than operator for BigInt vs long long | |
-bool | operator> (const long long &) const |
Greater Than operator for BigInt vs long long | |
-bool | operator<= (const long long &) const |
Less Than Equal To operator for BigInt vs long long | |
-bool | operator>= (const long long &) const |
Greater Than Equal To operator for BigInt vs long long | |
-bool | operator== (const long long &) const |
Equal To operator for BigInt vs long long | |
-bool | operator!= (const long long &) const |
Not Equal To operator for BigInt vs long long | |
-bool | operator< (const std::string &) const |
Less Than operator for BigInt vs std::string | |
-bool | operator> (const std::string &) const |
Greater Than operator for BigInt vs std::string | |
-bool | operator<= (const std::string &) const |
Less Than Equal To operator for BigInt vs std::string | |
-bool | operator>= (const std::string &) const |
Greater Than Equal To operator for BigInt vs std::string | |
-bool | operator== (const std::string &) const |
Equal To operator for BigInt vs std::string | |
-bool | operator!= (const std::string &) const |
Not Equal To operator for BigInt vs std::string | |
std::string | to_string () const |
Converts BigInt into an std::string representation. More... | |
int | to_int () const |
Converts BigInt into int More... | |
long | to_long () const |
Converts BigInt into long More... | |
long long | to_long_long () const |
Converts BigInt into long long More... | |
-Friends | |
-std::istream & | operator>> (std::istream &, BigInt &) |
Get BigInt from the input stream. | |
-std::ostream & | operator<< (std::ostream &, const BigInt &) |
Put BigInt into the output stream. | |
BigInt | big_random (size_t) |
Generates a random BigInt with a specificied number of digits. More... | |
-Related Functions | |
(Note that these are not member functions.) - | |
std::tuple< BigInt, BigInt > | divide (const BigInt ÷nd, const BigInt &divisor) |
Helper function to perform division on two BigInt values. More... | |
Class that contains an arbitrarily sized integer.
-BigInt::BigInt | -( | -) | -- |
BigInt::BigInt | -( | -const BigInt & | -num | ) | -- |
BigInt::BigInt | -( | -const long long & | -num | ) | -- |
BigInt::BigInt | -( | -const std::string & | -num | ) | -- |
BigInt BigInt::operator% | -( | -const long long & | -num | ) | -const | -
Remainder of integer division of BigInt with long long
value (modulus)
Uses BigInt::operator%(const BigInt&) const after converting num
to BigInt type.
num | is a long long value (modulus) |
BigInt BigInt::operator% | -( | -const std::string & | -num | ) | -const | -
Remainder of integer division of BigInt with std::string
value (modulus)
Uses BigInt::operator%(const BigInt&) const after converting num
to BigInt type.
num | is a std::string value (modulus) |
BigInt BigInt::operator* | -( | -const long long & | -num | ) | -const | -
Perform multiplication of BigInt and long long
value.
Uses BigInt::operator*(const BigInt&) const after converting num
to BigInt type.
num | is a long long value |
BigInt BigInt::operator* | -( | -const std::string & | -num | ) | -const | -
Perform multiplication of BigInt and std::string
value.
Uses BigInt::operator*(const BigInt&) const after converting num
to BigInt type.
num | is a std::string value |
BigInt BigInt::operator+ | -( | -) | -const | -
BigInt BigInt::operator+ | -( | -const long long & | -num | ) | -const | -
Adds BigInt with long long
value.
Uses BigInt::operator+(const BigInt &) const after converting num
to BigInt type.
num | is a long long value |
BigInt BigInt::operator+ | -( | -const std::string & | -num | ) | -const | -
Adds BigInt with std::string
value.
Uses BigInt::operator+(const BigInt &) const after converting num
to BigInt type.
num | is a std::string value |
BigInt BigInt::operator- | -( | -) | -const | -
BigInt BigInt::operator- | -( | -const long long & | -num | ) | -const | -
Subtracts long long
from BigInt value.
Uses BigInt::operator-(const BigInt&) const after converting num
to BigInt type.
num | is a long long value |
BigInt BigInt::operator- | -( | -const std::string & | -num | ) | -const | -
Subtracts std::string
from BigInt value.
Uses BigInt::operator-(const BigInt&) const after converting num
to BigInt type.
num | is a std::string value |
BigInt BigInt::operator/ | -( | -const long long & | -num | ) | -const | -
Quotient of integer division of BigInt with long long
value.
Uses BigInt::operator/(const BigInt&) const after converting num
to BigInt type.
num | is a long long value |
BigInt BigInt::operator/ | -( | -const std::string & | -num | ) | -const | -
Quotient of integer division of BigInt with std::string
value.
Uses BigInt::operator/(const BigInt&) const after converting num
to BigInt type.
num | is a std::string value |
BigInt & BigInt::operator= | -( | -const long long & | -num | ) | -- |
Assigns long long
value to BigInt object.
Makes use of BigInt::BigInt(const long long &num)
- -BigInt & BigInt::operator= | -( | -const std::string & | -num | ) | -- |
Assigns std::string
value to BigInt object.
Makes use of BigInt::BigInt(const std::string &num)
- -int BigInt::to_int | -( | -) | -const | -
long BigInt::to_long | -( | -) | -const | -
long long BigInt::to_long_long | -( | -) | -const | -
std::string BigInt::to_string | -( | -) | -const | -
-
|
- -friend | -
Generates a random BigInt with a specificied number of digits.
-Returns a random BigInt with a specific number of digits.
num_digits | int specifying number of digits in BigInt. It is optional. |
num_digits
number of digits
-
|
- -related | -
Helper function to perform division on two BigInt values.
-Does naive divisor addition until dividend is crossed.
-dividend | is the BigInt value to be divided |
divisor | if the BigInt value dividend is to be divided by |
std::tuple
of two BigInt values containing the quotient and remainder of the division performed. - |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
contains constructors of BigInt -More...
- -Go to the source code of this file.
-contains constructors of BigInt
-- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
Contains conversion related functions of BigInt. -More...
- -Go to the source code of this file.
-Contains conversion related functions of BigInt.
-- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
-Files | |
file | arithmetic_assignment.hpp [code] |
Arithmetic-assignment operators. | |
file | assignment.hpp [code] |
Assignment operators of BigInt. | |
file | binary_arithmetic.hpp [code] |
Binary arithmetic operators for BigInt. | |
file | increment_decrement.hpp [code] |
Increment and decrement operators for BigInt. | |
file | io_stream.hpp [code] |
I/O stream operators for BigInt. | |
file | relational.hpp [code] |
Defining the relational operators for BigInt. | |
file | unary_arithmetic.hpp [code] |
Defining the unary arithmetic operators for BigInt. | |
- |
- Big Integer library for C++
- |
-
-Files | |
file | conversion.hpp [code] |
Contains conversion related functions of BigInt. | |
file | math.hpp [code] |
Common math functions that work on BigInt. | |
file | random.hpp [code] |
Random BigInt generating functions. | |
file | utility.hpp [code] |
Contains some utility functions. | |
- |
- Big Integer library for C++
- |
-
-Directories |
-Files | |
file | BigInt.hpp [code] |
Contains class declaration for BigInt. | |
- |
- Big Integer library for C++
- |
-
-Files | |
file | constructors.hpp [code] |
contains constructors of BigInt | |
- |
- Big Integer library for C++
- |
-
▼ include | |
▼ constructors | |
constructors.hpp | Constructors of BigInt |
▼ functions | |
conversion.hpp | Contains conversion related functions of BigInt |
math.hpp | Common math functions that work on BigInt |
random.hpp | Random BigInt generating functions |
utility.hpp | Contains some utility functions |
▼ operators | |
arithmetic_assignment.hpp | Arithmetic-assignment operators |
assignment.hpp | Assignment operators of BigInt |
binary_arithmetic.hpp | Binary arithmetic operators for BigInt |
increment_decrement.hpp | Increment and decrement operators for BigInt |
io_stream.hpp | I/O stream operators for BigInt |
relational.hpp | Defining the relational operators for BigInt |
unary_arithmetic.hpp | Defining the unary arithmetic operators for BigInt |
BigInt.hpp | Contains class declaration for BigInt |
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
Increment and decrement operators for BigInt. -More...
-#include "BigInt.hpp"
#include "constructors/constructors.hpp"
#include "operators/assignment.hpp"
#include "operators/arithmetic_assignment.hpp"
#include "operators/binary_arithmetic.hpp"
Go to the source code of this file.
-Increment and decrement operators for BigInt.
-- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
- |
- Big Integer library for C++
- |
-
I/O stream operators for BigInt. -More...
-#include "BigInt.hpp"
#include "constructors/constructors.hpp"
#include "operators/assignment.hpp"
Go to the source code of this file.
--Functions | |
-std::istream & | operator>> (std::istream &in, BigInt &num) |
Get BigInt from the input stream. | |
-std::ostream & | operator<< (std::ostream &out, const BigInt &num) |
Put BigInt into the output stream. | |
I/O stream operators for BigInt.
-- |
- Big Integer library for C++
- |
-
t |