doc

src/Persistence_matrix/concept/FieldOperators.h

@@ -42,7 +42,8 @@ class FieldOperators
   FieldOperators(characteristic_type characteristic = 0);
 
   /**
-   * @brief Sets the characteristic of the field.
+   * @brief Sets the characteristic of the field. Can eventually be omitted if the characteristic of the class
+   * is fixed.
    * 
    * @param characteristic Prime number corresponding to the desired characteristic of the field.
    */
@@ -107,8 +108,8 @@ class FieldOperators
   //  * Returns the result in the field.
   //  * 
   //  * @param e First element.
-  //  * @param m Second element.
-  //  * @param a Third element.
+  //  * @param a Second element.
+  //  * @param m Third element.
   //  * @return `((e + a) * m) % characteristic`, such that the result is positive.
   //  */
   // element_type add_and_multiply(element_type e, element_type a, element_type m) const;

src/Persistence_matrix/doc/Intro_field_elements_and_operators.h

@@ -17,10 +17,20 @@ namespace persistence_fields {
 
 /** \defgroup persistence_fields Persistence Fields
  * @{
- * \author    Hannah Schreiber
+ * \author    Hannah Schreiber, Clément Maria
  *
- * TODO:
- * 
+ * Set of classes allowing addition and multiplication, as well as inverse computation, in \f$ \mathbb{F}_p \f$ fields,
+ * with \f$ p \f$ some prime number, or in multi-fields as defined in \cite boissonnat:hal-00922572.
+ *
+ * There are two types of classes:
+ * - those defining directly a field element, allowing to use them as any integer: the operators are overwritten such
+ *   that the calculation is done in the field. For example, if \f$ e = 2 \f$ is an instanciation of an
+ *   \f$ \mathbb{F}_3 \f$ element class, then `e + 3` returns `2`,
+ * - those only defining the operators of a field or multi-field. They represent a collection of methods taking
+ *   one or two integers as input and treating them as elements of the field. For example, if \f$ op \f$ is an
+ *   instanciation of a \f$ \mathbb{F}_3 \f$ operator class, `op.add(2, 3)` returns `2`.
+ *
+ * The field operator classes all respect the @ref persistence_matrix::FieldOperators concept.
  * 
  * \subsection fieldsexamples Examples
  *