summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Kraeutmann <kane@kane.cx>2018-08-07 15:42:13 +0200
committerDan Schult <dschult@colgate.edu>2018-08-07 09:42:13 -0400
commit078e9276ae949d8ed435022c0f2829222274dfed (patch)
tree40c8d562e0dd6d829c7a9d7f5812a6f7bd6e29d2 /doc
parentca654b6831bb5c4bebff94b4efe0be17c229fa28 (diff)
downloadnetworkx-078e9276ae949d8ed435022c0f2829222274dfed.tar.gz
LR planarity checking (#3040)
* LR planarity checking. Implements a near-linear Left-Right Planarity Test with planar embedding and optional counterexample certificate generation. Co-authored-by: David Kraeutmann <kane@kane.cx> Co-authored-by: Johannes Schulte <johannes.bernhard.schulte@rwth-aachen.de> Co-authored-by: Yassin Bahloul <yassin.bahloul@rwth-aachen.de> Co-authored-by: Dominik Meier <dominik.meier@rwth-aachen.de> * Implemented changes according to feedback. Changes include: - Removed recursion of LR-planarity algorithm - Added a PlanarEmbedding class - Improved Documentation - Lower RAM consumption Co-authored-by: David Kraeutmann <kane@kane.cx> Co-authored-by: Johannes Schulte <johannes.bernhard.schulte@rwth-aachen.de> Co-authored-by: Yassin Bahloul <yassin.bahloul@rwth-aachen.de> Co-authored-by: Dominik Meier <dominik.meier@rwth-aachen.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/algorithms/index.rst1
-rw-r--r--doc/reference/algorithms/planarity.rst11
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/reference/algorithms/index.rst b/doc/reference/algorithms/index.rst
index 1143b2c5..7dd34f3a 100644
--- a/doc/reference/algorithms/index.rst
+++ b/doc/reference/algorithms/index.rst
@@ -50,6 +50,7 @@ Algorithms
mis
node_classification
operators
+ planarity
reciprocity
rich_club
shortest_paths
diff --git a/doc/reference/algorithms/planarity.rst b/doc/reference/algorithms/planarity.rst
new file mode 100644
index 00000000..cad00dc8
--- /dev/null
+++ b/doc/reference/algorithms/planarity.rst
@@ -0,0 +1,11 @@
+*********
+Planarity
+*********
+
+.. automodule:: networkx.algorithms.planarity
+.. autosummary::
+ :toctree: generated/
+
+ check_planarity
+.. autoclass:: PlanarEmbedding
+ :members: \ No newline at end of file