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

Jump to bottom

Added Fast Inverse Square Root #11054

Merged
merged 8 commits into from
Oct 29, 2023
Merged

Added Fast Inverse Square Root #11054

merged 8 commits into from
Oct 29, 2023

Conversation

aryanshb
Copy link
Contributor

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 require descriptive names This PR needs descriptive function and/or variable names label Oct 28, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 28, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass labels Oct 28, 2023
cclauss
cclauss reviewed Oct 29, 2023
View reviewed changes
cclauss
cclauss reviewed Oct 29, 2023
View reviewed changes
maths/fast_inverse_sqrt.py Outdated
Comment on lines 20 to 24
>>> fastInvSqrt(10)
0.3156857923527257

>>> fastInvSqrt(4)
0.49915357479239103
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
>>> fastInvSqrt(10)
0.3156857923527257
>>> fastInvSqrt(4)
0.49915357479239103
>>> fast_inverse_sqrt(10)
0.3156857923527257
>>> fast_inverse_sqrt(4)
0.49915357479239103
>>> fast_inverse_sqrt(0)
???
>>> fast_inverse_sqrt(-4)
???
>>> fast_inverse_sqrt(4.1)
???
>>> from math import sqrt
>>> all(fast_inverse_sqrt(i) == sqrt(i) for i in range(-10, 10))
True

@cclauss cclauss self-assigned this Oct 29, 2023
@cclauss cclauss added the awaiting changes A maintainer has requested changes to this PR label Oct 29, 2023
cclauss
cclauss requested changes Oct 29, 2023
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Add some doctests that break things.

algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 29, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

maths/fast_inverse_sqrt.py Outdated
import struct


def fast_inverse_sqrt(x: float) -> float:
Copy link

Choose a reason for hiding this comment

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

Please provide descriptive name for the parameter: x

@algorithms-keeper algorithms-keeper bot removed the awaiting changes A maintainer has requested changes to this PR label Oct 29, 2023
@algorithms-keeper algorithms-keeper bot removed the require descriptive names This PR needs descriptive function and/or variable names label Oct 29, 2023
@aryanshb aryanshb requested a review from cclauss October 29, 2023 14:21
@aryanshb
Copy link
Contributor Author

The test may/may not fail due to the approximation of answer, which is the essence of this method.

Pls review for any additional change.

@cclauss
Copy link
Member

cclauss commented Oct 29, 2023

As discussed in CONTRIBUTING.md you can run the tests on your own computer with:
python3 -m doctest -v maths/fast_inverse_sqrt.py

@aryanshb
Copy link
Contributor Author

As discussed in CONTRIBUTING.md you can run the tests on your own computer with: python3 -m doctest -v maths/fast_inverse_sqrt.py

The doctests work perfectly on my PC, even before i committed. In the build fail details, fetch_anime_and_play.py seem to be failing tests.

image

@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 29, 2023
@cclauss cclauss enabled auto-merge (squash) October 29, 2023 20:55
cclauss
cclauss approved these changes Oct 29, 2023
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Final edits: aeae0a8

@cclauss cclauss merged commit 760d9be into TheAlgorithms:master Oct 29, 2023
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 29, 2023
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@aryanshb @pre-commit-ci
@cclauss @sedatguzelsemme
Added Fast Inverse Square Root (TheAlgorithms#11054)
8354622 
* Feat: Added Fast inverse square root

* Fix: Added typehint

* Fix: Added doctests that break the code, changed var name

* updating DIRECTORY.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix: fixed length of docstring

* Update fast_inverse_sqrt.py

---------

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@algorithms-keeper algorithms-keeper[bot] algorithms-keeper[bot] left review comments

@cclauss cclauss cclauss approved these changes

Assignees

@cclauss cclauss

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aryanshb @cclauss