Skip to content

Commit

Permalink
Update documentation in the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
giove91 committed Aug 4, 2020
1 parent b8d35fa commit 071fc25
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,14 +295,15 @@ All subclasses of `ArithmeticMatroidMixin` also (re-)implement the following met
Check if the given integer matrix `A` is a representation of the matroid.
The optional parameter `ordered_groundset` specifies the bijection between the columns of the matrix and the groundset.

* `all_representations(ordered_groundset=None)`
* `all_representations(ordered_groundset=None, shnf=True)`
Generator of all non-equivalent essential representations of the matroid, computed using the algorithm of [PP19, Section 5].
If `shnf=True`, the output matrices are guaranteed to be in signed Hermite normal form [PP19, Section 6].

* `num_representations()`
Return the number of non-equivalent essential representations of the matroid.
This calls `all_representations()`.

* `representation(ordered_groundset=None)`
* `representation(ordered_groundset=None, shnf=True)`
Return any essential representation of the matroid, or `None` if the matroid is not representable.

* `is_representable()`
Expand Down

0 comments on commit 071fc25

Please sign in to comment.