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

   1 /* -*-c-*-
   2  *
   3  * $Id: mp-misc.c,v 1.4 2004/04/08 01:36:15 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 /*----- Header files ------------------------------------------------------*/
  31
  32 #include "mp.h"
  33
  34 /*----- Basic manipulation ------------------------------------------------*/
  35
  36 /* --- @mp_shrink@ --- *
  37  *
  38  * Arguments:   @mp *m@ = pointer to a multiprecision integer
  39  *
  40  * Returns:     ---
  41  *
  42  * Use:         Reduces the recorded length of an integer.  This doesn't
  43  *              reduce the amount of memory used, although it can improve
  44  *              performance a bit.  To reduce memory, use @mp_minimize@
  45  *              instead.  This can't change the value of an integer, and is
  46  *              therefore safe to use even when there are multiple
  47  *              references.
  48  */
  49
  50 void mp_shrink(mp *m) { MP_SHRINK(m); }
  51
  52 /* --- @mp_minimize@ --- *
  53  *
  54  * Arguments:   @mp *m@ = pointer to a multiprecision integer
  55  *
  56  * Returns:     ---
  57  *
  58  * Use:         Reduces the amount of memory an integer uses.  It's best to
  59  *              do this to numbers which aren't going to change in the
  60  *              future.
  61  */
  62
  63 void mp_minimize(mp *m)
  64 {
  65   MP_SHRINK(m);
  66   MP_RESIZE(m, MP_LEN(m));
  67 }
  68
  69 /*----- Bit scanning ------------------------------------------------------*/
  70
  71 /* --- @mp_scan@ --- *
  72  *
  73  * Arguments:   @mpscan *sc@ = pointer to bitscanner block
  74  *              @const mp *m@ = pointer to a multiprecision integer
  75  *
  76  * Returns:     ---
  77  *
  78  * Use:         Initializes a bitscanner on a multiprecision integer.
  79  */
  80
  81 void mp_scan(mpscan *sc, const mp *m) { MP_SCAN(sc, m); }
  82
  83 /* --- @mp_scan@ --- *
  84  *
  85  * Arguments:   @mpscan *sc@ = pointer to bitscanner block
  86  *              @const mp *m@ = pointer to a multiprecision integer
  87  *
  88  * Returns:     ---
  89  *
  90  * Use:         Initializes a reverse bitscanner on a multiprecision
  91  *              integer.
  92  */
  93
  94 void mp_rscan(mpscan *sc, const mp *m) { MP_RSCAN(sc, m); }
  95
  96 /*----- That's all, folks -------------------------------------------------*/