libdecnumber/decQuad.h

   1 /* decQuad module header for the decNumber C Library.
   2    Copyright (C) 2007 Free Software Foundation, Inc.
   3    Contributed by IBM Corporation.  Author Mike Cowlishaw.
   4
   5    This file is part of GCC.
   6
   7    GCC is free software; you can redistribute it and/or modify it under
   8    the terms of the GNU General Public License as published by the Free
   9    Software Foundation; either version 2, or (at your option) any later
  10    version.
  11
  12    In addition to the permissions in the GNU General Public License,
  13    the Free Software Foundation gives you unlimited permission to link
  14    the compiled version of this file into combinations with other
  15    programs, and to distribute those combinations without any
  16    restriction coming from the use of this file.  (The General Public
  17    License restrictions do apply in other respects; for example, they
  18    cover modification of the file, and distribution when not linked
  19    into a combine executable.)
  20
  21    GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  22    WARRANTY; without even the implied warranty of MERCHANTABILITY or
  23    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  24    for more details.
  25
  26    You should have received a copy of the GNU General Public License
  27    along with GCC; see the file COPYING.  If not, write to the Free
  28    Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  29    02110-1301, USA.  */
  30
  31 /* ------------------------------------------------------------------ */
  32 /* decQuad.h -- Decimal 128-bit format module header                  */
  33 /* ------------------------------------------------------------------ */
  34 /* Please see decFloats.h for an overview and documentation details.  */
  35 /* ------------------------------------------------------------------ */
  36 /* This include file is always included by decSingle and decDouble,   */
  37 /* and therefore also holds useful constants used by all three.       */
  38
  39 #if !defined(DECQUAD)
  40   #define DECQUAD
  41
  42   #define DECQUADNAME         "decimalQuad"           /* Short name   */
  43   #define DECQUADTITLE        "Decimal 128-bit datum" /* Verbose name */
  44   #define DECQUADAUTHOR       "Mike Cowlishaw"        /* Who to blame */
  45
  46   /* parameters for decQuads */
  47   #define DECQUAD_Bytes    16      /* length                          */
  48   #define DECQUAD_Pmax     34      /* maximum precision (digits)      */
  49   #define DECQUAD_Emin  -6143      /* minimum adjusted exponent       */
  50   #define DECQUAD_Emax   6144      /* maximum adjusted exponent       */
  51   #define DECQUAD_EmaxD     4      /* maximum exponent digits         */
  52   #define DECQUAD_Bias   6176      /* bias for the exponent           */
  53   #define DECQUAD_String   43      /* maximum string length, +1       */
  54   #define DECQUAD_EconL    12      /* exponent continuation length    */
  55   #define DECQUAD_Declets  11      /* count of declets                */
  56   /* highest biased exponent (Elimit-1) */
  57   #define DECQUAD_Ehigh (DECQUAD_Emax + DECQUAD_Bias - (DECQUAD_Pmax-1))
  58
  59   /* Required include                                                 */
  60   #include "decContext.h"
  61
  62   /* The decQuad decimal 128-bit type, accessible by various types */
  63   typedef union {
  64     uint8_t bytes[DECQUAD_Bytes];  /* fields: 1, 5, 12, 110 bits */
  65     uint16_t shorts[DECQUAD_Bytes/2];
  66     uint32_t words[DECQUAD_Bytes/4];
  67     } decQuad;
  68
  69   /* ---------------------------------------------------------------- */
  70   /* Shared constants                                                 */
  71   /* ---------------------------------------------------------------- */
  72
  73   /* sign and special values [top 32-bits; last two bits are don't-care
  74      for Infinity on input, last bit don't-care for NaNs] */
  75   #define DECFLOAT_Sign  0x80000000     /* 1 00000 00 Sign */
  76   #define DECFLOAT_NaN   0x7c000000     /* 0 11111 00 NaN generic */
  77   #define DECFLOAT_qNaN  0x7c000000     /* 0 11111 00 qNaN */
  78   #define DECFLOAT_sNaN  0x7e000000     /* 0 11111 10 sNaN */
  79   #define DECFLOAT_Inf   0x78000000     /* 0 11110 00 Infinity */
  80   #define DECFLOAT_MinSp 0x78000000     /* minimum special value */
  81                                         /* [specials are all >=MinSp] */
  82   /* Sign nibble constants                                            */
  83   #if !defined(DECPPLUSALT)
  84     #define DECPPLUSALT  0x0A /* alternate plus  nibble               */
  85     #define DECPMINUSALT 0x0B /* alternate minus nibble               */
  86     #define DECPPLUS     0x0C /* preferred plus  nibble               */
  87     #define DECPMINUS    0x0D /* preferred minus nibble               */
  88     #define DECPPLUSALT2 0x0E /* alternate plus  nibble               */
  89     #define DECPUNSIGNED 0x0F /* alternate plus  nibble (unsigned)    */
  90   #endif
  91
  92   /* ---------------------------------------------------------------- */
  93   /* Routines -- implemented as decFloat routines in common files     */
  94   /* ---------------------------------------------------------------- */
  95
  96   #include "decQuadSymbols.h"
  97
  98   /* Utilities and conversions, extractors, etc.) */
  99   extern decQuad * decQuadFromBCD(decQuad *, int32_t, const uint8_t *, int32_t);
 100   extern decQuad * decQuadFromInt32(decQuad *, int32_t);
 101   extern decQuad * decQuadFromPacked(decQuad *, int32_t, const uint8_t *);
 102   extern decQuad * decQuadFromString(decQuad *, const char *, decContext *);
 103   extern decQuad * decQuadFromUInt32(decQuad *, uint32_t);
 104   extern int32_t   decQuadGetCoefficient(const decQuad *, uint8_t *);
 105   extern int32_t   decQuadGetExponent(const decQuad *);
 106   extern decQuad * decQuadSetCoefficient(decQuad *, const uint8_t *, int32_t);
 107   extern decQuad * decQuadSetExponent(decQuad *, decContext *, int32_t);
 108   extern void      decQuadShow(const decQuad *, const char *);
 109   extern int32_t   decQuadToBCD(const decQuad *, int32_t *, uint8_t *);
 110   extern char    * decQuadToEngString(const decQuad *, char *);
 111   extern int32_t   decQuadToInt32(const decQuad *, decContext *, enum rounding);
 112   extern int32_t   decQuadToInt32Exact(const decQuad *, decContext *, enum rounding);
 113   extern int32_t   decQuadToPacked(const decQuad *, int32_t *, uint8_t *);
 114   extern char    * decQuadToString(const decQuad *, char *);
 115   extern uint32_t  decQuadToUInt32(const decQuad *, decContext *, enum rounding);
 116   extern uint32_t  decQuadToUInt32Exact(const decQuad *, decContext *, enum rounding);
 117   extern decQuad * decQuadZero(decQuad *);
 118
 119   /* Computational (result is a decQuad) */
 120   extern decQuad * decQuadAbs(decQuad *, const decQuad *, decContext *);
 121   extern decQuad * decQuadAdd(decQuad *, const decQuad *, const decQuad *, decContext *);
 122   extern decQuad * decQuadAnd(decQuad *, const decQuad *, const decQuad *, decContext *);
 123   extern decQuad * decQuadDivide(decQuad *, const decQuad *, const decQuad *, decContext *);
 124   extern decQuad * decQuadDivideInteger(decQuad *, const decQuad *, const decQuad *, decContext *);
 125   extern decQuad * decQuadFMA(decQuad *, const decQuad *, const decQuad *, const decQuad *, decContext *);
 126   extern decQuad * decQuadInvert(decQuad *, const decQuad *, decContext *);
 127   extern decQuad * decQuadLogB(decQuad *, const decQuad *, decContext *);
 128   extern decQuad * decQuadMax(decQuad *, const decQuad *, const decQuad *, decContext *);
 129   extern decQuad * decQuadMaxMag(decQuad *, const decQuad *, const decQuad *, decContext *);
 130   extern decQuad * decQuadMin(decQuad *, const decQuad *, const decQuad *, decContext *);
 131   extern decQuad * decQuadMinMag(decQuad *, const decQuad *, const decQuad *, decContext *);
 132   extern decQuad * decQuadMinus(decQuad *, const decQuad *, decContext *);
 133   extern decQuad * decQuadMultiply(decQuad *, const decQuad *, const decQuad *, decContext *);
 134   extern decQuad * decQuadNextMinus(decQuad *, const decQuad *, decContext *);
 135   extern decQuad * decQuadNextPlus(decQuad *, const decQuad *, decContext *);
 136   extern decQuad * decQuadNextToward(decQuad *, const decQuad *, const decQuad *, decContext *);
 137   extern decQuad * decQuadOr(decQuad *, const decQuad *, const decQuad *, decContext *);
 138   extern decQuad * decQuadPlus(decQuad *, const decQuad *, decContext *);
 139   extern decQuad * decQuadQuantize(decQuad *, const decQuad *, const decQuad *, decContext *);
 140   extern decQuad * decQuadReduce(decQuad *, const decQuad *, decContext *);
 141   extern decQuad * decQuadRemainder(decQuad *, const decQuad *, const decQuad *, decContext *);
 142   extern decQuad * decQuadRemainderNear(decQuad *, const decQuad *, const decQuad *, decContext *);
 143   extern decQuad * decQuadRotate(decQuad *, const decQuad *, const decQuad *, decContext *);
 144   extern decQuad * decQuadScaleB(decQuad *, const decQuad *, const decQuad *, decContext *);
 145   extern decQuad * decQuadShift(decQuad *, const decQuad *, const decQuad *, decContext *);
 146   extern decQuad * decQuadSubtract(decQuad *, const decQuad *, const decQuad *, decContext *);
 147   extern decQuad * decQuadToIntegralValue(decQuad *, const decQuad *, decContext *, enum rounding);
 148   extern decQuad * decQuadToIntegralExact(decQuad *, const decQuad *, decContext *);
 149   extern decQuad * decQuadXor(decQuad *, const decQuad *, const decQuad *, decContext *);
 150
 151   /* Comparisons */
 152   extern decQuad * decQuadCompare(decQuad *, const decQuad *, const decQuad *, decContext *);
 153   extern decQuad * decQuadCompareSignal(decQuad *, const decQuad *, const decQuad *, decContext *);
 154   extern decQuad * decQuadCompareTotal(decQuad *, const decQuad *, const decQuad *);
 155   extern decQuad * decQuadCompareTotalMag(decQuad *, const decQuad *, const decQuad *);
 156
 157   /* Copies */
 158   extern decQuad * decQuadCanonical(decQuad *, const decQuad *);
 159   extern decQuad * decQuadCopy(decQuad *, const decQuad *);
 160   extern decQuad * decQuadCopyAbs(decQuad *, const decQuad *);
 161   extern decQuad * decQuadCopyNegate(decQuad *, const decQuad *);
 162   extern decQuad * decQuadCopySign(decQuad *, const decQuad *, const decQuad *);
 163
 164   /* Non-computational */
 165   extern enum decClass decQuadClass(const decQuad *);
 166   extern const char *  decQuadClassString(const decQuad *);
 167   extern uint32_t      decQuadDigits(const decQuad *);
 168   extern uint32_t      decQuadIsCanonical(const decQuad *);
 169   extern uint32_t      decQuadIsFinite(const decQuad *);
 170   extern uint32_t      decQuadIsInteger(const decQuad *);
 171   extern uint32_t      decQuadIsInfinite(const decQuad *);
 172   extern uint32_t      decQuadIsNaN(const decQuad *);
 173   extern uint32_t      decQuadIsNormal(const decQuad *);
 174   extern uint32_t      decQuadIsSignaling(const decQuad *);
 175   extern uint32_t      decQuadIsSignalling(const decQuad *);
 176   extern uint32_t      decQuadIsSigned(const decQuad *);
 177   extern uint32_t      decQuadIsSubnormal(const decQuad *);
 178   extern uint32_t      decQuadIsZero(const decQuad *);
 179   extern uint32_t      decQuadRadix(const decQuad *);
 180   extern uint32_t      decQuadSameQuantum(const decQuad *, const decQuad *);
 181   extern const char *  decQuadVersion(void);
 182
 183   /* decNumber conversions; these are implemented as macros so as not  */
 184   /* to force a dependency on decimal128 and decNumber in decQuad.     */
 185   #define decQuadToNumber(dq, dn) decimal128ToNumber((decimal128 *)(dq), dn)
 186   #define decQuadFromNumber(dq, dn, set) (decQuad *)decimal128FromNumber((decimal128 *)(dq), dn, set)
 187
 188 #endif