[thirdparty/gcc.git] / libdecnumber / decSingle.h

/* decSingle module header for the decNumber C Library.
   Copyright (C) 2005-2019 Free Software Foundation, Inc.
   Contributed by IBM Corporation.  Author Mike Cowlishaw.

   This file is part of GCC.

   GCC is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 3, or (at your option) any later
   version.

   GCC is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

Under Section 7 of GPL version 3, you are granted additional
permissions described in the GCC Runtime Library Exception, version
3.1, as published by the Free Software Foundation.

You should have received a copy of the GNU General Public License and
a copy of the GCC Runtime Library Exception along with this program;
see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
<http://www.gnu.org/licenses/>.  */

/* ------------------------------------------------------------------ */
/* decSingle.h -- Decimal 32-bit format module header		      */
/* ------------------------------------------------------------------ */

#if !defined(DECSINGLE)
  #define DECSINGLE

  #define DECSINGLENAME       "decSingle"	      /* Short name   */
  #define DECSINGLETITLE      "Decimal 32-bit datum"  /* Verbose name */
  #define DECSINGLEAUTHOR     "Mike Cowlishaw"	      /* Who to blame */

  /* parameters for decSingles */
  #define DECSINGLE_Bytes    4	   /* length			      */
  #define DECSINGLE_Pmax     7	   /* maximum precision (digits)      */
  #define DECSINGLE_Emin   -95	   /* minimum adjusted exponent       */
  #define DECSINGLE_Emax    96	   /* maximum adjusted exponent       */
  #define DECSINGLE_EmaxD    3	   /* maximum exponent digits	      */
  #define DECSINGLE_Bias   101	   /* bias for the exponent	      */
  #define DECSINGLE_String  16	   /* maximum string length, +1       */
  #define DECSINGLE_EconL    6	   /* exponent continuation length    */
  #define DECSINGLE_Declets  2	   /* count of declets		      */
  /* highest biased exponent (Elimit-1) */
  #define DECSINGLE_Ehigh (DECSINGLE_Emax + DECSINGLE_Bias - (DECSINGLE_Pmax-1))

  /* Required includes						      */
  #include "decContext.h"
  #include "decQuad.h"
  #include "decDouble.h"

  /* The decSingle decimal 32-bit type, accessible by all sizes */
  typedef union {
    uint8_t   bytes[DECSINGLE_Bytes];	/* fields: 1, 5, 6, 20 bits */
    uint16_t shorts[DECSINGLE_Bytes/2];
    uint32_t  words[DECSINGLE_Bytes/4];
    } decSingle;

  /* ---------------------------------------------------------------- */
  /* Routines -- implemented as decFloat routines in common files     */
  /* ---------------------------------------------------------------- */

  #include "decSingleSymbols.h"

  /* Utilities (binary argument(s) or result, extractors, etc.) */
  extern decSingle * decSingleFromBCD(decSingle *, int32_t, const uint8_t *, int32_t);
  extern decSingle * decSingleFromPacked(decSingle *, int32_t, const uint8_t *);
  extern decSingle * decSingleFromPackedChecked(decSingle *, int32_t, const uint8_t *);
  extern decSingle * decSingleFromString(decSingle *, const char *, decContext *);
  extern decSingle * decSingleFromWider(decSingle *, const decDouble *, decContext *);
  extern int32_t     decSingleGetCoefficient(const decSingle *, uint8_t *);
  extern int32_t     decSingleGetExponent(const decSingle *);
  extern decSingle * decSingleSetCoefficient(decSingle *, const uint8_t *, int32_t);
  extern decSingle * decSingleSetExponent(decSingle *, decContext *, int32_t);
  extern void	     decSingleShow(const decSingle *, const char *);
  extern int32_t     decSingleToBCD(const decSingle *, int32_t *, uint8_t *);
  extern char	   * decSingleToEngString(const decSingle *, char *);
  extern int32_t     decSingleToPacked(const decSingle *, int32_t *, uint8_t *);
  extern char	   * decSingleToString(const decSingle *, char *);
  extern decDouble * decSingleToWider(const decSingle *, decDouble *);
  extern decSingle * decSingleZero(decSingle *);

  /* (No Arithmetic routines for decSingle) */

  /* Non-computational */
  extern uint32_t     decSingleRadix(const decSingle *);
  extern const char * decSingleVersion(void);

  /* decNumber conversions; these are implemented as macros so as not  */
  /* to force a dependency on decimal32 and decNumber in decSingle.    */
  /* decSingleFromNumber returns a decimal32 * to avoid warnings.      */
  #define decSingleToNumber(dq, dn) decimal32ToNumber((decimal32 *)(dq), dn)
  #define decSingleFromNumber(dq, dn, set) decimal32FromNumber((decimal32 *)(dq), dn, set)

