Document point() in periodic triangulations

This commit is contained in:
Mael Rouxel-Labbé 2024-12-13 14:18:22 +01:00
parent 1bd0c37aad
commit da3cf10221
2 changed files with 30 additions and 0 deletions

View File

@ -593,6 +593,18 @@ public:
*/
Triangle triangle(const Periodic_triangle & t) const;
/*!
Equivalent to
the call `t.point(t.periodic_point(fh,i));`
*/
Point point(Face_handle fh, int i) const;
/*!
Equivalent to
the call `t.point(t.periodic_point(v));`
*/
Point point(Vertex_handle v) const;
/*!
Equivalent to
the call `t.segment(t.periodic_segment(f,i));`

View File

@ -551,6 +551,24 @@ size_type number_of_stored_facets() const;
/// `Periodic_triangle`, and `Periodic_tetrahedron`, which have inner type `Point`.
/// @{
/*!
Converts the `Periodic_point` `pp` (point-offset pair) to the
corresponding `Point` in \f$ \mathbb R^3\f$.
*/
Point point(const Periodic_point& pp) const;
/*!
Equivalent to
the call `t.point(t.periodic_point(v));`
*/
Point point(Vertex_handle v) const;
/*!
Equivalent to
the call `t.point(t.periodic_point(c,idx));`
*/
Point point(Cell_handle c, int idx) const;
/*!
Returns the periodic point given by vertex `v`. If `t` is
represented in the 1-sheeted covering space, the offset is always