feat: feat: removed ExtraIn and ExtraOut from LocalSearchOptimizer interface

[lucidfrontier45]

Summary by CodeRabbit

• Documentation

  • Enhanced README.md to clarify the requirements for using the Tabu Search algorithm, specifically regarding the tabu list.

• New Features

  • Introduced a default size for the DequeTabuList, allowing for easier instantiation.
  • Updated SimulatedAnnealingOptimizer to manage temperature parameters directly, improving optimization flexibility.

• Bug Fixes

  • Simplified method calls across various optimizers by removing unnecessary parameters, enhancing code readability and usability.

• Refactor

  • Streamlined the optimize methods in multiple optimizers by eliminating extra input and output parameters, focusing on core functionality.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes encompass modifications to various algorithms, primarily revolving around simplifying method signatures, enhancing type safety, and clarifying interfaces in optimization modules. Notable alterations include the removal of unnecessary parameters, updates to method calls, and the introduction of new parameters for improved configuration, particularly in simulated annealing and tabu search implementations. Additionally, several documentation enhancements provide clearer guidance on algorithm requirements.

Changes

Files	Change Summary
README.md	Enhanced "Tabu Search" algorithm description; clarified tabu list implementation requirement.
src/main.rs, examples/*.rs	Removed empty tuple from method calls; simplified function signatures in the run methods.
examples/tsp_model.rs	Updated DequeTabuList; added Default implementation; refined methods to specify types.
src/optim/*.rs	Removed ExtraIn and ExtraOut from various optimizers; simplified optimize method signatures.
src/tests/*.rs	Simplified run method calls by removing unused parameters; adjusted return values accordingly.
src/optim/simulated_annealing.rs	Added temperature parameters; refactored optimize to optimize_with_temperature method.
src/optim/tabu_search.rs	Updated TabuList trait and TabuSearchOptimizer to enhance type safety and introduce default tabu size.
src/tests/test_tabu_search.rs	Adjusted MyTabuList implementation to align with QuadraticModel; added Default implementation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EpsilonGreedyOptimizer
    participant HillClimbingOptimizer
    participant SimulatedAnnealingOptimizer

    User->>EpsilonGreedyOptimizer: run(...)
    EpsilonGreedyOptimizer-->>User: (solution, score)

    User->>HillClimbingOptimizer: run(...)
    HillClimbingOptimizer-->>User: (solution, score)

    User->>SimulatedAnnealingOptimizer: run(...)
    SimulatedAnnealingOptimizer-->>User: (solution, score)

Loading

Poem

🐰 In the meadow, changes bloom,
Algorithms dance, dispel the gloom.
Parameters trimmed, sleek and bright,
Optimizers leap, taking flight.
With a hop and a skip, all is neat,
A joyful code, a swift heartbeat! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.