hashsum.1: Write some notes about compatibility with GNU Coreutils.
[u/mdw/catacomb] / mp-misc.c
index 840f947..90bdc37 100644 (file)
--- a/mp-misc.c
+++ b/mp-misc.c
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: mp-misc.c,v 1.2 2000/06/17 11:45:09 mdw Exp $
+ * $Id: mp-misc.c,v 1.4 2004/04/08 01:36:15 mdw Exp $
  *
  * Miscellaneous multiprecision support functions
  *
  * (c) 1999 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Catacomb.
  *
  * it under the terms of the GNU Library General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
- * 
+ *
  * Catacomb 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 Library General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Library General Public
  * License along with Catacomb; if not, write to the Free
  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: mp-misc.c,v $
- * Revision 1.2  2000/06/17 11:45:09  mdw
- * Major memory management overhaul.  Added arena support.  Use the secure
- * arena for secret integers.  Replace and improve the MP management macros
- * (e.g., replace MP_MODIFY by MP_DEST).
- *
- * Revision 1.1  1999/11/17 18:02:16  mdw
- * New multiprecision integer arithmetic suite.
- *
- */
-
 /*----- Header files ------------------------------------------------------*/
 
 #include "mp.h"
@@ -93,4 +80,17 @@ void mp_minimize(mp *m)
 
 void mp_scan(mpscan *sc, const mp *m) { MP_SCAN(sc, m); }
 
+/* --- @mp_scan@ --- *
+ *
+ * Arguments:  @mpscan *sc@ = pointer to bitscanner block
+ *             @const mp *m@ = pointer to a multiprecision integer
+ *
+ * Returns:    ---
+ *
+ * Use:                Initializes a reverse bitscanner on a multiprecision
+ *             integer.
+ */
+
+void mp_rscan(mpscan *sc, const mp *m) { MP_RSCAN(sc, m); }
+
 /*----- That's all, folks -------------------------------------------------*/