chiark / gitweb /
Version bump.
[catacomb] / prim.h
1 /* -*-c-*-
2  *
3  * $Id: prim.h,v 1.1 1999/12/22 15:58:59 mdw Exp $
4  *
5  * Finding primitive elements
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: prim.h,v $
33  * Revision 1.1  1999/12/22 15:58:59  mdw
34  * Search for primitive elements using prime-search equipment.
35  *
36  */
37
38 #ifndef CATACOMB_PRIM_H
39 #define CATACOMB_PRIM_H
40
41 #ifdef __cplusplus
42   extern "C" {
43 #endif
44
45 /*----- Header files ------------------------------------------------------*/
46
47 #include <stddef.h>
48
49 #ifndef CATACOMB_MP_H
50 #  include "mp.h"
51 #endif
52
53 #ifndef CATACOMB_MPMONT_H
54 #  include "mpmont.h"
55 #endif
56
57 #ifndef CATACOMB_PGEN_H
58 #  include "pgen.h"
59 #endif
60
61 /*----- Data structures ---------------------------------------------------*/
62
63 /* --- @prim_ctx@ --- *
64  *
65  * All fields must be configured by the client.  Set @n@ to zero to discover
66  * generators of the subgroup of order %$m / f$%.
67  */
68
69 typedef struct prim_ctx {
70   mpmont mm;                            /* Montgomery context for modulus */
71   mp *f;                                /* Array of factors */
72   size_t n;                             /* Number of factors */
73 } prim_ctx;
74
75 /*----- Functions provided ------------------------------------------------*/
76
77 /* --- @prim_test@ --- */
78
79 extern int prim_test(int /*rq*/, pgen_event */*ev*/, void */*p*/);
80
81 /* --- @prim_step@ --- */
82
83 extern int prim_step(int /*rq*/, pgen_event */*ev*/, void */*p*/);
84
85 /*----- That's all, folks -------------------------------------------------*/
86
87 #ifdef __cplusplus
88   }
89 #endif
90
91 #endif