Skip to content

Logical Implementation of Shor Algorithm - #12317

Open
joelkurien wants to merge 8 commits into
TheAlgorithms:masterfrom
joelkurien:joel_quantum
Open

joelkurien wants to merge 8 commits into
TheAlgorithms:masterfrom
joelkurien:joel_quantum

Conversation

@joelkurien

@joelkurien joelkurien commented Oct 29, 2024

Copy link
Copy Markdown

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper Bot added the tests are failing Do not merge until tests pass label Oct 29, 2024
@algorithms-keeper algorithms-keeper Bot added the awaiting reviews This PR is ready to be reviewed label Oct 29, 2024
@algorithms-keeper algorithms-keeper Bot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Oct 29, 2024

@priya-sundaram-dev priya-sundaram-dev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pure-Python Shor implementation @joelkurien — keeping it dependency-free is a good fit for the collection. A few issues to address before merge:

  1. Module docstring placement. The triple-quoted description sits after import math / import random, so Python doesn't treat it as the module docstring. Move it to the very top of the file, above the imports.
  2. Import-time side effects. shor = Shor() and print(shor.shor_algorithm(15)) run at module top level, so they execute on import (during test collection and DIRECTORY generation). Please move them under if __name__ == "__main__":, and add import doctest; doctest.testmod() there.
  3. Re-seeding inside the loop (bug). shor_algorithm calls random.seed(0) inside while True, so every iteration draws the same num; if that candidate never yields a factor, the loop spins forever. Seed once before the loop (or not at all) and let num vary across iterations.
  4. Minor: with the loop restructured, make sure the annotated -> tuple[int, int] return always holds (no implicit None fall-through).

Type hints and the period_find doctest are good — the above are the main blockers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviews This PR is ready to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants