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

[NEW ALGORITHM] Rotate linked list by K. #9278

Merged
merged 15 commits into from
Oct 1, 2023
Merged

[NEW ALGORITHM] Rotate linked list by K. #9278

merged 15 commits into from
Oct 1, 2023

Conversation

Muhammadummerr
Copy link
Contributor

Describe your change:

I have added a new algorithm to rotate a linked list by k times. I have also:

  • Added the function docstring to provide clear documentation.

  • Added type hints for function parameters and return values.

  • Included comments to enhance code readability.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • 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 1, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 1, 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.

data_structures/linked_list/rotate_linked_list_by_k.py Outdated
return head


def right_rotate_by_k(head: Node, k: int) -> Node:
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: k

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 1, 2023
@cclauss
Copy link
Member

cclauss commented Oct 1, 2023

As stated above k is not self-documenting.

Also...

mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

data_structures/linked_list/rotate_linked_list_by_k.py:63: error: Incompatible types in assignment (expression has type "Node", variable has type "None")  [assignment]
data_structures/linked_list/rotate_linked_list_by_k.py:133: error: Argument 1 to "insert_node" has incompatible type "None"; expected "Node"  [arg-type]
Found 2 errors in 1 file (checked 1205 source files)

@Muhammadummerr @cclauss
Update data_structures/linked_list/rotate_linked_list_by_k.py
a8058ad 
Co-authored-by: Christian Clauss <cclauss@me.com>
@algorithms-keeper algorithms-keeper bot removed the require descriptive names This PR needs descriptive function and/or variable names label Oct 1, 2023
@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 1, 2023
@Muhammadummerr Muhammadummerr requested a review from cclauss October 1, 2023 13:16
@cclauss
Copy link
Member

cclauss commented Oct 1, 2023

#9278 (comment)

@Muhammadummerr
Copy link
Contributor Author

#9278 (comment)

I used the variable "rotation" instead of "k".

cclauss
cclauss reviewed Oct 1, 2023
View reviewed changes
data_structures/linked_list/rotate_linked_list_by_k.py Outdated
Comment on lines 70 to 80
def right_rotate_by_k(head: Node | None, rotation: int) -> Node | None:
"""
Rotate a linked list to the right by rotation times.

Parameters:
head (Node | None): The head of the linked list.
rotation (int): The number of places to rotate.

Returns:
Node | None: The head of the rotated linked list\
if the linked list is not None, otherwise None.
Copy link
Member

Choose a reason for hiding this comment

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

Mypy can test data types in the function signature, but not in the comments.

Do not repeat the datatypes in both places because readers will be confused if one is changed and the other is not.

How about this naming...

Suggested change
def right_rotate_by_k(head: Node | None, rotation: int) -> Node | None:
"""
Rotate a linked list to the right by rotation times.
Parameters:
head (Node | None): The head of the linked list.
rotation (int): The number of places to rotate.
Returns:
Node | None: The head of the rotated linked list\
if the linked list is not None, otherwise None.
def rotate_to_the_right(head: Node | None, places: int) -> Node | None:
"""
Rotate a linked list to the right by a number of places.
Parameters:
head: The head of the linked list.
places: The number of places to rotate the linked list
Returns:
The head of the rotated linked list or None if there is no list.

Copy link
Member

Choose a reason for hiding this comment

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

I might even raise a ValueError if I was handed a head=None.

Copy link
Member

Choose a reason for hiding this comment

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

Do we have a test for a linked list that has just 3 elements but we are asked to shift to the right 10 places?

Copy link
Member

Choose a reason for hiding this comment

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

What happens if we are asked to shift to the right -2 places? -2.5 places?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What happens if we are asked to shift to the right -2 places? -2.5 places?

If the rotation number is not an integer, it should raise an error. If it is a negative integer, converting it to a positive integer would be a better idea, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do we have a test for a linked list that has just 3 elements but we are asked to shift to the right 10 places?

Yes, I tested it, and it is working correctly.

@cclauss cclauss enabled auto-merge (squash) October 1, 2023 15:45
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 1, 2023
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 1, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 1, 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 the tests are failing Do not merge until tests pass label Oct 1, 2023
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 1, 2023
@cclauss cclauss merged commit bacad12 into TheAlgorithms:master Oct 1, 2023
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 1, 2023
@tianyizheng02 tianyizheng02 mentioned this pull request Oct 1, 2023
Closed
14 tasks
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@Muhammadummerr @cclauss
@pre-commit-ci @sedatguzelsemme
[NEW ALGORITHM] Rotate linked list by K. (TheAlgorithms#9278)
914a4f7 
* Rotate linked list by k.

* Rotate linked list by k.

* updated variable name.

* Update data_structures/linked_list/rotate_linked_list_by_k.py

Co-authored-by: Christian Clauss <cclauss@me.com>

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

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

* Update data_structures/linked_list/rotate_linked_list_by_k.py

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update data_structures/linked_list/rotate_linked_list_by_k.py

* Make Node a dataclass

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.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
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

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