Addition function for two Big Integers represented as std::string

This function is from my attempt to write a Big Integer class in C++.

Below, I have a simple addition function. It takes two strings of arbitrary length which contains only digits (no '-' sign as well). It returns the sum of the two integers.

Could someone help me optimize for performance?

Since this is my first attempt writing C++ code, I would love for some feedback and improvements in code clarity and style as well. Furthermore, any improvements in security and memory are also appreciated. Please assume that the input will be properly sanitized and no leading zeros are present. I have not included the entire class as it can work as a standalone function.

std::string BigInt::add(const std::string &a, const std::string &b) const
{
//I think keeping the assignment and declaration of addend in
// multiple lines prevents copy constructors, right?
std::string result(a.size() > b.size() ? a:b);
addend = a.size() > b.size() ? b:a;

char carry = 0;
for(int cnt = (result.size() - 1); cnt >= 0; cnt--)
{
adder = result[cnt] - '0' + carry;
//cnt is non-negative so it is safe cast
if( (result.size() - addend.size()) <= static_cast<unsigned>(cnt))
{
}
}
//This propagates the final carry. O(n) insert, can maybe be optimized?
if(carry)
{
result.insert(result.begin(), carry + '0');
}
return result;
}


Memory management

There are no leaks, which is great!

However, there is an unnecessary copy being made:

//I think keeping the assignment and declaration of addend in
// multiple lines prevents copy constructors, right?
addend = a.size() > b.size() ? b:a;


Well, the comment is correct in that the copy constructor doesn't get called, but the copy assignment operator - and that one not only creates a copy of the right hand side operand, but also needs to clean up the original state.

A better way would be to use a reference instead:

const std::string &addend = a.size() > b.size() ? b : a;


Now, no copy is being made, but you can still easily access the smaller operand.

Performance

The simplest way to improve performance would be to chose better data structures/data representations.

The current implementation with std::string has one slight advantage (it is a string, i.e. directly human readable), and some disadvantages:

• It wastes a lot of memory (1 byte per decimal digit = 25.6x more memory usage than necessary).
• It operates in really small steps (1 byte at a time).
• There are some unnecessarily complicated repeated checks.
• Inserting a new leading digit (because of carryover) requires all digits to be moved in memory, plus a likely reallocation.

For better performance, these issues should be addressed.

NOTE: For the best performance, you need to have a look at how the target processor works and understand how you can apply that knowledge to your advantage. That will likely include having to use embedded assembly (e.g. for x86 platforms, having access to the CPU carry flag can be really helpful) and similar tricks.

But this question is targeting C++, so I'll try to give an example that can be portably done within C++ with not too much overhead.

So, we need to address the issues mentioned above. Let's go through them one at a time:

• Inserting a new leading digit (because of carryover) requires all digits to be moved in memory, plus a likely reallocation.

This can be amended by storing the digits in reverse order (new digit gets inserted at the back instead of the front) and by switching to a std::vector for storage (with maybe some extra capacity to prevent the reallocation).

std::vector<char> BigInt::add(const std::vector<char> &a, const std::vector<char> &b) const
{
// Some helper variables
auto min_size = std::min(a.size(), b.size());
auto max_size = std::max(a.size(), b.size());

std::vector<char> result(a.size() > b.size() ? a:b);
const std::vector<char> &addend = a.size() > b.size() ? b : a;

char carry = 0;

for(int cnt = 0; cnt < max_size; ++cnt)
{
adder = result[cnt] - '0' + carry;

if(cnt < min_size)
{
}

}

if(carry)
{
result.push_back(carry + '0');
}

return result;
}


Already looks a lot cleaner, doesn't it?

• There are some unnecessarily complicated repeated checks.

Some of the complicated length calculations already got taken care of, but there is one part that is needlessly repeated:

        if(cnt < min_size)
{
}


Why needlessly? Well, actually we know that this condition will be true for the first min_size iterations of the for loop, and false afterwards. With that knowledge, we can move that check one level higher, and replace the for loop with:

    for(int cnt = 0; cnt < min_size; ++cnt)
{
}

