') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); [NEW ALGORITHM] Rotate linked list by K. by Muhammadummerr · Pull Request #9278 · TheAlgorithms/Python · GitHub
Skip to content

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

Merged
cclauss merged 15 commits into
TheAlgorithms:masterfrom
Muhammadummerr:add_new_algorithm
Oct 1, 2023
Merged

[NEW ALGORITHM] Rotate linked list by K.#9278
cclauss merged 15 commits into
TheAlgorithms:masterfrom
Muhammadummerr:add_new_algorithm

Conversation

@Muhammadummerr

@MuhammadummerrMuhammadummerr commented Oct 1, 2023

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

@algorithms-keeperalgorithms-keeperBot left a comment

Copy link
Copy Markdown

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.

Comment threaddata_structures/linked_list/rotate_linked_list_by_k.py Outdated
return head


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

@algorithms-keeperalgorithms-keeperBotOct 1, 2023

Copy link
Copy Markdown

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-keeperalgorithms-keeperBot added the awaiting reviews This PR is ready to be reviewed label Oct 1, 2023
@cclauss

cclauss commented Oct 1, 2023

Copy link
Copy Markdown
Member

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)

cclauss
cclauss reviewed Oct 1, 2023
View reviewed changes
Comment threaddata_structures/linked_list/rotate_linked_list_by_k.py Outdated
cclauss
cclauss reviewed Oct 1, 2023
View reviewed changes
Comment threaddata_structures/linked_list/rotate_linked_list_by_k.py Outdated
@Muhammadummerr@cclauss
Update data_structures/linked_list/rotate_linked_list_by_k.py
a8058ad
Co-authored-by: Christian Clauss <cclauss@me.com>
@algorithms-keeperalgorithms-keeperBot removed the require descriptive names This PR needs descriptive function and/or variable names label Oct 1, 2023
cclauss
cclauss reviewed Oct 1, 2023
View reviewed changes
Comment threaddata_structures/linked_list/rotate_linked_list_by_k.py Outdated
@algorithms-keeperalgorithms-keeperBot 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
@cclauss

cclauss commented Oct 1, 2023

Copy link
Copy Markdown
Member

#9278 (comment)

@Muhammadummerr

Muhammadummerr commented Oct 1, 2023

Copy link
Copy Markdown
ContributorAuthor

#9278 (comment)

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

cclauss
cclauss reviewed Oct 1, 2023
View reviewed changes
Comment threaddata_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.

@cclausscclaussOct 1, 2023

Copy link
Copy Markdown
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
defright_rotate_by_k(head: Node|None, rotation: int) ->Node|None:
"""
Rotatealinkedlisttotherightbyrotationtimes.
Parameters:
head (Node|None): Theheadofthelinkedlist.
rotation (int): Thenumberofplacestorotate.
Returns:
Node|None: Theheadoftherotatedlinkedlist\
ifthelinkedlistisnotNone, otherwiseNone.
defrotate_to_the_right(head: Node|None, places: int) ->Node|None:
"""
Rotatealinkedlisttotherightbyanumberofplaces.
Parameters:
head: Theheadofthelinkedlist.
places: Thenumberofplacestorotatethelinkedlist
Returns:
TheheadoftherotatedlinkedlistorNoneifthereisnolist.

@cclausscclaussOct 1, 2023

Copy link
Copy Markdown
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.

@cclausscclaussOct 1, 2023

Copy link
Copy Markdown
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?

@cclausscclaussOct 1, 2023

Copy link
Copy Markdown
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?

@MuhammadummerrMuhammadummerrOct 1, 2023

Copy link
Copy Markdown
ContributorAuthor

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?

@MuhammadummerrMuhammadummerrOct 1, 2023

Copy link
Copy Markdown
ContributorAuthor

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-keeperalgorithms-keeperBot added the tests are failing Do not merge until tests pass label Oct 1, 2023
@algorithms-keeperalgorithms-keeperBot removed the tests are failing Do not merge until tests pass label Oct 1, 2023
algorithms-keeper[bot]
algorithms-keeperBot reviewed Oct 1, 2023
View reviewed changes

@algorithms-keeperalgorithms-keeperBot left a comment

Copy link
Copy Markdown

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.

Comment threaddata_structures/linked_list/rotate_to_the_right.py
@algorithms-keeperalgorithms-keeperBot added the tests are failing Do not merge until tests pass label Oct 1, 2023
@algorithms-keeperalgorithms-keeperBot removed the tests are failing Do not merge until tests pass label Oct 1, 2023
@cclauss
cclauss merged commit bacad12 into TheAlgorithms:masterOct 1, 2023
@algorithms-keeperalgorithms-keeperBot removed the awaiting reviews This PR is ready to be reviewed label Oct 1, 2023
@tianyizheng02tianyizheng02 mentioned this pull request Oct 1, 2023
Closed
14 tasks
@isidroasisidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cclausscclausscclauss approved these changes
+1 more reviewer
@algorithms-keeperalgorithms-keeper[bot]algorithms-keeper[bot] left review comments
Reviewers whose approvals may not affect merge requirements

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