summaryrefslogtreecommitdiff
path: root/src/Simplex_tree/include/gudhi/Simplex_tree.h
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2022-04-12 14:35:06 +0200
committerGitHub <noreply@github.com>2022-04-12 14:35:06 +0200
commit59d4abce6ab249ac2bed82355a9930601cd3b77f (patch)
tree1be2105ef47c925ded72f67eb56d4f76665485ff /src/Simplex_tree/include/gudhi/Simplex_tree.h
parentdc5d417b3d2c2f6772389c1906455f041b796b37 (diff)
doc review
Co-authored-by: Marc Glisse <marc.glisse@inria.fr>
Diffstat (limited to 'src/Simplex_tree/include/gudhi/Simplex_tree.h')
-rw-r--r--src/Simplex_tree/include/gudhi/Simplex_tree.h11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h
index 82281cc4..5219d263 100644
--- a/src/Simplex_tree/include/gudhi/Simplex_tree.h
+++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h
@@ -302,17 +302,16 @@ class Simplex_tree {
Boundary_simplex_iterator(this));
}
- /** \brief Returns a range over the simplices of the boundary and its opposite vertex of a simplex.
+ /** \brief Given a simplex, returns a range over the simplices of its boundary and their opposite vertices.
*
- * The boundary and its opposite vertex of a simplex is the set of codimension \f$1\f$ subsimplices of the simplex.
+ * The boundary of a simplex is the set of codimension \f$1\f$ subsimplices of the simplex.
* If the simplex is \f$[v_0, \cdots ,v_d]\f$, with canonical orientation induced by \f$ v_0 < \cdots < v_d \f$, the
* iterator enumerates the simplices of the boundary in the order:
* \f$[v_0,\cdots,\widehat{v_i},\cdots,v_d]\f$ for \f$i\f$ from \f$0\f$ to \f$d\f$, where \f$\widehat{v_i}\f$ means
- * that the vertex \f$v_i\f$ is omitted from boundary, but returned as the second element of the pair, known as the
- * the opposite vertex of the boundary.
+ * that the vertex \f$v_i\f$, known as the opposite vertex, is omitted from boundary, but returned as the second element of a pair.
*
- * @param[in] sh Simplex for which the boundary and its opposite vertex is computed.
- * @return Iterator on a pair of SimplexHandle (a boundary) and a VertexHandle (its opposite vertex). */
+ * @param[in] sh Simplex for which the boundary is computed.
+ */
template<class SimplexHandle>
Boundary_opposite_vertex_simplex_range boundary_opposite_vertex_simplex_range(SimplexHandle sh) {
return Boundary_opposite_vertex_simplex_range(Boundary_opposite_vertex_simplex_iterator(this, sh),