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.

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

Consolidate binary exponentiation files #10742

Merged
merged 6 commits into from
Oct 21, 2023

Conversation

tianyizheng02
Copy link
Contributor

@tianyizheng02 tianyizheng02 commented Oct 21, 2023

Describe your change:

Contributes to #8098

Consolidated implementations of binary (modular) exponentiation into just binary_exponentiation.py

  • 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 enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Oct 21, 2023
"""
Compute a number raised by some quantity
Copy link
Member

Choose a reason for hiding this comment

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

Why remove this? exp is a bit cryptic in the function name and a line of documentation here is useful.

"""
Compute a number raised by some quantity
>>> binary_exponentiation(-1, 3)
>>> binary_exp_recursive(3, 5)
Copy link
Member

@cclauss cclauss Oct 21, 2023

Choose a reason for hiding this comment

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

What about tests for a=big number and n=big number, a=float, n=float?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can do, but the n=float case won't work because the algorithm can only compute integer powers

Copy link
Member

Choose a reason for hiding this comment

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

I know it won’t work but I wanted to see how it fails. Does it raise a ValueError? Does it behave like pow() does. Testing how things work if half the battle. Watching them fail is just as cool.

RESULT = binary_exponentiation(BASE, POWER)
print(f"{BASE}^({POWER}) : {RESULT}")
RESULT = binary_exp_recursive(BASE, POWER)
print(f"{BASE}^({POWER}): {RESULT}")
Copy link
Member

Choose a reason for hiding this comment

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

OPTIONAL: Adding a timeit benchmark would be a nice addition. Visitors love to see the side-by-side bakeoff.

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 21, 2023
@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 21, 2023
@tianyizheng02 tianyizheng02 merged commit 06edc0e into TheAlgorithms:master Oct 21, 2023
3 checks passed
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants