From: mike3 on
Hi.
(Xposted to both comp.lang.c++ and comp.programming since I've got
questions related to both C++ language and general programming)

I've got the following C++ code. The first routine runs in like 65% of
the time of the second routine. Yet both do the same thing. However,
the second one seems better in terms of the way the code is written
since it helps encapsulate the transformation in the inner loop better
making it easier to read, at least in my opinion. Maybe it's not,
maybe the former is "better" that way and I should go with it, but if
the latter is "better" in that respect should I just ditch it anyway
and tradeoff for performance since I want this thing to be fast???

What each routine does is multiply two arbitrary-precision integers
together. The second one though uses an additional "slice" type that
provides a window enabling the "multiply and add" operation to be
performed on a limited range of digits, which can then be advanced
across the number, making clear that part of the algorithn.

I'm using the simple "grade school" multiply algorithm. Note how the
second routine more easily outlines this algorithm, while in the first
it is a little more difficult to see. Which would you prefer, exactly?

For brevity, class definitions and other members have been omitted.
However it should not be too difficult to figure out the necessary
information.

Also, could I lose the typecasts in this code or do I need them?

The reason why I'm asking is because I remembered getting told earlier
by someone here (Alf P. Steinbach, group: comp.lang.c++) about how my
last implementation of my program (this is for a fractal generator)
had some sort of bad, bug-inducing "abstraction gap" yet I was unable
to get enough elaboration responses about it so I've been more or less
shooting around trying to figure out how to make it better (although
he did give me some *examples* of where there were problems, which I
have since fixed.). But it seems I'm losing performance and that's not
a good thing for my application. Not to mention also that my original
bignum implementation was called "silly" as well("...although I didn't
look at the silly bignum class, whatever it's fault is..." ref:
http://groups.google.com/group/comp.lang.c++/msg/ac8df038d0b8dab9?dmode=source)
without any explanation as to what exactly was so silly about it. So I
had to start dark-shooting there too trying to figure out what I had
done wrong.

First version (fastest):
---
void RawDigit::Mul(const RawDigit &a, const RawDigit &b)
{
/* Check to see if we're doing an in-place multiply */
if(&a == this)
{
MulInPlace(b);
return;
} else if(&b == this) {
MulInPlace(a);
return;
}

/* Get lengths. */
std::size_t rLength(GetLength());
std::size_t aLength(a.GetLength());
std::size_t bLength(b.GetLength());

/* Zeroize this. */
Zeroize();

/* Do the multiplication. */
TwoDigit64 carry(0);
for(std::size_t i(0);i<aLength && i<rLength;i++)
{
carry = 0;

for(std::size_t j(0);j<bLength && (i+j)<rLength;j++)
{
TwoDigit64
tmp((static_cast<TwoDigit64>(a.digits[i])*b.digits[j]) +
digits[i+j] + carry);
carry = tmp >> DIGIT_BITS;
tmp -= carry << DIGIT_BITS;
digits[i+j] = tmp;
}

if(i+bLength < rLength)
digits[i+bLength] = carry;
}
}
---

Second version (slower):
---
*** Slice manipulation.
inline Digit32 MulAddOp(Digit32 a, Digit32 b, Digit32 c, Digit32
&carry)
{
TwoDigit64 sum(a + (static_cast<TwoDigit64>(b)*c) + carry);
carry = sum >> DIGIT_BITS;
return(sum & MAX_DIGIT);
}

inline Digit32 MulAddCarryPropOpL(Digit32 a, Digit32 &carry)
{
Digit32 sum(a + carry);
carry = sum < carry;
return(sum);
}

inline Digit32 MulAddCarryPropOpR(Digit32 b, Digit32 c, Digit32
&carry)
{
TwoDigit64 sum((static_cast<TwoDigit64>(b)*c) + carry);
carry = sum >> DIGIT_BITS;
return(sum & MAX_DIGIT);
}

Digit32 RawDigitSlice::MulAdd(const ConstRawDigitSlice &a,
const Digit32 b,
const ConstRawDigitSlice &c)
{
/* Set up iterators */
DigitIterator32 ri(GetStartIterator());
ConstDigitIterator32 ai(a.GetConstStartIterator());
ConstDigitIterator32 ci(c.GetConstStartIterator());

/* Get minimum length of a and c. */
std::size_t minLength(std::min(std::min(a.length, c.length),
length));

/* Do the combined multiply + add */
Digit32 carry(0);
std::size_t i(0);
for(i;i<minLength;++i,++ri,++ai,++ci)
*ri = MulAddOp(*ai, b, *ci, carry);

/* Handle the remaining part(s) of a or b. */
int largerLength(std::min(std::max(a.length, c.length), length));
if(a.length >= c.length)
{
for(i;i<largerLength;++i,++ri,++ai)
*ri = MulAddCarryPropOpL(*ai, carry);
} else {
for(i;i<largerLength;++i,++ri,++ci)
*ri = MulAddCarryPropOpR(b, *ci, carry);
}

/* Finish carry propagation */
if(largerLength < length)
{
for(i;i<length;++i,++ri)
*ri = MulAddCarryPropOpL(0, carry);
}

/* Done! */
return(carry);
}

*** This next routine is in a different source file, the one
implementing the full "RawDigit" class.
*** The former would be in another file that implements the
"RawDigitSlice" class.
void RawDigit::Mul(const RawDigit &a, const RawDigit &b)
{
/* Check to see if we're doing an in-place multiply */
if(&a == this)
{
MulInPlace(b);
return;
} else if(&b == this) {
MulInPlace(a);
return;
}

/* Get lengths. */
std::size_t rLength(GetLength());
std::size_t aLength(a.GetLength());
std::size_t bLength(b.GetLength());

/* Zeroize this. */
Zeroize();

/* Set up slices. */
RawDigitSlice runningSum(*this, 0, aLength + 1); /* explanation:
(<RawDigit object>, <origin digit idx>, <nbr of digits in slice>) */
ConstRawDigitSlice as(a);

/* Do the multiplication. */
for(std::size_t i(0);i<bLength && i<rLength;++i,++runningSum)
acc.MulAdd(runningSum, b[i], as);
}
---

From: Ivan Vecerina on
"mike3" <mike4ty4(a)yahoo.com> wrote in message
news:0ab3cfe6-5a32-4986-a203-f7a2f29026fb(a)q24g2000prf.googlegroups.com...
: Hi.
: (Xposted to both comp.lang.c++ and comp.programming since I've got
: questions related to both C++ language and general programming)
:
: I've got the following C++ code. The first routine runs in like 65% of
: the time of the second routine. Yet both do the same thing. However,
: the second one seems better in terms of the way the code is written
: since it helps encapsulate the transformation in the inner loop better
: making it easier to read, at least in my opinion. Maybe it's not,
: maybe the former is "better" that way and I should go with it, but if
: the latter is "better" in that respect should I just ditch it anyway
: and tradeoff for performance since I want this thing to be fast???
As a first-time reader of both implementations, I find the first one
much easier to understand and maintain than the second one. Adding
levels of abstractions without a clear benefit only obfuscates code.

: I'm using the simple "grade school" multiply algorithm. Note how the
: second routine more easily outlines this algorithm, while in the first
: it is a little more difficult to see. Which would you prefer, exactly?
The first one.

: Also, could I lose the typecasts in this code or do I need them?
I'll comment & review the first function below.
At some point, you do need to (at least implicitly) cast
an operand to the larger type, as this might not happen
automatically for some combinations of types, in C++.

: First version (fastest):
: ---
: void RawDigit::Mul(const RawDigit &a, const RawDigit &b)
: {
: /* Check to see if we're doing an in-place multiply */
: if(&a == this)
: {
: MulInPlace(b);
: return;
: } else if(&b == this) {
: MulInPlace(a);
: return;
: }
General class design: unless there is an established reason
not to do so, I would use operator overloading and implement
(as members of the Num class):
static Num operator *( const Num& a, const Num& b );
Num& operator *( const Num& a );
Maybe RawDigit::Mul is an internal private member, and the
above operations are provided? But then the special cases
(e.g. multiply in place) would best be handled in the
layers above...

: /* Get lengths. */
: std::size_t rLength(GetLength());
: std::size_t aLength(a.GetLength());
: std::size_t bLength(b.GetLength());
:
: /* Zeroize this. */
: Zeroize();

Is the intent truly to implement modulo math, and to allow
the result to be truncated? If not the result should be
resized automatically, and the code is simplified.

: /* Do the multiplication. */
: TwoDigit64 carry(0);
Technically, the carry should only require 1 digit,
and can be defined within the outer loop below.

: for(std::size_t i(0);i<aLength && i<rLength;i++)
: {
: carry = 0;
:
: for(std::size_t j(0);j<bLength && (i+j)<rLength;j++)
: {
: TwoDigit64
: tmp((static_cast<TwoDigit64>(a.digits[i])*b.digits[j]) +
: digits[i+j] + carry);
: carry = tmp >> DIGIT_BITS;
: tmp -= carry << DIGIT_BITS;
: digits[i+j] = tmp;
: }
:
: if(i+bLength < rLength)
: digits[i+bLength] = carry;
: }
: }

Let's say that you have the following digit-related
definitions within your class:
typedef ... Digit;
typedef ... TwoDigit;
const unsigned digitBitCount = ...;
const Digit digitBitMask = 0xF...UL;

Assuming no truncation (because of adequate pre-allocation
of result digits), the same algorithm can be written as:

for( unsigned aPos = 0 ; aPos<aLength ; ++aPos )
{
Digit carry = 0;
TwoDigit const aDig = a.digits[aPos]; //NB: cast "hidden" here
for( unsigned bPos = 0 ; bPos<bLength ; ++bPos )
{
TwoDigit mul = aDig * b.digits[bPos]
+ this->digits[aPos+bPos]
+ carry;

this->digits[aPos+bPos] = mul & digitBitMask;
carry = ( mul >> digitBitCount );
}
this->digits[aPos+bPos] = carry;
}

There are many correct ways to write this, and some are
probably better is some ways than this example. But I
hope that you will find it useful.
In any case, given the very acceptable complexity of this loop,
I would not bother breaking it up or adding layers of
encapsulation.

Regards -Ivan
--
http://ivan.vecerina.com/contact/?subject=NG_POST <- email contact form
Brainbench MVP for C++ <> http://www.brainbench.com

From: thomas.mertes on
On 20 Apr., 08:26, mike3 <mike4...(a)yahoo.com> wrote:
> Hi.
> (Xposted to both comp.lang.c++ and comp.programming since I've got
> questions related to both C++ language and general programming)
>
> I've got the following C++ code. The first routine runs in like 65% of
> the time of the second routine. Yet both do the same thing. However,
> the second one seems better in terms of the way the code is written
> since it helps encapsulate the transformation in the inner loop better
> making it easier to read, at least in my opinion. Maybe it's not,
> maybe the former is "better" that way and I should go with it, but if
> the latter is "better" in that respect should I just ditch it anyway
> and tradeoff for performance since I want this thing to be fast???
>
> What each routine does is multiply two arbitrary-precision integers
> together. The second one though uses an additional "slice" type that
> provides a window enabling the "multiply and add" operation to be
> performed on a limited range of digits, which can then be advanced
> across the number, making clear that part of the algorithn.
>
> I'm using the simple "grade school" multiply algorithm. Note how the
> second routine more easily outlines this algorithm, while in the first
> it is a little more difficult to see. Which would you prefer, exactly?
>
> For brevity, class definitions and other members have been omitted.
> However it should not be too difficult to figure out the necessary
> information.
>
> Also, could I lose the typecasts in this code or do I need them?
>
> The reason why I'm asking is because I remembered getting told earlier
> by someone here (Alf P. Steinbach, group: comp.lang.c++) about how my
> last implementation of my program (this is for a fractal generator)
> had some sort of bad, bug-inducing "abstraction gap" yet I was unable
> to get enough elaboration responses about it so I've been more or less
> shooting around trying to figure out how to make it better (although
> he did give me some *examples* of where there were problems, which I
> have since fixed.). But it seems I'm losing performance and that's not
> a good thing for my application. Not to mention also that my original
> bignum implementation was called "silly" as well("...although I didn't
> look at the silly bignum class, whatever it's fault is..." ref:http://groups.google.com/group/comp.lang.c++/msg/ac8df038d0b8dab9?dmo...)
> without any explanation as to what exactly was so silly about it. So I
> had to start dark-shooting there too trying to figure out what I had
> done wrong.
>
> First version (fastest):
> ---
> void RawDigit::Mul(const RawDigit &a, const RawDigit &b)
> {
> /* Check to see if we're doing an in-place multiply */
> if(&a == this)
> {
> MulInPlace(b);
> return;
> } else if(&b == this) {
> MulInPlace(a);
> return;
> }
>
> /* Get lengths. */
> std::size_t rLength(GetLength());
> std::size_t aLength(a.GetLength());
> std::size_t bLength(b.GetLength());
>
> /* Zeroize this. */
> Zeroize();
>
> /* Do the multiplication. */
> TwoDigit64 carry(0);
> for(std::size_t i(0);i<aLength && i<rLength;i++)
> {
> carry = 0;
>
> for(std::size_t j(0);j<bLength && (i+j)<rLength;j++)
> {
> TwoDigit64
> tmp((static_cast<TwoDigit64>(a.digits[i])*b.digits[j]) +
> digits[i+j] + carry);
> carry = tmp >> DIGIT_BITS;
> tmp -= carry << DIGIT_BITS;
> digits[i+j] = tmp;
> }
>
> if(i+bLength < rLength)
> digits[i+bLength] = carry;
> }}
>
[snip Second version (slower)]

I consider the first version easier to read. I prefer to see the
main algorithm at one page instead of "millions of small
methods". What I am missing is:
- The signs. All your values seem to be unsigned.
Do you want to use two's complement representation or
sign + magnitude.
- The management of the size. The user of the functions
should not be bothered with resizing the big integers.

Did you know that big integer libraries already exist. Some
people have taken the burden to write a library for big integer
functions. For example: Me.
If you download Seed7
(http://sourceforge.net/project/showfiles.php?group_id=151126)
you will see that the file seed7/src/big_rtl.c contains a bigInteger
library written in C. This library manages the memory for the
digits automatically and contains the usual arithmetic operations
(inclusive two forms of bigInteger division and remainder which
trunc towards zero or minus infinite). The multiplication uses
the Karatsuba algorithm when possible.
BTW.: I plan to do an improved release today (By coincidence I
did several improvements for bigInteger's). If you wait for approx.
12 hours you can get the new version.

Greetings Thomas Mertes

Seed7 Homepage: http://seed7.sourceforge.net
Seed7 - The extensible programming language: User defined statements
and operators, abstract data types, templates without special
syntax, OO with interfaces and multiple dispatch, statically typed,
interpreted or compiled, portable, runs under linux/unix/windows.
From: mike3 on
On Apr 20, 1:43 am, "Ivan Vecerina"
<_INVALID_use_webfo...(a)ivan.vecerina.com> wrote:
> "mike3" <mike4...(a)yahoo.com> wrote in message
>
> news:0ab3cfe6-5a32-4986-a203-f7a2f29026fb(a)q24g2000prf.googlegroups.com...
> : Hi.
> : (Xposted to both comp.lang.c++ and comp.programming since I've got
> : questions related to both C++ language and general programming)
> :
> : I've got the following C++ code. The first routine runs in like 65% of
> : the time of the second routine. Yet both do the same thing. However,
> : the second one seems better in terms of the way the code is written
> : since it helps encapsulate the transformation in the inner loop better
> : making it easier to read, at least in my opinion. Maybe it's not,
> : maybe the former is "better" that way and I should go with it, but if
> : the latter is "better" in that respect should I just ditch it anyway
> : and tradeoff for performance since I want this thing to be fast???
> As a first-time reader of both implementations, I find the first one
> much easier to understand and maintain than the second one.  Adding
> levels of abstractions without a clear benefit only obfuscates code.
>

OK, then I'll go for the first. Especially considering it's faster...

> : I'm using the simple "grade school" multiply algorithm. Note how the
> : second routine more easily outlines this algorithm, while in the first
> : it is a little more difficult to see. Which would you prefer, exactly?
> The first one.
>

Hmm.

> : Also, could I lose the typecasts in this code or do I need them?
> I'll comment & review the first function below.
> At some point, you do need to (at least implicitly) cast
> an operand to the larger type, as this might not happen
> automatically for some combinations of types, in C++.
>

So then in this case a cast is OK, right?

> : First version (fastest):
> : ---
> : void RawDigit::Mul(const RawDigit &a, const RawDigit &b)
> : {
> :    /* Check to see if we're doing an in-place multiply */
> :    if(&a == this)
> :    {
> :      MulInPlace(b);
> :      return;
> :    } else if(&b == this) {
> :      MulInPlace(a);
> :      return;
> :    }
> General class design: unless there is an established reason
> not to do so, I would use operator overloading and implement
> (as members of the Num class):
>   static  Num   operator *( const Num& a, const Num& b );
>           Num&  operator *( const Num& a );
> Maybe RawDigit::Mul is an internal private member, and the
> above operations are provided?  But then the special cases
> (e.g. multiply in place) would best be handled in the
> layers above...
>

I've tried overlaoded operators but one seems to have to construct
a temporary copy to hold results to return in the case of the binary
operators. This is a big problem for my app. as I have performance
concerns. Deallocating and reallocating memory billions of times
is a serious waste of performance. (These routines will be called
billions of times.)

Therefore I do the opposite and build these low-level routines first,
then build the overloaded operators using them, which can then be
used in all non-performance-critical areas of the program. If it turns
out that I don't need the MulInPlace() functionality to be integrated
with Mul(), I'll just remove it and document that Mul() does not
work in-place. Is that acceptable practice?

> :    /* Get lengths. */
> :    std::size_t rLength(GetLength());
> :    std::size_t aLength(a.GetLength());
> :    std::size_t bLength(b.GetLength());
> :
> :    /* Zeroize this. */
> :    Zeroize();
>
> Is the intent truly to implement modulo math, and to allow
> the result to be truncated? If not the result should be
> resized automatically, and the code is simplified.
>

So I can omit this functionality and just document that the
routine doesn't behave as most would expect? (If I have operands
of 3 differing lengths I'd usually expect a Mul() to respect
those lengths but then again your opinion may differ.)

Also the above just does nothing but clear the result buffer,
which you need as we're going to add (as in arithmetical addition)
numbers to it. You need that for the multiply algorithm to work.

And you need to get the lengths of the input operands because
you're going to loop over the digits, no? And you don't want to
read outside the buffer or read too few digits? I think you would,
but then again maybe I'm wrong...

> :    /* Do the multiplication. */
> :    TwoDigit64 carry(0);
> Technically, the carry should only require 1 digit,
> and can be defined within the outer loop below.
>

But I thought then that would create a performance-wasting conversion
to/from 32/64 again and again.

> :    for(std::size_t i(0);i<aLength && i<rLength;i++)
> :    {
> :       carry = 0;
> :
> :       for(std::size_t j(0);j<bLength && (i+j)<rLength;j++)
> :       {
> :          TwoDigit64
> : tmp((static_cast<TwoDigit64>(a.digits[i])*b.digits[j]) +
> :                         digits[i+j] + carry);
> :          carry = tmp >> DIGIT_BITS;
> :          tmp -= carry << DIGIT_BITS;
> :          digits[i+j] = tmp;
> :       }
> :
> :       if(i+bLength < rLength)
> :         digits[i+bLength] = carry;
> :    }
> : }
>
> Let's say that you have the following digit-related
> definitions within your class:
>   typedef ...  Digit;
>   typedef ...  TwoDigit;
>   const unsigned digitBitCount = ...;
>   const Digit digitBitMask = 0xF...UL;
>
> Assuming no truncation (because of adequate pre-allocation
> of result digits), the same algorithm can be written as:
>
>  for( unsigned aPos = 0 ; aPos<aLength ; ++aPos )
>  {
>     Digit carry = 0;
>     TwoDigit const aDig = a.digits[aPos]; //NB: cast "hidden" here
>     for( unsigned bPos = 0 ; bPos<bLength ; ++bPos )
>     {
>         TwoDigit mul = aDig * b.digits[bPos]
>                      + this->digits[aPos+bPos]
>                      + carry;
>
>         this->digits[aPos+bPos] =   mul &  digitBitMask;
>         carry                   = ( mul >> digitBitCount );
>     }
>     this->digits[aPos+bPos] = carry;
>  }
>
> There are many correct ways to write this, and some are
> probably better is some ways than this example.  But I
> hope that you will find it useful.
> In any case, given the very acceptable complexity of this loop,
> I would not bother breaking it up or adding layers of
> encapsulation.
>

OK, then.
From: mike3 on
On Apr 20, 2:22 am, thomas.mer...(a)gmx.at wrote:
> On 20 Apr., 08:26, mike3 <mike4...(a)yahoo.com> wrote:
<snip>
> > First version (fastest):
> > ---
> > void RawDigit::Mul(const RawDigit &a, const RawDigit &b)
> > {
> >     /* Check to see if we're doing an in-place multiply */
> >     if(&a == this)
> >     {
> >       MulInPlace(b);
> >       return;
> >     } else if(&b == this) {
> >       MulInPlace(a);
> >       return;
> >     }
>
> >     /* Get lengths. */
> >     std::size_t rLength(GetLength());
> >     std::size_t aLength(a.GetLength());
> >     std::size_t bLength(b.GetLength());
>
> >     /* Zeroize this. */
> >     Zeroize();
>
> >     /* Do the multiplication. */
> >     TwoDigit64 carry(0);
> >     for(std::size_t i(0);i<aLength && i<rLength;i++)
> >     {
> >        carry = 0;
>
> >        for(std::size_t j(0);j<bLength && (i+j)<rLength;j++)
> >        {
> >           TwoDigit64
> > tmp((static_cast<TwoDigit64>(a.digits[i])*b.digits[j]) +
> >                          digits[i+j] + carry);
> >           carry = tmp >> DIGIT_BITS;
> >           tmp -= carry << DIGIT_BITS;
> >           digits[i+j] = tmp;
> >        }
>
> >        if(i+bLength < rLength)
> >          digits[i+bLength] = carry;
> >     }}
>
> [snip Second version (slower)]
>
> I consider the first version easier to read. I prefer to see the
> main algorithm at one page instead of "millions of small
> methods". What I am missing is:
> - The signs. All your values seem to be unsigned.
>   Do you want to use two's complement representation or
>   sign + magnitude.

Digits are usually not signed, this is not a balanced-radix
representation. This is simple radix-2^32 arithmetic.

This is also a raw unsigned number type that just allows
basic digit manipulations. I'm going to use it to build a
floating point type on top.

> - The management of the size. The user of the functions
>   should not be bothered with resizing the big integers.
>

See above. This is a raw base type. In the full application
I do not need automatic resizes (since with floating point one
usually truncates or rounds the result from multiplication
anyway), plus they would hinder the performance and I need
lots of that latter stuff.

> Did you know that big integer libraries already exist. Some
> people have taken the burden to write a library for big integer
> functions. For example: Me.

Actually, I've looked at other packages when trying to figure out
how to come up with mine.

The reason for producing my own package was primarily due to
licensing issues, since I do not know how I'm going to license
the software when I decide to release it for distribution. If that
was not a concern I would have just used someone else's package.
I could always switch to the use of a different package in the
future.

Plus it's fun to program it and I can learn more about programming
this way.

> If you download Seed7
> (http://sourceforge.net/project/showfiles.php?group_id=151126)
> you will see that the file seed7/src/big_rtl.c contains a bigInteger
> library written in C. This library manages the memory for the
> digits automatically and contains the usual arithmetic operations
> (inclusive two forms of bigInteger division and remainder which
> trunc towards zero or minus infinite). The multiplication uses
> the Karatsuba algorithm when possible.

I'm curious: Is that Karatsuba D&C (divide & conquer) method
faster even on smaller number sizes like 512 bits or so? Because
if so I'm thinking of implementing that in my program as well.

Also, I'm writing this with C++, not C, which means that looking
at a C package may be less than helpful.

> BTW.: I plan to do an improved release today (By coincidence I
> did several improvements for bigInteger's). If you wait for approx.
> 12 hours you can get the new version.
>