for(int cnt = min_size; carry && cnt < max_size; ++cnt)
{
adder = result[cnt] - '0' + carry;
}


Of course, now the loop bodies are nearly identical, but that can easily be fixed with some refactoring. Full code:

std::vector<char> BigInt::add(const std::vector<char> &a, const std::vector<char> &b) const
{
// Some helper variables
auto min_size = std::min(a.size(), b.size());
auto max_size = std::max(a.size(), b.size());

std::vector<char> result(a.size() > b.size() ? a:b);
const std::vector<char> &addend = a.size() > b.size() ? b : a;

char carry = 0;

auto add_digits = [&](char lhs, char rhs)
{
auto adder = lhs + rhs + carry;
};

for(int cnt = 0; cnt < min_size; ++cnt)
{
}

for(int cnt = min_size; carry && cnt < max_size; ++cnt)
{
result[cnt] = add_digits(result[cnt] - '0', 0) + '0';
}

if(carry)
{
result.push_back(carry + '0');
}

return result;
}

• It wastes a lot of memory (1 byte per decimal digit = 25.6x more memory usage than necessary).

It operates in really small steps (1 byte at a time).

Fixing this requires an increase in the digit "size": Before, we were using base-10 digits stored in chars. This can easily be improved to base-256 digits stored in chars (assuming 8 bit char, could be larger!).

But that's basically just calculating on the chars themselves. Most processors can work directly with bigger numbers, like ints (which are usually the largest integer type the target CPU can handle natively). So, why not use ints as "digits"?

Sadly, ints aren't exactly portable themselves; signed integers can be handled very differently on different processors (e.g. one's complement or two's complement). But: Unsigned intergers are thoroughly specified by the C++ standard, so we can use those.

Also, we can instruct the result vector to preallocate space in case we need space for a new leading digit.

This can easily be added upon the code above for this:

bool check_overflow(unsigned int lhs, unsigned int rhs)
{
return lhs > std::numeric_limits<unsigned int>::max() - rhs;
}

std::vector<unsigned int> BigInt::add(const std::vector<unsigned int>& a, const std::vector<unsigned int>& b) const
{
auto min_size = std::min(a.size(), b.size());
auto max_size = std::max(a.size(), b.size());

auto result = std::vector<unsigned int>();
result.reserve(max_size + 1);

const auto& larger = (a.size() > b.size() ? a : b);
const auto& smaller = (a.size() > b.size() ? b : a);

auto carry = 0u;

auto add_digit = [&](unsigned int lhs, unsigned int rhs)
{
auto sum = lhs + rhs + carry;
carry = (check_overflow(lhs, rhs) || (sum == 0 && carry)) ? 1 : 0;
return sum;
};

for(auto i = 0; i < min_size; ++i)
{
}

for(auto i = min_size; i < max_size; ++i)
{
}

if(carry) result.push_back(carry);

return result;
}


Of course, this isn't perfect performance yet, much can be improved by using knowledge about the target architecture, e.g. by using SSE instructions or similar. Still, this should be quite a lot faster than the original approach, and should be fully portable between different platforms.

• Instead of min(), max() and assignments, I would have used something like std::tie(smaller , larger) = std::minmax(a, b, [](const auto& lhs, const auto& rhs) {return lhs.size() < rhs.size();}); – Calak Dec 4 '18 at 8:32
• @Calak: std::tie cannot be used to initialize references, so your suggestion would need to copy the inputs. – hoffmale Dec 4 '18 at 11:20
• However, IIUC it should work with structured bindings: const auto& [smaller, larger] = std::minmax(a, b, [](const auto& lhs, const auto& rhs) { return lhs.size() < rhs.size(); });. That said, this requires C++17, and I've tried to keep my answer C++11 compatible (since OP didn't specify an exact version). – hoffmale Dec 4 '18 at 11:32