diff options
Diffstat (limited to 'src/math/poly.h')
| -rw-r--r-- | src/math/poly.h | 30 |
1 files changed, 20 insertions, 10 deletions
diff --git a/src/math/poly.h b/src/math/poly.h index 83b909a..89061ce 100644 --- a/src/math/poly.h +++ b/src/math/poly.h @@ -11,6 +11,9 @@ #include <pari/pari.h> #include <stdbool.h> +/** + * @brief + */ typedef struct { unsigned int m; unsigned int e1; @@ -19,30 +22,37 @@ typedef struct { } polynomial_t; /** + * @brief Whether a polynomial exists in the polynomial data with degree + * <code>m</code>. * - * @param m - * @return + * @param m the degree of the polynomial searched + * @return whether it exists */ bool poly_exists(unsigned long m); + /** + * @brief Find a polynomial of degree <code>m</code> in the polynomial dataset. * - * @param m - * @return + * @param m the degree of the polynomial searched + * @return the polynomial_t * inside the polynomial dataset */ polynomial_t *poly_find(unsigned long m); /** + * @brief Turn a polynomial_t into a GEN. * - * @param m - * @return + * @param polynomial the polynomial_t to convert + * @return a t_POL equal to the polynomial */ -GEN poly_find_gen(unsigned long m); +GEN poly_gen(const polynomial_t *polynomial); /** + * @brief Find a polynomial of degree <code>m</code> and turn it into a GEN. * - * @param polynomial - * @return + * @see poly_gen + * @param m the degree of the polynomial searched + * @return a t_POL equal to the polynomial */ -GEN poly_gen(const polynomial_t *polynomial); +GEN poly_find_gen(unsigned long m); #endif // ECGEN_POLY_H |