-
-
Notifications
You must be signed in to change notification settings - Fork 46.9k
Added some more comments to volume.py in maths folder #7080
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
2b8026a
Added some more comments
advik-student-dev 722fb7d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 0c718d2
Apply suggestions from code review
cclauss 4f0cc17
The order changes the result
cclauss 9f37864
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] ef25838
Fix long line
cclauss 3971eeb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
""" | ||
Find Volumes of Various Shapes. | ||
Uncyclopedia reference: https://en.wikipedia.org/wiki/Volume | ||
Find the volume of various shapes. | ||
* https://en.wikipedia.org/wiki/Volume | ||
* https://en.wikipedia.org/wiki/Spherical_cap | ||
""" | ||
from __future__ import annotations | ||
|
||
|
@@ -30,8 +31,7 @@ def vol_cube(side_length: int | float) -> float: | |
|
||
def vol_spherical_cap(height: float, radius: float) -> float: | ||
""" | ||
Calculate the Volume of the spherical cap. | ||
:return 1/3 pi * height ^ 2 * (3 * radius - height) | ||
Calculate the volume of the spherical cap. | ||
>>> vol_spherical_cap(1, 2) | ||
5.235987755982988 | ||
>>> vol_spherical_cap(1.6, 2.6) | ||
|
@@ -49,6 +49,7 @@ def vol_spherical_cap(height: float, radius: float) -> float: | |
""" | ||
if height < 0 or radius < 0: | ||
raise ValueError("vol_spherical_cap() only accepts non-negative values") | ||
# Volume is 1/3 pi * height squared * (3 * radius - height) | ||
return 1 / 3 * pi * pow(height, 2) * (3 * radius - height) | ||
|
||
|
||
|
@@ -263,7 +264,8 @@ def vol_sphere(radius: float) -> float: | |
""" | ||
if radius < 0: | ||
raise ValueError("vol_sphere() only accepts non-negative values") | ||
return 4 / 3 * pi * pow(radius, 3) | ||
# Volume is radius cubed * pi * 4/3 | ||
return pow(radius, 3) * pi * 4 / 3 | ||
|
||
|
||
def vol_hemisphere(radius: float) -> float: | ||
|
@@ -286,7 +288,8 @@ def vol_hemisphere(radius: float) -> float: | |
""" | ||
if radius < 0: | ||
raise ValueError("vol_hemisphere() only accepts non-negative values") | ||
return 2 / 3 * pi * pow(radius, 3) | ||
# Volume is radius cubed * pi * 2/3 | ||
return pow(radius, 3) * pi * 2 / 3 | ||
|
||
|
||
def vol_circular_cylinder(radius: float, height: float) -> float: | ||
|
@@ -312,7 +315,8 @@ def vol_circular_cylinder(radius: float, height: float) -> float: | |
""" | ||
if height < 0 or radius < 0: | ||
raise ValueError("vol_circular_cylinder() only accepts non-negative values") | ||
return pi * pow(radius, 2) * height | ||
# Volume is radius squared * height * pi | ||
return pow(radius, 2) * height * pi | ||
|
||
|
||
def vol_hollow_circular_cylinder( | ||
|
@@ -344,6 +348,7 @@ def vol_hollow_circular_cylinder( | |
... | ||
ValueError: outer_radius must be greater than inner_radius | ||
""" | ||
# Volume - (outer_radius squared - inner_radius squared) * pi * height | ||
advik-student-dev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if inner_radius < 0 or outer_radius < 0 or height < 0: | ||
raise ValueError( | ||
"vol_hollow_circular_cylinder() only accepts non-negative values" | ||
|
@@ -356,7 +361,7 @@ def vol_hollow_circular_cylinder( | |
def vol_conical_frustum(height: float, radius_1: float, radius_2: float) -> float: | ||
"""Calculate the Volume of a Conical Frustum. | ||
Uncyclopedia reference: https://en.wikipedia.org/wiki/Frustum | ||
:return 1/3 * pi * height * (radius_1^2 + radius_top^2 + radius_1 * radius_2) | ||
|
||
>>> vol_conical_frustum(45, 7, 28) | ||
48490.482608158454 | ||
>>> vol_conical_frustum(1, 1, 2) | ||
|
@@ -378,6 +383,7 @@ def vol_conical_frustum(height: float, radius_1: float, radius_2: float) -> floa | |
... | ||
ValueError: vol_conical_frustum() only accepts non-negative values | ||
""" | ||
# Volume - 1/3 * pi * height * (radius_1 squared + radius_2 squared + radius_1 * radius_2) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tests are failing on:
Also, please move this line down to be just above the calculation. Make sure that the order of the values in the comment and in the calculation are the same. |
||
if radius_1 < 0 or radius_2 < 0 or height < 0: | ||
raise ValueError("vol_conical_frustum() only accepts non-negative values") | ||
return ( | ||
|
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.
Uh oh!
There was an error while loading. Please reload this page.