added TSP solution using MST implementation with docstrings under Graphs #13682

raisaaajose · 2025-10-22T14:46:39Z

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

This reverts commit d3d010f.

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 · 2025-10-22T14:46:47Z

graphs/travelling_salesman.py

@@ -0,0 +1,206 @@
+import heapq
+
+def tsp(cost):


As there is no test file in this pull request nor any test function or class in the file graphs/travelling_salesman.py, please provide doctest for the function tsp

Please provide return type hint for the function: tsp. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: cost

graphs/travelling_salesman.py

algorithms-keeper · 2025-10-22T14:46:48Z

graphs/travelling_salesman.py

+ # Sort each adjacency list based 
+ # on the weight of the edges
+ for i in range(n):
+ adj[i].sort(key=lambda a: a[1])


Please provide descriptive name for the parameter: a

graphs/travelling_salesman.py

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

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 · 2025-10-22T15:03:10Z

graphs/travelling_salesman.py

+import heapq
+
+
+def tsp(cost):


As there is no test file in this pull request nor any test function or class in the file graphs/travelling_salesman.py, please provide doctest for the function tsp

Please provide return type hint for the function: tsp. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: cost

algorithms-keeper · 2025-10-22T15:03:11Z

graphs/travelling_salesman.py

+
+
+# function to implement approximate TSP
+def approximate_tsp(adj):


As there is no test file in this pull request nor any test function or class in the file graphs/travelling_salesman.py, please provide doctest for the function approximate_tsp

Please provide return type hint for the function: approximate_tsp. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: adj

algorithms-keeper · 2025-10-22T15:03:11Z

graphs/travelling_salesman.py

+
+ return tour_path
+
+def tour_cost(tour):


As there is no test file in this pull request nor any test function or class in the file graphs/travelling_salesman.py, please provide doctest for the function tour_cost

Please provide return type hint for the function: tour_cost. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: tour

algorithms-keeper · 2025-10-22T15:03:11Z

graphs/travelling_salesman.py

+ return cost
+
+
+def eulerian_circuit(adj, u, tour, visited, parent):


As there is no test file in this pull request nor any test function or class in the file graphs/travelling_salesman.py, please provide doctest for the function eulerian_circuit

Please provide return type hint for the function: eulerian_circuit. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: adj

Please provide descriptive name for the parameter: u

Please provide type hint for the parameter: u

Please provide type hint for the parameter: tour

Please provide type hint for the parameter: visited

Please provide type hint for the parameter: parent

algorithms-keeper · 2025-10-22T15:03:11Z

graphs/travelling_salesman.py

+ eulerian_circuit(adj, v, tour, visited, u)
+
+# function to find the minimum spanning tree
+def find_mst(adj, mst_cost):


As there is no test file in this pull request nor any test function or class in the file graphs/travelling_salesman.py, please provide doctest for the function find_mst

Please provide return type hint for the function: find_mst. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: adj

Please provide type hint for the parameter: mst_cost

algorithms-keeper · 2025-10-22T15:03:11Z

graphs/travelling_salesman.py

+ # Sort each adjacency list based
+ # on the weight of the edges
+ for i in range(n):
+ adj[i].sort(key=lambda a: a[1])


Please provide descriptive name for the parameter: a

graphs/travelling_salesman.py

algorithms-keeper · 2025-10-22T15:03:11Z

graphs/travelling_salesman.py

+ cost_VW = y[1]
+ for z in adj[u]:
+ if z[0] == w:
+ cost_UW = z[1]


Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: cost_UW

algorithms-keeper · 2025-10-22T15:03:11Z

graphs/travelling_salesman.py

+
+
+# function to create the adjacency list
+def create_list(cost):


As there is no test file in this pull request nor any test function or class in the file graphs/travelling_salesman.py, please provide doctest for the function create_list

Please provide return type hint for the function: create_list. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: cost

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

raisaaajose added 3 commits October 22, 2025 20:02

TSP under Graphs

d3d010f

Revert "TSP under Graphs"

831a50b

This reverts commit d3d010f.

TSP under Graphs

1452f5d

algorithms-keeper bot added require descriptive names This PR needs descriptive function and/or variable names require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Oct 22, 2025

algorithms-keeper bot reviewed Oct 22, 2025

View reviewed changes

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

pre-commit-ci bot and others added 3 commits October 22, 2025 14:47

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

c1b0edd

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

updated to snake_case

038739f

Merge branch 'tsp' of https://github.com/raisaaajose/Python into tsp

1dffc2c

algorithms-keeper bot reviewed Oct 22, 2025

View reviewed changes

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

c5c777a

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

added TSP solution using MST implementation with docstrings under Graphs #13682

added TSP solution using MST implementation with docstrings under Graphs #13682

Uh oh!

raisaaajose commented Oct 22, 2025

algorithms-keeper bot left a comment

algorithms-keeper bot Oct 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

algorithms-keeper bot Oct 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

algorithms-keeper bot left a comment

algorithms-keeper bot Oct 22, 2025

algorithms-keeper bot Oct 22, 2025

algorithms-keeper bot Oct 22, 2025

algorithms-keeper bot Oct 22, 2025

algorithms-keeper bot Oct 22, 2025

algorithms-keeper bot Oct 22, 2025

Uh oh!

Uh oh!

algorithms-keeper bot Oct 22, 2025

algorithms-keeper bot Oct 22, 2025

Labels

1 participant



		# function to implement approximate TSP
		def approximate_tsp(adj):

		return cost


		def eulerian_circuit(adj, u, tour, visited, parent):



		# function to create the adjacency list
		def create_list(cost):

Uh oh!

added TSP solution using MST implementation with docstrings under Graphs #13682

Are you sure you want to change the base?

added TSP solution using MST implementation with docstrings under Graphs #13682

Uh oh!

Conversation

raisaaajose commented Oct 22, 2025

Describe your change:

Checklist:

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:

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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:

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

algorithms-keeper bot Oct 22, 2025

Choose a reason for hiding this comment

Labels

1 participant