Skip to content

week5: planarFaces #578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sakirr05 merged 2 commits into from
Jun 29, 2026
Merged

week5: planarFaces #578

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2bc567
empty commit
Jun 23, 2026
00f8509
Clarify pgr_planarFaces explanation and fix row-count wording
Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions doc/planar/pgr_planarFaces.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The main characteristics are:
* Uses Boost ``planar_face_traversal`` with a custom visitor.
* Returns one row per edge-face incidence: each undirected edge appears exactly
twice (once per side).
* Each vertex belongs to the graph; the result contains :math:`2|E|` rows.
* The result contains :math:`2|E|` rows when the graph has :math:`|E|` edges.
* The graph must be planar; a non-planar graph produces an error.
* Use :doc:`pgr_isPlanar` first when planarity is unknown.
* Applicable only for **undirected** graphs.
Expand Down Expand Up @@ -71,10 +71,11 @@ Signatures

.. rubric:: Explanation

* The sample graph is planar, so face extraction succeeds.
* Multiple faces are returned; ``face_id`` identifies each face in the embedding.
* The sample graph is planar, so face extraction succeeds without error.
* Multiple faces are returned; ``face_id`` identifies each face in the embedding,
including the unbounded exterior face.
* Each edge appears twice in the result, once with ``side = 'l'`` and once with
``side = 'r'``.
``side = 'r'``, following the counterclockwise traversal of the embedding.

Parameters
-------------------------------------------------------------------------------
Expand Down