Skip to content

Adds simulated annealing optimiser#619

Merged
BradyPlanden merged 16 commits into
developfrom
simulated-annealing
Jan 27, 2025
Merged

Adds simulated annealing optimiser#619
BradyPlanden merged 16 commits into
developfrom
simulated-annealing

Conversation

@BradyPlanden

Copy link
Copy Markdown
Member

Description

Adds an Simulated Annealing implementation with corresponding tests.

Issue reference

Fixes #618

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

@codecov

codecov Bot commented Jan 23, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.24%. Comparing base (9df5000) to head (8696cea).
Report is 66 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #619      +/-   ##
===========================================
+ Coverage    99.22%   99.24%   +0.01%     
===========================================
  Files           62       63       +1     
  Lines         4536     4626      +90     
===========================================
+ Hits          4501     4591      +90     
  Misses          35       35              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread README.md Outdated

@NicolaCourtier NicolaCourtier left a comment

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.

Thanks for this addition @BradyPlanden

@BradyPlanden BradyPlanden merged commit 844e780 into develop Jan 27, 2025
@BradyPlanden BradyPlanden deleted the simulated-annealing branch January 27, 2025 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Simulated Annealing

2 participants