doc corrections

src/Zigzag_persistence/doc/Intro_zigzag_persistence.h

@@ -66,15 +66,18 @@ namespace zigzag_persistence {
  * If \f$ P \f$ is the set of points generating the Rips filtration, \f$ P_i \f$ corresponds to the subset containing
  * the \f$ i \f$ first points. So, at each forward inclusion, one vertex is added.
  *
- * The superscript of \f$ \mathcal{R} \f$ corresponds to the filtration values which will be associated to the cycles.
- * The sequence of \f$ \varepsilon \f$ should be decreasing and end with \f$ 0 \f$. The sequence can either be specified
- * by the user or automatically generated by choosing the distance of the added point from the other already added
- * points from the set. In the second case, the user has to specify how the order of the points should be decided.
+ * The superscript of \f$ \mathcal{R} \f$ corresponds to a sequence of \f$ \varepsilon \f$ which should be decreasing
+ * and end with \f$ 0 \f$. The sequence can either be specified by the user or automatically generated by choosing
+ * the distance of the added point from the other already added points from the set. In the second case, the user has
+ * to specify how the order of the points should be decided.
  *
  * The subscript of \f$ \mathcal{R} \f$ corresponds like usual to the radius of the Rips complex. It is generated from
- * the current epsilon / filtration value by multiplying it alternatively by two coefficients: \f$ \nu \leqslant \mu \f$.
+ * the current epsilon value by multiplying it alternatively by two coefficients: \f$ \nu \leqslant \mu \f$.
  * Both multipliers have to be specified by the user.
  *
+ * As filtration values for the simplices, the module chooses the epsilon value "active" at the moment of insertion or
+ * removal.
+ *
  * The construction is based on two types of classes:
  * - @ref Oscillating_rips_edge_iterator_range and @ref Oscillating_rips_edge_vector_range_constructor computes the
  * range of inserted and removed vertices and edges in the filtration based on the elements described above.
@@ -86,6 +89,10 @@ namespace zigzag_persistence {
  * can potentially pass any other type of edge range as long as the dereferenced format corresponds and the sequence
  * makes sense as a zigzag filtration.
  *
+ * Both _*_iterator_range*_ and _*_vector_range*_ methods are computing the same, they differ just on their
+ * storing strategy: _*_iterator_range*_ methods are always computing the edges/simplices on the fly at each iteration
+ * while the _*_vector_range*_ methods compute everything at once and store the computed edges/simplices in a vector.
+ *
  * If only the barcode of the filtration is of interest and not the filtration itself, the helper method
  * @ref compute_oscillating_rips_persistence can be used. It will directly feed to the filtration constructed by the
  * two classes above into @ref Zigzag_persistence "".

src/Zigzag_persistence/example/example_usage_filtered_zigzag_persistence.cpp

@@ -25,7 +25,7 @@ int main() {
   });
 
   // It is important that the operations of insertions and removals are made **in the same order** as in the zigzag
-  // filtration ones wants to compute the barcode from.
+  // filtration one wants to compute the barcode from.
   // A cell can be identified in the boundaries by any given numerical label, it is just important that the given
   // filtration values are monotonous (ie., either only increasing or only decreasing).
 

src/Zigzag_persistence/example/example_usage_filtered_zigzag_persistence_with_storage.cpp

@@ -20,7 +20,7 @@ int main() {
   Zigzag_persistence zp;
 
   // It is important that the operations of insertions and removals are made **in the same order** as in the zigzag
-  // filtration ones wants to compute the barcode from.
+  // filtration one wants to compute the barcode from.
   // A cell can be identified in the boundaries by any given numerical label, it is just important that the given
   // filtration values are monotonous (ie., either only increasing or only decreasing).
 

src/Zigzag_persistence/example/example_usage_zigzag_persistence.cpp

@@ -25,7 +25,7 @@ int main() {
   });
 
   // It is important that the operations of insertions and removals are made **in the same order** as in the zigzag
-  // filtration ones wants to compute the barcode from.
+  // filtration one wants to compute the barcode from.
   // A cell has to be identified in the boundaries by the operation number the cell was inserted with in the sequence.
 
   // inserts vertex 0 -> birth at 0 of 0-cycle

src/Zigzag_persistence/include/gudhi/Zigzag_persistence/oscillating_rips_edge_ranges.h

@@ -582,7 +582,7 @@ class Oscillating_rips_edge_iterator_range
    * gudhi/Zigzag_persistence/oscillating_rips_edge_ranges.h
    * @brief Custom iterator over the edges of an oscillating rips filtration.
    *
-   * It inherits from boost::iterator_facade.
+   * Category: LegacyInputIterator. And it inherits from boost::iterator_facade.
    *
    * @warning Each **copy** of the same iterator is pointing to the same base and will therefore update
    * **simultaneously**. This is to make the iterators copyable in the first place. If each copy would have its own

src/Zigzag_persistence/include/gudhi/Zigzag_persistence/oscillating_rips_simplex_ranges.h

@@ -371,7 +371,7 @@ class Oscillating_rips_simplex_iterator_range
    * gudhi/Zigzag_persistence/oscillating_rips_simplex_ranges.h
    * @brief Custom iterator over the simplices of an oscillating rips filtration.
    *
-   * It inherits from boost::iterator_facade.
+   * Category: LegacyInputIterator. And it inherits from boost::iterator_facade.
    *
    * @warning Each **copy** of the same iterator is pointing to the same base and will therefore update
    * **simultaneously**. This is to make the iterators copyable in the first place. If each copy would have its own