12,952,792 members (34,470 online)
alternative version

#### Stats

167.4K views
23 bookmarked
Posted 16 Feb 2003

# A Decimal Class Implementation

, 16 Feb 2003
 Rate this:
Use this class when high precision is required in basic numerical operations.

## Introduction

In my last article[^], I eluded to the fact that there was another bug hiding in my code. Well, here it is! I guess it isn't precisely a bug, except under certain conditions, such as working with currency, in which precision is required.

## Math Precision

One of the problems in the financial world is dealing with numeric precision. The `double` data type doesn't quite cut it, as we shall see. This presents a problem in C++ which has no `decimal` data type as found in C#. For example, the following C# code results in a "true" evaluation of `n==201`:

```decimal n=.3M;
n-=.099M;
n*=1000M;
if (n==201) ...   // TRUE!```

whereas using the `double` type in C++ does not:

```double n=.3;
n-=.099;
n*=1000;
if (n==201) ...   // FALSE!```

This is an important issue when dealing with financial math.

## The Decimal Class

To solve this problem, I created a `Decimal` class. Now, I looked high and low on Code Project and Google searches for something like this, and I didn't find anything, so if I missed a contribution by another person regarding this issue, then I apologize in advance.

<PRE lang=mc++>class Decimal { public: static void Initialize(int precision); Decimal(void); Decimal(AutoString num); Decimal(const Decimal& d); Decimal(const __int64 n); Decimal(int intPart, int fractPart); virtual ~Decimal(void); Decimal operator+(const Decimal&); Decimal operator-(const Decimal&); Decimal operator*(const Decimal&); Decimal operator/(const Decimal&); Decimal operator +=(const Decimal&); Decimal operator -=(const Decimal&); Decimal operator *=(const Decimal&); Decimal operator /=(const Decimal&); bool operator==(const Decimal&) const; bool operator!=(const Decimal&) const; bool operator<(const Decimal&) const; bool operator<=(const Decimal&) const; bool operator>(const Decimal&) const; bool operator>=(const Decimal&) const; CString ToString(void) const; double ToDouble(void) const; protected: __int64 n; static int precision; static __int64 q; static char* pad; };

This is a pretty basic implementation. A static `Initialize` method is used to set up the desired precision of the class, for all instances of `Decimal`. Internally, a few helper variables are initialized, which are used elsewhere for `string` to `Decimal` conversions and the multiplication and division operators:

