PageRenderTime 32ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 1ms

/i18n/decContext.h

https://github.com/CyanogenMod/android_external_icu4c
C Header | 268 lines | 178 code | 19 blank | 71 comment | 0 complexity | 3eb500379e5e1f412bdf36dce052831a MD5 | raw file
    

  1. /* ------------------------------------------------------------------ */
    2. 

  2. /* Decimal Context module header                                      */
    3. 

  3. /* ------------------------------------------------------------------ */
    4. 

  4. /* Copyright (c) IBM Corporation, 2000-2011.   All rights reserved.   */
    5. 

  5. /*                                                                    */
    6. 

  6. /* This software is made available under the terms of the             */
    7. 

  7. /* ICU License -- ICU 1.8.1 and later.                                */
    8. 

  8. /*                                                                    */
    9. 

  9. /* The description and User's Guide ("The decNumber C Library") for   */
    10. 

  10. /* this software is called decNumber.pdf.  This document is           */
    11. 

  11. /* available, together with arithmetic and format specifications,     */
    12. 

  12. /* testcases, and Web links, on the General Decimal Arithmetic page.  */
    13. 

  13. /*                                                                    */
    14. 

  14. /* Please send comments, suggestions, and corrections to the author:  */
    15. 

  15. /*   mfc@uk.ibm.com                                                   */
    16. 

  16. /*   Mike Cowlishaw, IBM Fellow                                       */
    17. 

  17. /*   IBM UK, PO Box 31, Birmingham Road, Warwick CV34 5JL, UK         */
    18. 

  18. /* ------------------------------------------------------------------ */
    19. 

  19. 

  20. /* Modified version, for use from within ICU.
    21. 

  21.  *    Renamed public functions, to avoid an unwanted export of the 
    22. 

  22.  *    standard names from the ICU library.
    23. 

  23.  *
    24. 

  24.  *    Use ICU's uprv_malloc() and uprv_free()
    25. 

  25.  *
    26. 

  26.  *    Revert comment syntax to plain C
    27. 

  27.  *
    28. 

  28.  *    Remove a few compiler warnings.
    29. 

  29.  */
    30. 

  30. #include "unicode/utypes.h"
    31. 

  31. #include "putilimp.h"
    32. 

  32. 

  33. /*                                                                    */
    34. 

  34. /* Context variables must always have valid values:                   */
    35. 

  35. /*                                                                    */
    36. 

  36. /*  status   -- [any bits may be cleared, but not set, by user]       */
    37. 

  37. /*  round    -- must be one of the enumerated rounding modes          */
    38. 

  38. /*                                                                    */
    39. 

  39. /* The following variables are implied for fixed size formats (i.e.,  */
    40. 

  40. /* they are ignored) but should still be set correctly in case used   */
    41. 

  41. /* with decNumber functions:                                          */
    42. 

  42. /*                                                                    */
    43. 

  43. /*  clamp    -- must be either 0 or 1                                 */
    44. 

  44. /*  digits   -- must be in the range 1 through 999999999              */
    45. 

  45. /*  emax     -- must be in the range 0 through 999999999              */
    46. 

  46. /*  emin     -- must be in the range 0 through -999999999             */
    47. 

  47. /*  extended -- must be either 0 or 1 [present only if DECSUBSET]     */
    48. 

  48. /*  traps    -- only defined bits may be set                          */
    49. 

  49. /*                                                                    */
    50. 

  50. /* ------------------------------------------------------------------ */
    51. 

  51. 

  52. #if !defined(DECCONTEXT)
    53. 

  53.   #define DECCONTEXT
    54. 

  54.   #define DECCNAME     "decContext"                     /* Short name */
    55. 

  55.   #define DECCFULLNAME "Decimal Context Descriptor"   /* Verbose name */
    56. 

  56.   #define DECCAUTHOR   "Mike Cowlishaw"               /* Who to blame */
    57. 

  57. 

  58.   #if !defined(int32_t)
    59. 

  59. /* #include <stdint.h>   */         /* C99 standard integers           */
    60. 

  60.   #endif
    61. 

  61.   #include <stdio.h>               /* for printf, etc.                */
    62. 

  62.   #include <signal.h>              /* for traps                       */
    63. 

  63. 

  64.   /* Extended flags setting -- set this to 0 to use only IEEE flags   */
    65. 

  65.   #if !defined(DECEXTFLAG)
    66. 

  66.   #define DECEXTFLAG 1             /* 1=enable extended flags         */
    67. 

  67.   #endif
    68. 

  68. 

  69.   /* Conditional code flag -- set this to 0 for best performance      */
    70. 

  70.   #if !defined(DECSUBSET)
    71. 

  71.   #define DECSUBSET  0             /* 1=enable subset arithmetic      */
    72. 

  72.   #endif
    73. 

  73. 

  74.   /* Context for operations, with associated constants                */
    75. 

  75.   enum rounding {
    76. 

  76.     DEC_ROUND_CEILING,             /* round towards +infinity         */
    77. 

  77.     DEC_ROUND_UP,                  /* round away from 0               */
    78. 

  78.     DEC_ROUND_HALF_UP,             /* 0.5 rounds up                   */
    79. 

  79.     DEC_ROUND_HALF_EVEN,           /* 0.5 rounds to nearest even      */
    80. 

  80.     DEC_ROUND_HALF_DOWN,           /* 0.5 rounds down                 */
    81. 

  81.     DEC_ROUND_DOWN,                /* round towards 0 (truncate)      */
    82. 

  82.     DEC_ROUND_FLOOR,               /* round towards -infinity         */
    83. 

  83.     DEC_ROUND_05UP,                /* round for reround               */
    84. 

  84.     DEC_ROUND_MAX                  /* enum must be less than this     */
    85. 

  85.     };
    86. 

  86.   #define DEC_ROUND_DEFAULT DEC_ROUND_HALF_EVEN;
    87. 

  87. 

  88.   typedef struct {
    89. 

  89.     int32_t  digits;               /* working precision               */
    90. 

  90.     int32_t  emax;                 /* maximum positive exponent       */
    91. 

  91.     int32_t  emin;                 /* minimum negative exponent       */
    92. 

  92.     enum     rounding round;       /* rounding mode                   */
    93. 

  93.     uint32_t traps;                /* trap-enabler flags              */
    94. 

  94.     uint32_t status;               /* status flags                    */
    95. 

  95.     uint8_t  clamp;                /* flag: apply IEEE exponent clamp */
    96. 

  96.     #if DECSUBSET
    97. 

  97.     uint8_t  extended;             /* flag: special-values allowed    */
    98. 

  98.     #endif
    99. 

  99.     } decContext;
    100. 

  100. 

  101.   /* Maxima and Minima for context settings                           */
    102. 

  102.   #define DEC_MAX_DIGITS 999999999
    103. 

  103.   #define DEC_MIN_DIGITS         1
    104. 

  104.   #define DEC_MAX_EMAX   999999999
    105. 

  105.   #define DEC_MIN_EMAX           0
    106. 

  106.   #define DEC_MAX_EMIN           0
    107. 

  107.   #define DEC_MIN_EMIN  -999999999
    108. 

  108.   #define DEC_MAX_MATH      999999 /* max emax, etc., for math funcs. */
    109. 

  109. 

  110.   /* Classifications for decimal numbers, aligned with 754 (note that */
    111. 

  111.   /* 'normal' and 'subnormal' are meaningful only with a decContext   */
    112. 

  112.   /* or a fixed size format).                                         */
    113. 

  113.   enum decClass {
    114. 

  114.     DEC_CLASS_SNAN,
    115. 

  115.     DEC_CLASS_QNAN,
    116. 

  116.     DEC_CLASS_NEG_INF,
    117. 

  117.     DEC_CLASS_NEG_NORMAL,
    118. 

  118.     DEC_CLASS_NEG_SUBNORMAL,
    119. 

  119.     DEC_CLASS_NEG_ZERO,
    120. 

  120.     DEC_CLASS_POS_ZERO,
    121. 

  121.     DEC_CLASS_POS_SUBNORMAL,
    122. 

  122.     DEC_CLASS_POS_NORMAL,
    123. 

  123.     DEC_CLASS_POS_INF
    124. 

  124.     };
    125. 

  125.   /* Strings for the decClasses */
    126. 

  126.   #define DEC_ClassString_SN  "sNaN"
    127. 

  127.   #define DEC_ClassString_QN  "NaN"
    128. 

  128.   #define DEC_ClassString_NI  "-Infinity"
    129. 

  129.   #define DEC_ClassString_NN  "-Normal"
    130. 

  130.   #define DEC_ClassString_NS  "-Subnormal"
    131. 

  131.   #define DEC_ClassString_NZ  "-Zero"
    132. 

  132.   #define DEC_ClassString_PZ  "+Zero"
    133. 

  133.   #define DEC_ClassString_PS  "+Subnormal"
    134. 

  134.   #define DEC_ClassString_PN  "+Normal"
    135. 

  135.   #define DEC_ClassString_PI  "+Infinity"
    136. 

  136.   #define DEC_ClassString_UN  "Invalid"
    137. 

  137. 

  138.   /* Trap-enabler and Status flags (exceptional conditions), and      */
    139. 

  139.   /* their names.  The top byte is reserved for internal use          */
    140. 

  140.   #if DECEXTFLAG
    141. 

  141.     /* Extended flags */
    142. 

  142.     #define DEC_Conversion_syntax    0x00000001
    143. 

  143.     #define DEC_Division_by_zero     0x00000002
    144. 

  144.     #define DEC_Division_impossible  0x00000004
    145. 

  145.     #define DEC_Division_undefined   0x00000008
    146. 

  146.     #define DEC_Insufficient_storage 0x00000010 /* [when malloc fails]  */
    147. 

  147.     #define DEC_Inexact              0x00000020
    148. 

  148.     #define DEC_Invalid_context      0x00000040
    149. 

  149.     #define DEC_Invalid_operation    0x00000080
    150. 

  150.     #if DECSUBSET
    151. 

  151.     #define DEC_Lost_digits          0x00000100
    152. 

  152.     #endif
    153. 

  153.     #define DEC_Overflow             0x00000200
    154. 

  154.     #define DEC_Clamped              0x00000400
    155. 

  155.     #define DEC_Rounded              0x00000800
    156. 

  156.     #define DEC_Subnormal            0x00001000
    157. 

  157.     #define DEC_Underflow            0x00002000
    158. 

  158.   #else
    159. 

  159.     /* IEEE flags only */
    160. 

  160.     #define DEC_Conversion_syntax    0x00000010
    161. 

  161.     #define DEC_Division_by_zero     0x00000002
    162. 

  162.     #define DEC_Division_impossible  0x00000010
    163. 

  163.     #define DEC_Division_undefined   0x00000010
    164. 

  164.     #define DEC_Insufficient_storage 0x00000010 /* [when malloc fails]  */
    165. 

  165.     #define DEC_Inexact              0x00000001
    166. 

  166.     #define DEC_Invalid_context      0x00000010
    167. 

  167.     #define DEC_Invalid_operation    0x00000010
    168. 

  168.     #if DECSUBSET
    169. 

  169.     #define DEC_Lost_digits          0x00000000
    170. 

  170.     #endif
    171. 

  171.     #define DEC_Overflow             0x00000008
    172. 

  172.     #define DEC_Clamped              0x00000000
    173. 

  173.     #define DEC_Rounded              0x00000000
    174. 

  174.     #define DEC_Subnormal            0x00000000
    175. 

  175.     #define DEC_Underflow            0x00000004
    176. 

  176.   #endif
    177. 

  177. 

  178.   /* IEEE 754 groupings for the flags                                 */
    179. 

  179.   /* [DEC_Clamped, DEC_Lost_digits, DEC_Rounded, and DEC_Subnormal    */
    180. 

  180.   /* are not in IEEE 754]                                             */
    181. 

  181.   #define DEC_IEEE_754_Division_by_zero  (DEC_Division_by_zero)
    182. 

  182.   #if DECSUBSET
    183. 

  183.   #define DEC_IEEE_754_Inexact           (DEC_Inexact | DEC_Lost_digits)
    184. 

  184.   #else
    185. 

  185.   #define DEC_IEEE_754_Inexact           (DEC_Inexact)
    186. 

  186.   #endif
    187. 

  187.   #define DEC_IEEE_754_Invalid_operation (DEC_Conversion_syntax |     \
    188. 

  188.                                           DEC_Division_impossible |   \
    189. 

  189.                                           DEC_Division_undefined |    \
    190. 

  190.                                           DEC_Insufficient_storage |  \
    191. 

  191.                                           DEC_Invalid_context |       \
    192. 

  192.                                           DEC_Invalid_operation)
    193. 

  193.   #define DEC_IEEE_754_Overflow          (DEC_Overflow)
    194. 

  194.   #define DEC_IEEE_754_Underflow         (DEC_Underflow)
    195. 

  195. 

  196.   /* flags which are normally errors (result is qNaN, infinite, or 0) */
    197. 

  197.   #define DEC_Errors (DEC_IEEE_754_Division_by_zero |                 \
    198. 

  198.                       DEC_IEEE_754_Invalid_operation |                \
    199. 

  199.                       DEC_IEEE_754_Overflow | DEC_IEEE_754_Underflow)
    200. 

  200.   /* flags which cause a result to become qNaN                        */
    201. 

  201.   #define DEC_NaNs    DEC_IEEE_754_Invalid_operation
    202. 

  202. 

  203.   /* flags which are normally for information only (finite results)   */
    204. 

  204.   #if DECSUBSET
    205. 

  205.   #define DEC_Information (DEC_Clamped | DEC_Rounded | DEC_Inexact    \
    206. 

  206.                           | DEC_Lost_digits)
    207. 

  207.   #else
    208. 

  208.   #define DEC_Information (DEC_Clamped | DEC_Rounded | DEC_Inexact)
    209. 

  209.   #endif
    210. 

  210. 

  211.   /* IEEE 854 names (for compatibility with older decNumber versions) */
    212. 

  212.   #define DEC_IEEE_854_Division_by_zero  DEC_IEEE_754_Division_by_zero
    213. 

  213.   #define DEC_IEEE_854_Inexact           DEC_IEEE_754_Inexact
    214. 

  214.   #define DEC_IEEE_854_Invalid_operation DEC_IEEE_754_Invalid_operation
    215. 

  215.   #define DEC_IEEE_854_Overflow          DEC_IEEE_754_Overflow
    216. 

  216.   #define DEC_IEEE_854_Underflow         DEC_IEEE_754_Underflow
    217. 

  217. 

  218.   /* Name strings for the exceptional conditions                      */
    219. 

  219.   #define DEC_Condition_CS "Conversion syntax"
    220. 

  220.   #define DEC_Condition_DZ "Division by zero"
    221. 

  221.   #define DEC_Condition_DI "Division impossible"
    222. 

  222.   #define DEC_Condition_DU "Division undefined"
    223. 

  223.   #define DEC_Condition_IE "Inexact"
    224. 

  224.   #define DEC_Condition_IS "Insufficient storage"
    225. 

  225.   #define DEC_Condition_IC "Invalid context"
    226. 

  226.   #define DEC_Condition_IO "Invalid operation"
    227. 

  227.   #if DECSUBSET
    228. 

  228.   #define DEC_Condition_LD "Lost digits"
    229. 

  229.   #endif
    230. 

  230.   #define DEC_Condition_OV "Overflow"
    231. 

  231.   #define DEC_Condition_PA "Clamped"
    232. 

  232.   #define DEC_Condition_RO "Rounded"
    233. 

  233.   #define DEC_Condition_SU "Subnormal"
    234. 

  234.   #define DEC_Condition_UN "Underflow"
    235. 

  235.   #define DEC_Condition_ZE "No status"
    236. 

  236.   #define DEC_Condition_MU "Multiple status"
    237. 

  237.   #define DEC_Condition_Length 21  /* length of the longest string,   */
    238. 

  238.                                    /* including terminator            */
    239. 

  239. 

  240.   /* Initialization descriptors, used by decContextDefault            */
    241. 

  241.   #define DEC_INIT_BASE         0
    242. 

  242.   #define DEC_INIT_DECIMAL32   32
    243. 

  243.   #define DEC_INIT_DECIMAL64   64
    244. 

  244.   #define DEC_INIT_DECIMAL128 128
    245. 

  245.   /* Synonyms */
    246. 

  246.   #define DEC_INIT_DECSINGLE  DEC_INIT_DECIMAL32
    247. 

  247.   #define DEC_INIT_DECDOUBLE  DEC_INIT_DECIMAL64
    248. 

  248.   #define DEC_INIT_DECQUAD    DEC_INIT_DECIMAL128
    249. 

  249. 

  250.   /* decContext routines                                              */
    251. 

  251.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextClearStatus(decContext *, uint32_t);
    252. 

  252.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextDefault(decContext *, int32_t);
    253. 

  253.   U_INTERNAL enum rounding U_EXPORT2 uprv_decContextGetRounding(decContext *);
    254. 

  254.   U_INTERNAL uint32_t      U_EXPORT2 uprv_decContextGetStatus(decContext *);
    255. 

  255.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextRestoreStatus(decContext *, uint32_t, uint32_t);
    256. 

  256.   U_INTERNAL uint32_t      U_EXPORT2 uprv_decContextSaveStatus(decContext *, uint32_t);
    257. 

  257.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextSetRounding(decContext *, enum rounding);
    258. 

  258.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextSetStatus(decContext *, uint32_t);
    259. 

  259.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextSetStatusFromString(decContext *, const char *);
    260. 

  260.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextSetStatusFromStringQuiet(decContext *, const char *);
    261. 

  261.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextSetStatusQuiet(decContext *, uint32_t);
    262. 

  262.   U_INTERNAL const char  * U_EXPORT2 uprv_decContextStatusToString(const decContext *);
    263. 

  263.   U_INTERNAL int32_t       U_EXPORT2 uprv_decContextTestEndian(uint8_t);
    264. 

  264.   U_INTERNAL uint32_t      U_EXPORT2 uprv_decContextTestSavedStatus(uint32_t, uint32_t);
    265. 

  265.   U_INTERNAL uint32_t      U_EXPORT2 uprv_decContextTestStatus(decContext *, uint32_t);
    266. 

  266.   U_INTERNAL decContext  * U_EXPORT2 uprv_decContextZeroStatus(decContext *);
    267. 

  267. 

  268. #endif
    269. 

  269.