SourceBrowser

decNumber.h /size: 11 Kb last modification: 2025-02-21 11:03
1/* ------------------------------------------------------------------ */
2/* Decimal Number arithmetic module header                            */
3/* ------------------------------------------------------------------ */
4/* Copyright (c) IBM Corporation, 2000, 2010.  All rights reserved.   */
5/*                                                                    */
6/* This software is made available under the terms of the             */
7/* ICU License -- ICU 1.8.1 and later.                                */
8/*                                                                    */
9/* The description and User's Guide ("The decNumber C Library") for   */
10/* this software is called decNumber.pdf.  This document is           */
11/* available, together with arithmetic and format specifications,     */
12/* testcases, and Web links, on the General Decimal Arithmetic page.  */
13/*                                                                    */
14/* Please send comments, suggestions, and corrections to the author:  */
15/*   mfc@uk.ibm.com                                                   */
16/*   Mike Cowlishaw, IBM Fellow                                       */
17/*   IBM UK, PO Box 31, Birmingham Road, Warwick CV34 5JL, UK         */
18/* ------------------------------------------------------------------ */
19
20#if !defined(DECNUMBER)
21  #define DECNUMBER
22  #define DECNAME     "decNumber"                       /* Short name */
23  #define DECFULLNAME "Decimal Number Module"         /* Verbose name */
24  #define DECAUTHOR   "Mike Cowlishaw"                /* Who to blame */
25
26  #if !defined(DECCONTEXT)
27    #include "decContext.h"
28  #endif
29
30  /* Bit settings for decNumber.bits                                  */
31  #define DECNEG    0x80      /* Sign; 1=negative, 0=positive or zero */
32  #define DECINF    0x40      /* 1=Infinity                           */
33  #define DECNAN    0x20      /* 1=NaN                                */
34  #define DECSNAN   0x10      /* 1=sNaN                               */
35  /* The remaining bits are reserved; they must be 0                  */
36  #define DECSPECIAL (DECINF|DECNAN|DECSNAN) /* any special value     */
37
38  /* Define the decNumber data structure.  The size and shape of the  */
39  /* units array in the structure is determined by the following      */
40  /* constant.  This must not be changed without recompiling the      */
41  /* decNumber library modules. */
42
43  #define DECDPUN 3           /* DECimal Digits Per UNit [must be >0  */
44                              /* and <10; 3 or powers of 2 are best]. */
45
46  /* DECNUMDIGITS is the default number of digits that can be held in */
47  /* the structure.  If undefined, 1 is assumed and it is assumed     */
48  /* that the structure will be immediately followed by extra space,  */
49  /* as required.  DECNUMDIGITS is always >0.                         */
50  #if !defined(DECNUMDIGITS)
51    #define DECNUMDIGITS 1
52  #endif
53
54  /* The size (integer data type) of each unit is determined by the   */
55  /* number of digits it will hold.                                   */
56  #if   DECDPUN<=2
57    #define decNumberUnit uint8_t
58  #elif DECDPUN<=4
59    #define decNumberUnit uint16_t
60  #else
61    #define decNumberUnit uint32_t
62  #endif
63  /* The number of units needed is ceil(DECNUMDIGITS/DECDPUN)         */
64  #define DECNUMUNITS ((DECNUMDIGITS+DECDPUN-1)/DECDPUN)
65
66  /* The data structure... */
67  typedef struct  decNumber {
68    int32_t digits;      /* Count of digits in the coefficient; >0    */
69    int32_t exponent;    /* Unadjusted exponent, unbiased, in         */
70                         /* range: -1999999997 through 999999999      */
71    uint8_t bits;        /* Indicator bits (see above)                */
72                         /* Coefficient, from least significant unit  */
73    decNumberUnit lsu[DECNUMUNITS];
74  } decNumber;
75
76  /* Notes:                                                           */
77  /* 1. If digits is > DECDPUN then there will one or more            */
78  /*    decNumberUnits immediately following the first element of lsu.*/
79  /*    These contain the remaining (more significant) digits of the  */
80  /*    number, and may be in the lsu array, or may be guaranteed by  */
81  /*    some other mechanism (such as being contained in another      */
82  /*    structure, or being overlaid on dynamically allocated         */
83  /*    storage).                                                     */
84  /*                                                                  */
85  /*    Each integer of the coefficient (except potentially the last) */
86  /*    contains DECDPUN digits (e.g., a value in the range 0 through */
87  /*    99999999 if DECDPUN is 8, or 0 through 999 if DECDPUN is 3).  */
88  /*                                                                  */
89  /* 2. A decNumber converted to a string may need up to digits+14    */
90  /*    characters.  The worst cases (non-exponential and exponential */
91  /*    formats) are -0.00000{9...}# and -9.{9...}E+999999999#        */
92  /*    (where # is '\0')                                             */
93
94
95  /* ---------------------------------------------------------------- */
96  /* decNumber public functions and macros                            */
97  /* ---------------------------------------------------------------- */
98  /* Conversions                                                      */
99  decNumber * decNumberFromInt32(decNumber *, int32_t);
100  decNumber * decNumberFromUInt32(decNumber *, uint32_t);
101  decNumber * decNumberFromString(decNumber *, const char *, decContext *);
102  char      * decNumberToString(const decNumber *, char *);
103  char      * decNumberToEngString(const decNumber *, char *);
104  uint32_t    decNumberToUInt32(const decNumber *, decContext *);
105  int32_t     decNumberToInt32(const decNumber *, decContext *);
106  uint8_t   * decNumberGetBCD(const decNumber *, uint8_t *);
107  decNumber * decNumberSetBCD(decNumber *, const uint8_t *, uint32_t);
108
109  /* Operators and elementary functions                               */
110  decNumber * decNumberAbs(decNumber *, const decNumber *, decContext *);
111  decNumber * decNumberAdd(decNumber *, const decNumber *, const decNumber *, decContext *);
112  decNumber * decNumberAnd(decNumber *, const decNumber *, const decNumber *, decContext *);
113  decNumber * decNumberCompare(decNumber *, const decNumber *, const decNumber *, decContext *);
114  decNumber * decNumberCompareSignal(decNumber *, const decNumber *, const decNumber *, decContext *);
115  decNumber * decNumberCompareTotal(decNumber *, const decNumber *, const decNumber *, decContext *);
116  decNumber * decNumberCompareTotalMag(decNumber *, const decNumber *, const decNumber *, decContext *);
117  decNumber * decNumberDivide(decNumber *, const decNumber *, const decNumber *, decContext *);
118  decNumber * decNumberDivideInteger(decNumber *, const decNumber *, const decNumber *, decContext *);
119  decNumber * decNumberExp(decNumber *, const decNumber *, decContext *);
120  decNumber * decNumberFMA(decNumber *, const decNumber *, const decNumber *, const decNumber *, decContext *);
121  decNumber * decNumberInvert(decNumber *, const decNumber *, decContext *);
122  decNumber * decNumberLn(decNumber *, const decNumber *, decContext *);
123  decNumber * decNumberLogB(decNumber *, const decNumber *, decContext *);
124  decNumber * decNumberLog10(decNumber *, const decNumber *, decContext *);
125  decNumber * decNumberMax(decNumber *, const decNumber *, const decNumber *, decContext *);
126  decNumber * decNumberMaxMag(decNumber *, const decNumber *, const decNumber *, decContext *);
127  decNumber * decNumberMin(decNumber *, const decNumber *, const decNumber *, decContext *);
128  decNumber * decNumberMinMag(decNumber *, const decNumber *, const decNumber *, decContext *);
129  decNumber * decNumberMinus(decNumber *, const decNumber *, decContext *);
130  decNumber * decNumberMultiply(decNumber *, const decNumber *, const decNumber *, decContext *);
131  decNumber * decNumberNormalize(decNumber *, const decNumber *, decContext *);
132  decNumber * decNumberOr(decNumber *, const decNumber *, const decNumber *, decContext *);
133  decNumber * decNumberPlus(decNumber *, const decNumber *, decContext *);
134  decNumber * decNumberPower(decNumber *, const decNumber *, const decNumber *, decContext *);
135  decNumber * decNumberQuantize(decNumber *, const decNumber *, const decNumber *, decContext *);
136  decNumber * decNumberReduce(decNumber *, const decNumber *, decContext *);
137  decNumber * decNumberRemainder(decNumber *, const decNumber *, const decNumber *, decContext *);
138  decNumber * decNumberRemainderNear(decNumber *, const decNumber *, const decNumber *, decContext *);
139  decNumber * decNumberRescale(decNumber *, const decNumber *, const decNumber *, decContext *);
140  decNumber * decNumberRotate(decNumber *, const decNumber *, const decNumber *, decContext *);
141  decNumber * decNumberSameQuantum(decNumber *, const decNumber *, const decNumber *);
142  decNumber * decNumberScaleB(decNumber *, const decNumber *, const decNumber *, decContext *);
143  decNumber * decNumberShift(decNumber *, const decNumber *, const decNumber *, decContext *);
144  decNumber * decNumberSquareRoot(decNumber *, const decNumber *, decContext *);
145  decNumber * decNumberSubtract(decNumber *, const decNumber *, const decNumber *, decContext *);
146  decNumber * decNumberToIntegralExact(decNumber *, const decNumber *, decContext *);
147  decNumber * decNumberToIntegralValue(decNumber *, const decNumber *, decContext *);
148  decNumber * decNumberXor(decNumber *, const decNumber *, const decNumber *, decContext *);
149
150  /* Utilities                                                        */
151  enum decClass decNumberClass(const decNumber *, decContext *);
152  const char * decNumberClassToString(enum decClass);
153  decNumber  * decNumberCopy(decNumber *, const decNumber *);
154  decNumber  * decNumberCopyAbs(decNumber *, const decNumber *);
155  decNumber  * decNumberCopyNegate(decNumber *, const decNumber *);
156  decNumber  * decNumberCopySign(decNumber *, const decNumber *, const decNumber *);
157  decNumber  * decNumberNextMinus(decNumber *, const decNumber *, decContext *);
158  decNumber  * decNumberNextPlus(decNumber *, const decNumber *, decContext *);
159  decNumber  * decNumberNextToward(decNumber *, const decNumber *, const decNumber *, decContext *);
160  decNumber  * decNumberTrim(decNumber *);
161  const char * decNumberVersion(void);
162  decNumber  * decNumberZero(decNumber *);
163
164  /* Functions for testing decNumbers (normality depends on context)  */
165  int32_t decNumberIsNormal(const decNumber *, decContext *);
166  int32_t decNumberIsSubnormal(const decNumber *, decContext *);
167
168  /* Macros for testing decNumber *dn                                 */
169  #define decNumberIsCanonical(dn) (1)  /* All decNumbers are saintly */
170  #define decNumberIsFinite(dn)    (((dn)->bits&DECSPECIAL)==0)
171  #define decNumberIsInfinite(dn)  (((dn)->bits&DECINF)!=0)
172  #define decNumberIsNaN(dn)       (((dn)->bits&(DECNAN|DECSNAN))!=0)
173  #define decNumberIsNegative(dn)  (((dn)->bits&DECNEG)!=0)
174  #define decNumberIsQNaN(dn)      (((dn)->bits&(DECNAN))!=0)
175  #define decNumberIsSNaN(dn)      (((dn)->bits&(DECSNAN))!=0)
176  #define decNumberIsSpecial(dn)   (((dn)->bits&DECSPECIAL)!=0)
177  #define decNumberIsZero(dn)      (*(dn)->lsu==0 \
178                                    && (dn)->digits==1 \
179                                    && (((dn)->bits&DECSPECIAL)==0))
180  #define decNumberRadix(dn)       (10)
181
182#endif
183
Source Browser ?