<PRE lang=mc++>void Decimal::Initialize(int prec) { precision=prec; // create an array of 0's for padding pad=new char[precision+1]; memset(pad, '0', precision); pad[precision]='\0'; // get fractional precision q=(__int64)pow(10.0, (double)prec); }

A Microsoft specific 64 bit integer is used to maintain both integer and fractional components of the value, using the <CODE lang=mc++>__int64 data type. This is a non-ANSII standard type. If you want a 96 bit integer instead, you can modify my class with PJ Naughter's 96 bit integer class found here [^].

## String To __int64 Conversion

<PRE lang=mc++>Decimal::Decimal(AutoString num) { // get the integer component AutoString intPart=num.LeftEx('.'); // get the fractional component AutoString fractPart=num.RightEx('.'); // "multiply" the fractional part by the desired precision fractPart+=&pad[strlen(fractPart)]; // create the 64bit integer as a composite of the // integer and fractional components. n=atoi(intPart); n*=q; n+=atoi(fractPart); }

The conversion from a string to a 64 bit integer is interesting to look at as it reveals the internal workings of the class. First, the integer part and fractional parts are separated from the number. The `AutoString` class is a `CString` derived class and provides a bit nicer interface for these kind of things.

For example, given "123.456":

```AutoString intPart=num.LeftEx('.');
AutoString fractPart=num.RightEx('.');
```
```intPart="123"
fractPart="456"```

Now let's say you've initialized the class with a precision of 4 digits past the decimal point. This creates a pad string of "0000" in the initialization function, which is used to determine how many zeros to append to the fractional string. In code:

`fractPart` is appended with a single "0" and becomes "4560".

Finally, the two components, the integer and fractional components, are combined by shifting (base 10) the integer component left by the fractional precision and adding the fractional component:

<PRE lang=mc++> n=atoi(intPart); n*=q; n+=atoi(fractPart);

The result is a single integer which maintains both integer and fractional components. Because all `Decimal` "numbers" are normalized in this way, the four basic operations (+, -, *, /) are trivial to implement.

## __int64 To String Conversion

<PRE lang=mc++>CString Decimal::ToString(void) const { char s[64]; __int64 n2=n/q; int fract=(int)(n-n2*q); sprintf(s, "%d.%0*d", (int)n2, precision, fract); return s; }

Again, this code reveals the internal workings of the `Decimal` class. The 64 bit value is shifted right (base 10) by the precision and the integer component is extracted:

<PRE lang=mc++> __int64 n2=n/q;

The fractional component is extracted by shifting left the integer component and subtracting from the original value:

<PRE lang=mc++> int fract=(int)(n-n2*q);

And finally the string is constructed. Note the use of the <CODE lang=mc++>* directive which tells the <CODE lang=mc++>printf routine to determine the precision of the integer from the variable list:

<PRE lang=mc++> sprintf(s, "%d.%0*d", (int)n2, precision, fract);

## Usage

<PRE lang=mc++>Decimal::Initialize(4); double n=.3; n-=.099; n*=1000; printf("n=%.04lf (int)n=%d\r\n", n, (int)n); printf("n == 201 ? %s\r\n", n==201 ? "yes" : "no"); printf("n >= 201 ? %s\r\n", n>=201 ? "yes" : "no"); Decimal dec(".3"); dec-=Decimal(".099"); dec*=Decimal("1000"); printf("dec=%s\r\n", dec.ToString()); printf("dec == 201 ? %s\r\n", dec==Decimal("201") ? "yes" : "no"); printf("dec >= 201 ? %s\r\n", dec>=Decimal("201") ? "yes" : "no");

The above is an example usage and produces the following output:

Because the <CODE lang=mc++>__int64 type is composed from two <CODE lang=mc++>int types (and decomposed into <CODE lang=mc++>int types when converted back to a string), it is limited in range to the same values as a signed four byte number, +/- 2^31, or +/-2,147,483,648.

Also, this code is not "internationalized".

## References:

A list of licenses authors might use can be found here

## Share

 United States
Marc is the creator of two open source projects, MyXaml, a declarative (XML) instantiation engine and the Advanced Unit Testing framework, and Interacx, a commercial n-tier RAD application suite.  Visit his website, www.marcclifton.com, where you will find many of his articles and his blog.

Marc lives in Philmont, NY.

## You may also be interested in...

 Pro

 First PrevNext
 How to deal with multiplication/division? DimoneSem10-Aug-15 2:30 DimoneSem 10-Aug-15 2:30
 and what about the Automation DECIMAL struct abo hashem12-Sep-13 1:06 abo hashem 12-Sep-13 1:06
 Re: and what about the Automation DECIMAL struct Marc Clifton12-Sep-13 1:17 Marc Clifton 12-Sep-13 1:17
 Re: and what about the Automation DECIMAL struct brekehan12-Nov-14 12:56 brekehan 12-Nov-14 12:56
 Re: and what about the Automation DECIMAL struct Marc Clifton12-Nov-14 13:11 Marc Clifton 12-Nov-14 13:11
 My vote of 1 Byron Goodman4-Jul-12 12:34 Byron Goodman 4-Jul-12 12:34
 Another implementation for C++ Member 9427193-Jan-11 13:31 Member 942719 3-Jan-11 13:31
 This code needs a health warning cslocombe27-Jul-08 20:29 cslocombe 27-Jul-08 20:29
 Re: This code needs a health warning Marc Clifton28-Jul-08 0:43 Marc Clifton 28-Jul-08 0:43
 Re: This code needs a health warning brekehan12-Nov-14 12:58 brekehan 12-Nov-14 12:58
 Boost.Rational Gast1284-Feb-08 4:02 Gast128 4-Feb-08 4:02
 compare floats jswoofer13-Oct-06 3:18 jswoofer 13-Oct-06 3:18
 Why do we need decimal? Andrew Phillips8-Dec-04 15:14 Andrew Phillips 8-Dec-04 15:14
 Re: Why do we need decimal? Marc Clifton8-Dec-04 15:56 Marc Clifton 8-Dec-04 15:56
 Andrew Phillips wrote: but the decimal type is totally pointless. Erm, ok. What if you have a number like "12.34" in a database record, and using float or double doesn't express it precisely. Isn't that a good reason to use the decimal type, rather than writing SQL statements where you multiply numbers by 10^n value? Just an off-the-cuff thought. Marc MyXaml Advanced Unit Testing
 Re: Why do we need decimal? Andrew Phillips13-Dec-04 15:11 Andrew Phillips 13-Dec-04 15:11
 Improvement Suggestion Jörgen Sigvardsson5-Dec-03 8:26 Jörgen Sigvardsson 5-Dec-03 8:26
 C# ? Richard Deeming17-Feb-03 23:02 Richard Deeming 17-Feb-03 23:02
 Re: C# ? Marc Clifton18-Feb-03 1:48 Marc Clifton 18-Feb-03 1:48
 Precision Taka Muraoka17-Feb-03 12:18 Taka Muraoka 17-Feb-03 12:18
 Re: Precision Marc Clifton17-Feb-03 13:24 Marc Clifton 17-Feb-03 13:24
 Interesting Jörgen Sigvardsson17-Feb-03 11:59 Jörgen Sigvardsson 17-Feb-03 11:59
 Re: Interesting Peter Hancock17-Feb-03 12:28 Peter Hancock 17-Feb-03 12:28
 Re: Interesting Jörgen Sigvardsson17-Feb-03 13:04 Jörgen Sigvardsson 17-Feb-03 13:04
 Re: Interesting Marc Clifton17-Feb-03 13:29 Marc Clifton 17-Feb-03 13:29
 Re: Interesting Jörgen Sigvardsson17-Feb-03 13:41 Jörgen Sigvardsson 17-Feb-03 13:41
 Last Visit: 31-Dec-99 18:00     Last Update: 27-May-17 3:35 Refresh 12 Next »