#endif
Commit	Line	Data
2533577f	1	/* decSingle module header for the decNumber C Library.
a5544970	2	Copyright (C) 2005-2019 Free Software Foundation, Inc.
2533577f JJ	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
748086b7	9	Software Foundation; either version 3, or (at your option) any later
2533577f JJ	10	version.
2533577f JJ	11
2533577f JJ	12	GCC is distributed in the hope that it will be useful, but WITHOUT ANY
	13	WARRANTY; without even the implied warranty of MERCHANTABILITY or
	14	FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	15	for more details.
	16
748086b7 JJ	17	Under Section 7 of GPL version 3, you are granted additional
	18	permissions described in the GCC Runtime Library Exception, version
	19	3.1, as published by the Free Software Foundation.
	20
	21	You should have received a copy of the GNU General Public License and
	22	a copy of the GCC Runtime Library Exception along with this program;
	23	see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
	24	<http://www.gnu.org/licenses/>. */
2533577f JJ	25
	26	/* ------------------------------------------------------------------ */
	27	/* decSingle.h -- Decimal 32-bit format module header */
	28	/* ------------------------------------------------------------------ */
2533577f JJ	29
	30	#if !defined(DECSINGLE)
	31	#define DECSINGLE
	32
7bd36a9c	33	#define DECSINGLENAME "decSingle" /* Short name */
2533577f JJ	34	#define DECSINGLETITLE "Decimal 32-bit datum" /* Verbose name */
	35	#define DECSINGLEAUTHOR "Mike Cowlishaw" /* Who to blame */
	36
	37	/* parameters for decSingles */
	38	#define DECSINGLE_Bytes 4 /* length */
	39	#define DECSINGLE_Pmax 7 /* maximum precision (digits) */
7bd36a9c BE	40	#define DECSINGLE_Emin -95 /* minimum adjusted exponent */
7bd36a9c BE	41	#define DECSINGLE_Emax 96 /* maximum adjusted exponent */
2533577f JJ	42	#define DECSINGLE_EmaxD 3 /* maximum exponent digits */
2533577f JJ	43	#define DECSINGLE_Bias 101 /* bias for the exponent */
7bd36a9c	44	#define DECSINGLE_String 16 /* maximum string length, +1 */
2533577f JJ	45	#define DECSINGLE_EconL 6 /* exponent continuation length */
	46	#define DECSINGLE_Declets 2 /* count of declets */
	47	/* highest biased exponent (Elimit-1) */
	48	#define DECSINGLE_Ehigh (DECSINGLE_Emax + DECSINGLE_Bias - (DECSINGLE_Pmax-1))
	49
	50	/* Required includes */
	51	#include "decContext.h"
	52	#include "decQuad.h"
	53	#include "decDouble.h"
	54
7bd36a9c	55	/* The decSingle decimal 32-bit type, accessible by all sizes */
4a44abab	56	typedef union {
7bd36a9c	57	uint8_t bytes[DECSINGLE_Bytes]; /* fields: 1, 5, 6, 20 bits */
4a44abab	58	uint16_t shorts[DECSINGLE_Bytes/2];
7bd36a9c	59	uint32_t words[DECSINGLE_Bytes/4];
2533577f JJ	60	} decSingle;
	61
	62	/* ---------------------------------------------------------------- */
	63	/* Routines -- implemented as decFloat routines in common files */
	64	/* ---------------------------------------------------------------- */
	65
	66	#include "decSingleSymbols.h"
	67
	68	/* Utilities (binary argument(s) or result, extractors, etc.) */
	69	extern decSingle * decSingleFromBCD(decSingle , int32_t, const uint8_t , int32_t);
	70	extern decSingle * decSingleFromPacked(decSingle , int32_t, const uint8_t );
7bd36a9c	71	extern decSingle * decSingleFromPackedChecked(decSingle , int32_t, const uint8_t );
2533577f JJ	72	extern decSingle * decSingleFromString(decSingle , const char , decContext *);
	73	extern decSingle * decSingleFromWider(decSingle , const decDouble , decContext *);
	74	extern int32_t decSingleGetCoefficient(const decSingle , uint8_t );
	75	extern int32_t decSingleGetExponent(const decSingle *);
	76	extern decSingle * decSingleSetCoefficient(decSingle , const uint8_t , int32_t);
	77	extern decSingle * decSingleSetExponent(decSingle , decContext , int32_t);
	78	extern void decSingleShow(const decSingle , const char );
	79	extern int32_t decSingleToBCD(const decSingle , int32_t , uint8_t *);
	80	extern char * decSingleToEngString(const decSingle , char );
	81	extern int32_t decSingleToPacked(const decSingle , int32_t , uint8_t *);
	82	extern char * decSingleToString(const decSingle , char );
	83	extern decDouble * decSingleToWider(const decSingle , decDouble );
	84	extern decSingle * decSingleZero(decSingle *);
	85
	86	/* (No Arithmetic routines for decSingle) */
	87
	88	/* Non-computational */
	89	extern uint32_t decSingleRadix(const decSingle *);
	90	extern const char * decSingleVersion(void);
	91
	92	/* decNumber conversions; these are implemented as macros so as not */
	93	/* to force a dependency on decimal32 and decNumber in decSingle. */
7bd36a9c	94	/* decSingleFromNumber returns a decimal32 * to avoid warnings. */
2533577f	95	#define decSingleToNumber(dq, dn) decimal32ToNumber((decimal32 *)(dq), dn)
7bd36a9c	96	#define decSingleFromNumber(dq, dn, set) decimal32FromNumber((decimal32 *)(dq), dn, set)
2533577f JJ	97
2533577f JJ	98	#endif