factorial: Fix usage message to fit in with conventions.

[u/mdw/catacomb] / mptext.h

diff --git a/mptext.h b/mptext.h
index db4e591..fe89946 100644 (file)
--- a/mptext.h
+++ b/mptext.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: mptext.h,v 1.5 2000/10/08 12:04:58 mdw Exp $
+ * $Id$
  *
  * Textual representation of multiprecision numbers
  *
@@ -27,27 +27,6 @@
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: mptext.h,v $
- * Revision 1.5  2000/10/08 12:04:58  mdw
- * (MP_DOFPRINTFR): cope with null pointers.
- *
- * Revision 1.4  2000/06/17 11:46:58  mdw
- * Convenience macros for producing debugging output containing MP
- * integers.
- *
- * Revision 1.3  1999/12/22 15:56:30  mdw
- * Make the buffer passed to `put' op constant.
- *
- * Revision 1.2  1999/12/10 23:29:48  mdw
- * Change header file guard names.
- *
- * Revision 1.1  1999/11/17 18:02:16  mdw
- * New multiprecision integer arithmetic suite.
- *
- */
-
 #ifndef CATACOMB_MPTEXT_H
 #define CATACOMB_MPTEXT_H
 
@@ -107,6 +86,20 @@ extern mp *mp_read(mp */*m*/, int /*radix*/,
 extern int mp_write(mp */*m*/, int /*radix*/,
                    const mptext_ops */*ops*/, void */*p*/);
 
+/* --- @mptext_len@ --- *
+ *
+ * Arguments:  @mp *x@ = number to work on
+ *             @int r@ = radix the number will be expressed in
+ *
+ * Returns:    The number of digits needed to represent the number in the
+ *             given base.  This will not include space for a leading sign
+ *             (use @MP_NEGP@ to check that, or just add one on for luck);
+ *             neither will it add space for a terminating null.  In general
+ *             the answer will be an overestimate.
+ */
+
+extern size_t mptext_len(mp */*x*/, int /*r*/);
+
 /*----- File I/O ----------------------------------------------------------*/
 
 #include <stdio.h>