Update docs.

mcmtroffaes · Sep 18, 2024 · badc20e · badc20e
1 parent 0a54568
commit badc20e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/cython/pycddlib.pxi b/cython/pycddlib.pxi
@@ -359,7 +359,10 @@ def matrix_canonicalize(mat: Matrix) -> tuple[Set[int], Set[int]]:
 
 
 def matrix_adjacency(mat: Matrix) -> Sequence[Set[int]]:
-    """Generate the adjacency facet/graph of a polyheron H/V-represented by *mat*.
+    """Generate the input adjacency of the polyhedron represented by *mat*.
+
+    H-representation: For each face, list adjacent faces.
+    V-representation: For each vertex, list adjacent vertices.
 
     .. note::
 
@@ -375,7 +378,10 @@ def matrix_adjacency(mat: Matrix) -> Sequence[Set[int]]:
     return _get_dd_setfam(dd_setfam)
 
 def matrix_weak_adjacency(mat: Matrix) -> Sequence[Set[int]]:
-    """Generate the weak-adjacency facet/graph of a polyheron H/V-represented by *mat*.
+    """Generate the weak input adjacency of the polyhedron represented by *mat*.
+
+    H-representation: For each face, list adjacent faces.
+    V-representation: For each vertex, list adjacent vertices.
 
     .. note::
 

diff --git a/docs/source/cdd.rst b/docs/source/cdd.rst
@@ -79,9 +79,14 @@ Functions
 ---------
 
 .. autofunction:: matrix_append_to
-.. autofunction:: matrix_canonicalize
 .. autofunction:: matrix_copy
 
+.. autofunction:: matrix_adjacency
+.. autofunction:: matrix_weak_adjacency
+
+.. autofunction:: matrix_canonicalize
+.. autofunction:: matrix_rank
+
 .. autofunction:: linprog_solve
 
 .. autofunction:: copy_input