Skip to content

/ Python

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

Add tests and type hints to hill cipher #1991

Merged
merged 3 commits into from May 18, 2020
Merged

Add tests and type hints to hill cipher #1991

merged 3 commits into from May 18, 2020
+77 −20

Conversation

@bharath5412
Copy link
Contributor

bharath5412 commented May 17, 2020

Describe your change:

Added doctests to the hill cipher algorithm and added type hints. This addresses the issue the #1788 .

There was a previous attemp #1862 to fix the issue but it wasn't merged.

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 have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.
bharath5412 and others added 3 commits May 17, 2020
@bharath5412
Added tests and type hints to hill cipher
Loading status checks…
51d89de
@poyea
Remove extra >>>
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
f84ccef
@poyea
import doctest
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
2c0844a
@cclauss
cclauss approved these changes May 18, 2020
View changes
@poyea
poyea approved these changes May 18, 2020
View changes
Copy link
Member

poyea left a comment

Thank you for your pull request!🤩
@poyea poyea merged commit aa120ce into TheAlgorithms:master May 18, 2020
2 checks passed
2 checks passed
codespell
Details
Travis CI - Pull Request Build Passed
Details
@cclauss
Copy link
Member

cclauss commented May 18, 2020

@bharath5412 I did not notice this before but these changes raise a ton of pytest warnings. Would you be willing to create a new pull request that eliminates these warnings? Given how little of numpy is actually used, would it be easy to remove the dependency on numpy? Thanks.
@cclauss
Copy link
Member

cclauss commented May 18, 2020 •
edited

@poyea fixed the warnings in 36c01f9 but I still wonder if it would be useful to remove the dependency on numpy?
@bharath5412
Copy link
Contributor Author

bharath5412 commented May 18, 2020

I can work on removing the dependency on numpy. But the code uses matrix operations such as determinant and inversion of a matrix. They themselves are slightly complex piece of codes. @cclauss do you think that the dependency should be removed? I can make a PR to remove the numpy dependency.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss

@poyea poyea

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
@bharath5412 @cclauss @poyea
You can’t perform that action at this time.