3 * $Id: mpscan.c,v 1.1 1999/09/03 08:41:12 mdw Exp $
5 * Sequential bit scan of multiprecision integers
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
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.
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.
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,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.1 1999/09/03 08:41:12 mdw
38 /*----- Header files ------------------------------------------------------*/
40 /*----- Data structures ---------------------------------------------------*/
42 /*----- Static variables --------------------------------------------------*/
44 /*----- Main code ---------------------------------------------------------*/
46 /* --- @mpscan_initx@ --- *
48 * Arguments: @mpscan *m@ = pointer to bitscanner structure
49 * @const mpw *v@ = vector of words to scan
50 * @size_t len@ = length of vector in words
54 * Use: Initializes a bitscanner from a low-level vector-and-length
55 * representation of an integer. Initially no bit is ready; you
56 * must call @mpscan_step@ before anything useful will come
60 void mpscan_initx(mpscan
*m
, const mpw
*v
, size_t len
)
62 MPSCAN_INITX(m
, v
, len
);
65 /* --- @mpscan_step@ --- *
67 * Arguments: @mpscan *m@ = pointer to bitscanner
69 * Returns: Nonzero if there is another bit to read.
71 * Use: Steps on to the next bit in the integer. The macro version
72 * evaluates its argument multiple times.
75 int mpscan_step(mpscan
*m
) { return (MPSCAN_STEP(m
)); }
77 /* --- @mpscan_bit@ --- *
79 * Arguments: @const mpscan *m@ = pointer to bitscanner
81 * Returns: The value of the current bit.
83 * Use: Reads the value of the current bit looked at by a
87 int mpscan_bit(const mpscan
*m
) { return (MPSCAN_BIT(m
)); }
89 /*----- That's all, folks -------------------------------------------------*/