code review: specify sqrt in SimplicialComplexForAlpha concept

GUDHI · Feb 14, 2025 · 021561a · 021561a
1 parent 404cb39
commit 021561a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/Alpha_complex/concept/SimplicialComplexForAlpha.h b/src/Alpha_complex/concept/SimplicialComplexForAlpha.h
@@ -23,7 +23,9 @@ struct SimplicialComplexForAlpha {
   typedef unspecified Simplex_handle;
   /** Handle to specify a vertex. Must be a non-negative integer. */
   typedef unspecified Vertex_handle;
-  /** Simplex filtration value type. Must be capable to represent the special value "Not-A-Number"*/
+  /** Simplex filtration value type. Must be capable to represent the special value "Not-A-Number".
+    * If a specific filtration value type is provided, and `output_squared_values` is set to `false`, you may have to
+    * provide an `sqrt` methods that fits your needs.*/
   typedef unspecified Filtration_value;
 
   /** Returns the number of vertices in the simplicial complex. */