Skip to content

Improve docstring and add doctest example to simulated_annealing #14401

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

Open
galleazzijuniorsoftwareenginer wants to merge 2 commits into
base: master
Choose a base branch
from
+6 −1
Open

Improve docstring and add doctest example to simulated_annealing #14401

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae8dfa7
Improve docstring and add doctest example to simulated_annealing
Mar 14, 2026
84b1eef
Improve docstring and add doctest example to simulated_annealing
galleazzijuniorsoftwareenginer Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion searches/simulated_annealing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ def simulated_annealing(
start_temperate: the initial temperate of the system when the program starts.
rate_of_decrease: the rate at which the temperate decreases in each iteration.
threshold_temp: the threshold temperature below which we end the search
Returns a search state having the maximum (or minimum) score.
Returns:
A search state having the maximum (or minimum) score.

Example:
>>> isinstance(simulated_annealing, object)
True
"""
search_end = False
current_state = search_prob
Expand Down
Loading