chiark - git - mdw - catacomb/blob - mp-misc.c

   1 /* -*-c-*-
   2  *
   3  * $Id: mp-misc.c,v 1.1 1999/11/17 18:02:16 mdw Exp $
   4  *
   5  * Miscellaneous multiprecision support functions
   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: mp-misc.c,v $
  33  * Revision 1.1  1999/11/17 18:02:16  mdw
  34  * New multiprecision integer arithmetic suite.
  35  *
  36  */
  37
  38 /*----- Header files ------------------------------------------------------*/
  39
  40 #include "mp.h"
  41
  42 /*----- Paranoia management -----------------------------------------------*/
  43
  44 /* --- @mp_burn@ --- *
  45  *
  46  * Arguments:   @mp *m@ = pointer to a multiprecision integer
  47  *
  48  * Returns:     ---
  49  *
  50  * Use:         Marks the integer as `burn-after-use'.  When the integer's
  51  *              memory is deallocated, it is deleted so that traces can't
  52  *              remain in the swap file.  In theory.
  53  */
  54
  55 void mp_burn(mp *m)
  56 {
  57   m->f |= MP_BURN;
  58 }
  59
  60 /*----- Basic manipulation ------------------------------------------------*/
  61
  62 /* --- @mp_shrink@ --- *
  63  *
  64  * Arguments:   @mp *m@ = pointer to a multiprecision integer
  65  *
  66  * Returns:     ---
  67  *
  68  * Use:         Reduces the recorded length of an integer.  This doesn't
  69  *              reduce the amount of memory used, although it can improve
  70  *              performance a bit.  To reduce memory, use @mp_minimize@
  71  *              instead.  This can't change the value of an integer, and is
  72  *              therefore safe to use even when there are multiple
  73  *              references.
  74  */
  75
  76 void mp_shrink(mp *m) { MP_SHRINK(m); }
  77
  78 /* --- @mp_minimize@ --- *
  79  *
  80  * Arguments:   @mp *m@ = pointer to a multiprecision integer
  81  *
  82  * Returns:     ---
  83  *
  84  * Use:         Reduces the amount of memory an integer uses.  It's best to
  85  *              do this to numbers which aren't going to change in the
  86  *              future.
  87  */
  88
  89 void mp_minimize(mp *m)
  90 {
  91   MP_SHRINK(m);
  92   MP_RESIZE(m, MP_LEN(m));
  93 }
  94
  95 /*----- Bit scanning ------------------------------------------------------*/
  96
  97 /* --- @mp_scan@ --- *
  98  *
  99  * Arguments:   @mpscan *sc@ = pointer to bitscanner block
 100  *              @const mp *m@ = pointer to a multiprecision integer
 101  *
 102  * Returns:     ---
 103  *
 104  * Use:         Initializes a bitscanner on a multiprecision integer.
 105  */
 106
 107 void mp_scan(mpscan *sc, const mp *m) { MP_SCAN(sc, m); }
 108
 109 /*----- That's all, folks -------------------------------------------------*/