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

   1 /* -*-c-*-
   2  *
   3  * $Id: mp-misc.c,v 1.2 2000/06/17 11:45:09 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.2  2000/06/17 11:45:09  mdw
  34  * Major memory management overhaul.  Added arena support.  Use the secure
  35  * arena for secret integers.  Replace and improve the MP management macros
  36  * (e.g., replace MP_MODIFY by MP_DEST).
  37  *
  38  * Revision 1.1  1999/11/17 18:02:16  mdw
  39  * New multiprecision integer arithmetic suite.
  40  *
  41  */
  42
  43 /*----- Header files ------------------------------------------------------*/
  44
  45 #include "mp.h"
  46
  47 /*----- Basic manipulation ------------------------------------------------*/
  48
  49 /* --- @mp_shrink@ --- *
  50  *
  51  * Arguments:   @mp *m@ = pointer to a multiprecision integer
  52  *
  53  * Returns:     ---
  54  *
  55  * Use:         Reduces the recorded length of an integer.  This doesn't
  56  *              reduce the amount of memory used, although it can improve
  57  *              performance a bit.  To reduce memory, use @mp_minimize@
  58  *              instead.  This can't change the value of an integer, and is
  59  *              therefore safe to use even when there are multiple
  60  *              references.
  61  */
  62
  63 void mp_shrink(mp *m) { MP_SHRINK(m); }
  64
  65 /* --- @mp_minimize@ --- *
  66  *
  67  * Arguments:   @mp *m@ = pointer to a multiprecision integer
  68  *
  69  * Returns:     ---
  70  *
  71  * Use:         Reduces the amount of memory an integer uses.  It's best to
  72  *              do this to numbers which aren't going to change in the
  73  *              future.
  74  */
  75
  76 void mp_minimize(mp *m)
  77 {
  78   MP_SHRINK(m);
  79   MP_RESIZE(m, MP_LEN(m));
  80 }
  81
  82 /*----- Bit scanning ------------------------------------------------------*/
  83
  84 /* --- @mp_scan@ --- *
  85  *
  86  * Arguments:   @mpscan *sc@ = pointer to bitscanner block
  87  *              @const mp *m@ = pointer to a multiprecision integer
  88  *
  89  * Returns:     ---
  90  *
  91  * Use:         Initializes a bitscanner on a multiprecision integer.
  92  */
  93
  94 void mp_scan(mpscan *sc, const mp *m) { MP_SCAN(sc, m); }
  95
  96 /*----- That's all, folks -------------------------------------------------*/