Skip to content
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

Add generators module #121

Merged
merged 6 commits into from
Aug 26, 2020
Merged

Add generators module #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0c0bc9f
Add generators module
mtreinish Aug 20, 2020
efb93cb
Merge branch 'master' into add-generators
mtreinish Aug 25, 2020
4428c93
Merge branch 'master' into add-generators
mtreinish Aug 25, 2020
e6ba1ac
Merge branch 'master' into add-generators
mtreinish Aug 25, 2020
bce9502
Add additional assert that directed path isn't a cycle
mtreinish Aug 25, 2020
745dcaf
Update test names
mtreinish Aug 26, 2020
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
13 changes: 13 additions & 0 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,19 @@ Graph Classes
retworkx.PyDiGraph
retworkx.PyDAG

Generators
----------

.. autosummary::
:toctree: stubs

retworkx.generators.cycle_graph
retworkx.generators.directed_cycle_graph
retworkx.generators.path_graph
retworkx.generators.directed_path_graph
retworkx.generators.star_graph
retworkx.generators.directed_star_graph

Random Circuit Functions
------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ retworkx Documentation
Contents:

.. toctree::
:maxdepth: 2
:maxdepth: 3

README
Retworkx API <api>
Expand Down
3 changes: 3 additions & 0 deletions retworkx/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

import sys

from .retworkx import *
sys.modules['retworkx.generators'] = generators


class PyDAG(PyDiGraph):
Expand Down
Loading