clean docs

Author: Quentin18

examples/example7.c

@@ -1,12 +1,12 @@
 /**
  * @file example7.c
- * @brief Example 7: Simple operations with polynomial arithmetic in Fm[x]/P
+ * @brief Example 7: Simple operations with polynomial arithmetic in Fm[x]/(P)
  */
 #include <stdio.h>
 #include "modpolyp.h"
 
 /**
- * Simple operations with polynomial arithmetic in Fm[x]/P.
+ * Simple operations with polynomial arithmetic in Fm[x]/(P).
  */
 int main()
 {

examples/example8.c

@@ -1,12 +1,12 @@
 /**
  * @file example8.c
- * @brief Example 8: Advanced operations with polynomial arithmetic in Fm[x]/P
+ * @brief Example 8: Advanced operations with polynomial arithmetic in Fm[x]/(P)
  */
 #include <stdio.h>
 #include "modpolyp.h"
 
 /**
- * Advanced operations with polynomial arithmetic in Fm[x]/P.
+ * Advanced operations with polynomial arithmetic in Fm[x]/(P).
  */
 int main()
 {

lib/fps.h

@@ -19,3 +19,4 @@ typedef unsigned int prec;
 void fps_print(const fps s, prec n, char *name);
 int fps_is_invertible(const fps s);
 void fps_newton_inverse(const fps s, prec n, fps u, modulus m);
+/* void fps_hensel_lifting(const fps s, const polynomial p, prec n); */   /* TODO */

lib/modpolyp.c

@@ -1,6 +1,6 @@
 /**
  * @file modpolyp.c
- * @brief Polynomial arithmetic implementation in Fm[x]/P
+ * @brief Polynomial arithmetic implementation in Fm[x]/(P)
  */
 #include <stdio.h>
 #include <stdlib.h>
@@ -9,13 +9,13 @@
 #include "extendedGcdPoly.h"
 
 /**
- * Computes r = (p + q) in Fm[x]/P.
+ * Computes r = (p + q) in Fm[x]/(P).
  * 
  * @param p first polynomial
  * @param dp degree of p
  * @param q second polynomial
  * @param dq degree of q
- * @param r polynomial (p + q) in Fm[x]/P
+ * @param r polynomial (p + q) in Fm[x]/(P)
  * @param m modulus for coefficients
  * @param P modulus polynomial
  * @param dP degree of P
@@ -31,13 +31,13 @@ degree mpp_add(const polynomial p, degree dp, const polynomial q, degree dq, pol
 }
 
 /**
- * Computes r = (p - q) in Fm[x]/P.
+ * Computes r = (p - q) in Fm[x]/(P).
  * 
  * @param p first polynomial
  * @param dp degree of p
  * @param q second polynomial
  * @param dq degree of q
- * @param r polynomial (p - q) in Fm[x]/P
+ * @param r polynomial (p - q) in Fm[x]/(P)
  * @param m modulus for coefficients
  * @param P modulus polynomial
  * @param dP degree of P
@@ -53,13 +53,13 @@ degree mpp_sub(const polynomial p, degree dp, const polynomial q, degree dq, pol
 }
 
 /**
- * Computes r = (p * q) in Fm[x]/P.
+ * Computes r = (p * q) in Fm[x]/(P).
  * 
  * @param p first polynomial
  * @param dp degree of p
  * @param q second polynomial
  * @param dq degree of q
- * @param r polynomial (p * q) in Fm[x]/P
+ * @param r polynomial (p * q) in Fm[x]/(P)
  * @param m modulus for coefficients
  * @param P modulus polynomial
  * @param dP degree of P
@@ -75,11 +75,11 @@ degree mpp_mul(const polynomial p, degree dp, const polynomial q, degree dq, pol
 }
 
 /**
- * Computes r = p^-1 in Fm[x]/P.
+ * Computes r = p^-1 in Fm[x]/(P).
  *
  * @param p polynomial
  * @param dp degree of p
- * @param r polynomial p^-1 in Fm[x]/P
+ * @param r polynomial p^-1 in Fm[x]/(P)
  * @param m modulus for coefficients
  * @param P modulus polynomial
  * @param dP degree of P
@@ -115,13 +115,13 @@ degree mpp_inv(const polynomial p, degree dp, polynomial r, modulus m, const pol
 }
 
 /**
- * Computes r = (p / q) in Fm[x]/P.
+ * Computes r = (p / q) in Fm[x]/(P).
  * 
  * @param p first polynomial
  * @param dp degree of p
  * @param q second polynomial
  * @param dq degree of q
- * @param r polynomial (p / q) in Fm[x]/P
+ * @param r polynomial (p / q) in Fm[x]/(P)
  * @param m modulus for coefficients
  * @param P modulus polynomial
  * @param dP degree of P

lib/modpolyp.h

@@ -1,6 +1,6 @@
 /**
  * @file modpolyp.h
- * @brief Header file for polynomial arithmetic in Fm[x]/P
+ * @brief Header file for polynomial arithmetic in Fm[x]/(P)
  */
 #pragma once