chiark - git - mdw - catacomb/blob - mpw.h

   1 /* -*-c-*-
   2  *
   3  * $Id: mpw.h,v 1.2 1999/12/10 23:29:48 mdw Exp $
   4  *
   5  * Very low-level multiprecision definitions
   6  *
   7  * (c) 1999 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Catacomb.
  13  *
  14  * Catacomb is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * Catacomb is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with Catacomb; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: mpw.h,v $
  33  * Revision 1.2  1999/12/10 23:29:48  mdw
  34  * Change header file guard names.
  35  *
  36  * Revision 1.1  1999/11/13 01:52:34  mdw
  37  * Very low-level definitions for MP types.
  38  *
  39  * Revision 1.1  1999/11/13 01:50:17  mdw
  40  * Veyr low level definitions for MP types.
  41  *
  42  */
  43
  44 #ifndef CATACOMB_MPW_H
  45 #define CATACOMB_MPW_H
  46
  47 #ifdef __cplusplus
  48   extern "C" {
  49 #endif
  50
  51 /*----- Header files ------------------------------------------------------*/
  52
  53 #ifndef CATACOMB_BITS_H
  54 #  include <mLib/bits.h>
  55 #endif
  56
  57 #ifndef CATACOMB_MPTYPES_H
  58 #  include "mptypes.h"
  59 #endif
  60
  61 /*----- Useful macros -----------------------------------------------------*/
  62
  63 /* --- @MPW@ --- *
  64  *
  65  * Arguments:   @x@ = an unsigned value
  66  *
  67  * Use:         Expands to the value of @x@ masked and typecast to a
  68  *              multiprecision integer word.
  69  */
  70
  71 #define MPW(x) ((mpw)((x) & MPW_MAX))
  72
  73 /* --- @MPWS@ --- *
  74  *
  75  * Arguments:   @n@ = number of words
  76  *
  77  * Use:         Expands to the number of bytes occupied by a given number of
  78  *              words.
  79  */
  80
  81 #define MPWS(n) ((n) * sizeof(mpw))
  82
  83 /* --- @MPW_RQ@ --- *
  84  *
  85  * Arguments:   @sz@ = size of an octet array, in octets
  86  *
  87  * Use:         Expands to the number of @mpw@ words required to represent
  88  *              the number held in the octet array.
  89  */
  90
  91 #define MPW_RQ(sz) (((sz) * 8 + MPW_BITS - 1) / MPW_BITS)
  92
  93 /*----- That's all, folks -------------------------------------------------*/
  94
  95 #ifdef __cplusplus
  96   }
  97 #endif
  98
  99 #endif