Add doctests and refactor Monte Carlo estimation functions #12703
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Refactored all functions to return values instead of printing output. - Added doctests for each fucntion. - Clarified docstrings. - Improved code style (typing hints, naming) to align with repo conventions.
Removed __main__ block not used fot script execution.
|
UNSUBSCRIBE
…---- Replied Message ----
| From | ***@***.***> |
| Date | 05/01/2025 18:09 |
| To | TheAlgorithms/Python ***@***.***> |
| Cc | Subscribed ***@***.***> |
| Subject | [TheAlgorithms/Python] Add doctests and refactor Monte Carlo estimation functions (PR #12703) |
Contributes to #9943
This pull request refactors and improves the implementation of the Monte Carlo estimation functions:
Refactors functions to return values instead of printing, improving testability.
Adds missing type hints.
Renames function function_to_integrate to the more descriptive semicircle_function.
Clarifies docstrings.
Adds doctests for each function:
pi_estimator
area_under_curve_estimator
area_under_line_estimator_check
pi_estimator_using_area_under_curve
All doctests pass using python3 -m doctest -v path/to/file.py
You can view, comment on, or merge this pull request online at:
#12703
Commit Summary
bcce276 Refactor Monte Carlo estimation functions and add doctest
87a5587 cleanup: Remove unused script stub
File Changes
(1 file)
Mmaths/monte_carlo.py (192)
Patch Links:
https://github.com/TheAlgorithms/Python/pull/12703.patch
https://github.com/TheAlgorithms/Python/pull/12703.diff
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributes to #9943
This pull request refactors and improves the implementation of the Monte Carlo estimation functions:
function_to_integrateto the more descriptivesemicircle_function.pi_estimatorarea_under_curve_estimatorarea_under_line_estimator_checkpi_estimator_using_area_under_curveAll doctests pass using
python3 -m doctest -v path/to/file.py