diff options
Diffstat (limited to 'src/misc/config.h')
| -rw-r--r-- | src/misc/config.h | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/src/misc/config.h b/src/misc/config.h index fe792d5..84ee025 100644 --- a/src/misc/config.h +++ b/src/misc/config.h @@ -33,44 +33,71 @@ typedef enum { SEED_FIPS } seed_e; +/** + * @brief + */ typedef struct { + /** @brief What field should the curves be generated over. */ enum field_e field; bool binary_field; bool prime_field; + /** @brief How many curves should be generater. */ long count; + /** @brief Whether the curves should be generated at random (no input). */ bool random; + /** @brief Whether the curves should have prime order. */ bool prime; + /** @brief Whether the curves should be generated as invalid, for some curve. */ bool invalid; + /** @brief Whether the Complex Multiplication method should be used. */ bool cm; char *order; + /** @brief Whether the curves should be trace one (Anomalous). */ bool anomalous; + /** @brief Whether the curves should be Koblitz (a \\in {0, 1}, b = 1). */ bool koblitz; long koblitz_value; + /** @brief Whether the curves should have a bound on the cofactor value. */ bool cofactor; long cofactor_bound; + /** @brief What seed algorithm, if any, to use to generate the curves. */ seed_e seed_algo; + /** @brief What seed to use, if any, to generate the curves. */ char *seed; + /** @brief Whether the curves should be uniquely generated (one generator). */ bool unique; + /** @brief What points to generate on the curves. */ struct points_s points; + /** @brief The datadir to use, if any. */ char *datadir; + /** @brief How much memory to allocate for the PARI stack. */ unsigned long memory; + /** @brief How many threads to use, only useful for invalid generation(atm). */ unsigned long threads; + /** @brief How much memory to allocate for the PARI stack, per thread. */ unsigned long thread_memory; + /** @brief How long of a timeout interval, if any, to give to parameter generation. */ unsigned long timeout; + /** @brief What output format to use. */ enum format_e format; + /** @brief What, if any, output file to write to. */ char *output; + /** @brief What, if any, input file to read from. */ char *input; + /** @brief Whether to append or truncate the output file on output. */ bool append; + /** @brief What verbosity level to run on. */ long verbose; + /** @brief What file, if any, to write the verbose messages. */ char *verbose_log; + /** @brief The size of the field to generate curves over, in bits. */ unsigned long bits; unsigned long hex_digits; - } config_t; #endif // ECGEN_CONFIG_H |