Add Mathavan 2010 as WIP

[ekiefl]

Still a lot to debug and improve. The code is mostly LLM. Just wanted to get it into main for testing.

Summary by CodeRabbit

• New Features
  • Introduced advanced ball cushion collision simulation models utilizing a Mathavan 2010–based approach.
  • Enhanced collision dynamics for both linear and circular cushion interactions.
  • Expanded options for simulation model selection to improve accuracy in collision outcomes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes extend the ball cushion collision simulation by integrating the Mathavan 2010 model. New classes (Mathavan2010Linear and Mathavan2010Circular) have been added and registered in the ball cushion registries. A new module introduces the Mathavan simulation with a helper function for collision resolution, complete with error handling and a basic test script. Additionally, enum values representing this new model were added to the ball cushion models.

Changes

File(s)	Change Summary
pooltool/physics/resolve/ball_cushion/__init__.py	Added imports of Mathavan2010Circular and Mathavan2010Linear from the mathavan_2010 module; updated _ball_lcushion_model_registry and _ball_ccushion_model_registry.
pooltool/physics/resolve/ball_cushion/mathavan_2010/__init__.py	Introduced the Mathavan collision simulation model with the Mathavan class, helper function _solve_mathaven, and new collision classes Mathavan2010Linear and Mathavan2010Circular implementing the solve() method; includes test script and error handling.
pooltool/physics/resolve/models.py	Added new enum value MATHAVAN_2010 to BallLCushionModel and BallCCushionModel to support the new collision models.

Sequence Diagram(s)

sequenceDiagram
    participant Ball
    participant Cushion
    participant MathavanModel
    participant SimulationEngine

    Ball->>MathavanModel: Call solve(ball, cushion)
    MathavanModel->>SimulationEngine: Execute _solve_mathaven simulation
    SimulationEngine-->>MathavanModel: Return updated state
    MathavanModel-->>Ball: Deliver updated ball and cushion states

Loading

Poem

Hopping through code with zest, I see,
Mathavan's magic sets collisions free.
Linear or circular, the models now gleam,
Like carrots in fields of vibrant dream.
A bunny's cheer for changes anew,
Carrot crunching code with joy so true.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0efac1a and c5ddb4a.

📒 Files selected for processing (3)

• pooltool/physics/resolve/ball_cushion/__init__.py (1 hunks)
• pooltool/physics/resolve/ball_cushion/mathavan_2010/__init__.py (1 hunks)
• pooltool/physics/resolve/models.py (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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>, please review it.
  • 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 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 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 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. (Beta)
• @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.

[codecov]

Codecov Report

Attention: Patch coverage is 23.71795% with 119 lines in your changes missing coverage. Please review.

Project coverage is 44.30%. Comparing base (0e89b7f) to head (c5ddb4a).
Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
...ics/resolve/ball_cushion/mathavan_2010/__init__.py	22.22%	119 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #183      +/-   ##
==========================================
+ Coverage   44.22%   44.30%   +0.08%     
==========================================
  Files         127      130       +3     
  Lines        8554     8886     +332     
==========================================
+ Hits         3783     3937     +154     
- Misses       4771     4949     +178     

Flag	Coverage Δ
service	44.30% <23.71%> (+0.08%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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