feat(algorithms, arrays): tournament winner

[BrianLusina]

Describe your change:

Tournament winner algorithm to determine wthe winner in a tournament

• Add an algorithm?
• Fix a bug or typo in an existing algorithm?
• 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 have a URL in its comments that points to Wikipedia or other similar explanation.
• [] If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

Summary by CodeRabbit

• New Features

  • Added a new "Tournament Winner" problem, including a detailed description and hints.
  • Introduced a function to determine the winner of a tournament based on match results.
  • Provided tests to ensure correct functionality for the tournament winner logic.

• Bug Fixes

  • Added new test cases for the sorted squared array problem to handle a wider range of input scenarios.

• Documentation

  • Updated the directory listing to include new problems, tests, and reorganized sections for improved clarity.

[coderabbitai]

Warning

Rate limit exceeded

@BrianLusina has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 28 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 3a802dd and 36dfa6e.

📒 Files selected for processing (5)

• DIRECTORY.md (12 hunks)
• algorithms/arrays/sorted_squared_array/test_sorted_squared_array.py (2 hunks)
• puzzles/arrays/tournament_winner/README.md (1 hunks)
• puzzles/arrays/tournament_winner/__init__.py (1 hunks)
• puzzles/arrays/tournament_winner/test_tournament_winner.py (1 hunks)

Walkthrough

The updates introduce a new "Tournament Winner" problem with its implementation, tests, and documentation. Additional tests are added for the "Sorted Squared Array" algorithm. The DIRECTORY.md file is extensively updated to reflect new problems, tests, reorganizations, and removals across algorithm, data structure, puzzle, and string sections.

Changes

File(s)	Change Summary
DIRECTORY.md	Extensively updated: added, reorganized, and removed entries for algorithms, datastructures, puzzles, and tests.
algorithms/arrays/sorted_squared_array/test_sorted_squared_array.py	Added new test cases (test_3) to both SortedSquaredArrayTestCases and SortedSquaredArray2TestCases.
puzzles/arrays/tournament_winner/README.md	Added new README describing the "Tournament Winner" problem, input/output, hints, and complexity.
puzzles/arrays/tournament_winner/init.py	Added new function tournament_winner to compute the tournament winner from competitions and results.
puzzles/arrays/tournament_winner/test_tournament_winner.py	Added new test file with two test cases for tournament_winner using the unittest framework.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TournamentWinnerFunction
    participant PointsTable

    User->>TournamentWinnerFunction: Provide competitions, results
    TournamentWinnerFunction->>PointsTable: Initialize/Update team points per result
    TournamentWinnerFunction->>PointsTable: Iterate competitions, update scores
    TournamentWinnerFunction->>User: Return team with highest points

Loading

Possibly related PRs

• feat(algorithms, arrays): tournament winner #93: Adds the same "Tournament Winner" puzzle including implementation, README, and tests, closely related to this PR.

Poem

In the warren, teams compete,
Rabbits tally up each feat.
With points and tests, the scores grow clear,
A winner hops ahead—let’s cheer!
New puzzles sprout, arrays are squared,
The garden’s richer, well-prepared.
🏆🐇

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[coderabbitai]

Note

Generated docstrings for this pull request at #94