[NEW ALGORITHM] Rotate linked list by K. by Muhammadummerr · Pull Request #9278 · TheAlgorithms/Python

Muhammadummerr · 2023-10-01T11:31:29Z

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:

algorithms-keeper

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Contributing guidelines

Project Euler solution guidelines

Python:

Formatted string literals (f-strings)

Type hints

doctest

unittest

pytest

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 · 2023-10-01T11:31:35Z

data_structures/linked_list/rotate_linked_list_by_k.py

+    return head
+
+
+def right_rotate_by_k(head: Node, k: int) -> Node:


Please provide descriptive name for the parameter: k

cclauss · 2023-10-01T12:29:11Z

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)

data_structures/linked_list/rotate_linked_list_by_k.py

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

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

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

data_structures/linked_list/rotate_linked_list_by_k.py

cclauss · 2023-10-01T13:24:54Z

#9278 (comment)

Muhammadummerr · 2023-10-01T13:28:09Z

#9278 (comment)

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

cclauss · 2023-10-01T13:34:29Z

data_structures/linked_list/rotate_linked_list_by_k.py

+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.


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.

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

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?

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

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?

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.

algorithms-keeper

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Contributing guidelines

Project Euler solution guidelines

Python:

Formatted string literals (f-strings)

Type hints

doctest

unittest

pytest

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_to_the_right.py

Muhammadummerr added 2 commits October 1, 2023 16:17

Rotate linked list by k.

6e610d4

Rotate linked list by k.

6122ded

algorithms-keeper bot added the require descriptive names This PR needs descriptive function and/or variable names label Oct 1, 2023

algorithms-keeper bot reviewed Oct 1, 2023

View reviewed changes

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

updated variable name.

64e0196

cclauss reviewed Oct 1, 2023

View reviewed changes

data_structures/linked_list/rotate_linked_list_by_k.py Outdated Show resolved Hide resolved

cclauss reviewed Oct 1, 2023

View reviewed changes

data_structures/linked_list/rotate_linked_list_by_k.py Outdated Show resolved Hide resolved

Update data_structures/linked_list/rotate_linked_list_by_k.py

a8058ad

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

algorithms-keeper bot removed the require descriptive names This PR needs descriptive function and/or variable names label Oct 1, 2023

pre-commit-ci bot and others added 2 commits October 1, 2023 13:08

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

edfd0ec

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

Update data_structures/linked_list/rotate_linked_list_by_k.py

1b9e7da

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

cclauss reviewed Oct 1, 2023

View reviewed changes

data_structures/linked_list/rotate_linked_list_by_k.py Outdated Show resolved Hide resolved

Update data_structures/linked_list/rotate_linked_list_by_k.py

e04ed07

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 requested a review from cclauss October 1, 2023 13:16

cclauss reviewed Oct 1, 2023

View reviewed changes

Make Node a dataclass

589cb8c

cclauss enabled auto-merge (squash) October 1, 2023 15:45

Update rotate_linked_list_by_k.py

c0a1f8e

algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 1, 2023

Merge branch 'TheAlgorithms:master' into add_new_algorithm

34260bf

algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 1, 2023

cclauss added 2 commits October 1, 2023 17:54

Update rotate_linked_list_by_k.py

b575263

Update and rename rotate_linked_list_by_k.py to rotate_to_the_right.py

0644ed0

algorithms-keeper bot reviewed Oct 1, 2023

View reviewed changes

data_structures/linked_list/rotate_to_the_right.py Show resolved Hide resolved

Update rotate_to_the_right.py

69e4ddb

algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 1, 2023

Update rotate_to_the_right.py

69aa9fe

algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 1, 2023

Update rotate_to_the_right.py

5439cea

cclauss approved these changes Oct 1, 2023

View reviewed changes

cclauss merged commit bacad12 into TheAlgorithms:master Oct 1, 2023

algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 1, 2023

tianyizheng02 mentioned this pull request Oct 1, 2023

rotate linked list to right by k #9258

Closed

14 tasks

isidroas mentioned this pull request Jan 25, 2025

dh isidroas/Python#1

Closed

14 tasks

		return head


		def right_rotate_by_k(head: Node, k: int) -> Node:

Uh oh!

Conversation

Muhammadummerr commented Oct 1, 2023

Describe your change:

Checklist:

Uh oh!

algorithms-keeper bot left a comment

Choose a reason for hiding this comment

🔗 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 actions can be triggered by commenting on this PR:

Uh oh!

algorithms-keeper bot Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

cclauss commented Oct 1, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cclauss commented Oct 1, 2023

Uh oh!

Muhammadummerr commented Oct 1, 2023

Uh oh!

cclauss Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

cclauss Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

cclauss Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

cclauss Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

Muhammadummerr Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

Muhammadummerr Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

algorithms-keeper bot left a comment

Choose a reason for hiding this comment

🔗 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 actions can be triggered by commenting on this PR:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments