feat: changed TabuList trait to use just TransitionType instead of SolutionType and TransitionType tuple

[lucidfrontier45]

Summary by CodeRabbit

• New Features

  • Simplified method signatures for the contains and append functions in the TabuList interface, enhancing usability.
  • Updated the return type of the iter method in the RingBuffer for improved flexibility.

• Bug Fixes

  • Streamlined logic in the tabu search algorithm, consolidating checks for better efficiency.

• Tests

  • Revised tests for the MyTabuList implementation to reflect updated method signatures, improving clarity and correctness.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the TabuList trait and its implementations across several files. The contains and append method signatures have been simplified to accept a single parameter of type TransitionType, rather than a tuple containing both SolutionType and TransitionType. Additionally, the return type of the iter method in the RingBuffer implementation has been updated to a more generic type, enhancing flexibility.

Changes

Files	Change Summary
examples/tsp_model.rs, src/optim/tabu_search.rs, src/tests/test_tabu_search.rs	Updated TabuList trait implementations to simplify contains and append method signatures, changing them to accept a single TransitionType parameter.
src/utils.rs	Modified the return type of the iter method in the RingBuffer implementation from a specific iterator type to a more generic type, impl Iterator<Item = &T>.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TabuList
    participant DequeTabuList

    User->>TabuList: call contains(TransitionType)
    TabuList->>DequeTabuList: check for transition
    DequeTabuList-->>TabuList: return result

    User->>TabuList: call append(TransitionType)
    TabuList->>DequeTabuList: append transition
    DequeTabuList-->>TabuList: confirm append

Loading

🐇 In fields of green, I hop and play,
🎉 New methods shine, bright as day!
A simple change, a joyful cheer,
Transition types, now crystal clear!
So let us bound, with leaps and bounds,
In code we trust, where joy abounds! 🌼

---

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.