Added an implementation of Legendre polynomial computation algorithm #12407
Conversation
Added an algorithm that calculates the coefficients of the Legendre polynomial of degree n using the recurrence relation
for more information, see https://pre-commit.ci
algorithms-keeper
bot
added
awaiting reviews
algorithms-keeper
bot
added
require descriptive names
![algorithms-keeper[bot]](https://avatars.githubusercontent.com/in/235834?s=60&v=4){kind=small}
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
| from numpy.polynomial import Polynomial | ||
|
|
||
|
|
||
| def legendre(n: int) -> list[float]: |
There was a problem hiding this comment.
Please provide descriptive name for the parameter: n
maths/polynomials/legendre.py
Outdated
| return p.deriv(n).coef.tolist() | ||
|
|
||
|
|
||
| def jsp(): |
There was a problem hiding this comment.
Please provide return type hint for the function: jsp. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| jsp() | ||
|
|
||
|
|
||
| def test_legendre_0(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_0. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| assert legendre(0) == [1.0], "The 0th Legendre polynomial should be [1.0]" | ||
|
|
||
|
|
||
| def test_legendre_1(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_1. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| assert legendre(1) == [0.0, 1.0], "The 1st Legendre polynomial should be [0.0, 1.0]" | ||
|
|
||
|
|
||
| def test_legendre_2(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_2. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| ], "The 2nd Legendre polynomial should be [-0.5, 0.0, 1.5]" | ||
|
|
||
|
|
||
| def test_legendre_3(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_3. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| ], "The 3rd Legendre polynomial should be [0.0, -1.5, 0.0, 2.5]" | ||
|
|
||
|
|
||
| def test_legendre_4(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_4. If the function does not return a value, please provide the type hint as: def function() -> None:
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
| from numpy.polynomial import Polynomial | ||
|
|
||
|
|
||
| def legendre(n: int) -> list[float]: |
There was a problem hiding this comment.
Please provide descriptive name for the parameter: n
maths/polynomials/legendre.py
Outdated
| return p.deriv(n).coef.tolist() | ||
|
|
||
|
|
||
| def test_legendre_0(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_0. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| assert legendre(0) == [1.0], "The 0th Legendre polynomial should be [1.0]" | ||
|
|
||
|
|
||
| def test_legendre_1(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_1. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| assert legendre(1) == [0.0, 1.0], "The 1st Legendre polynomial should be [0.0, 1.0]" | ||
|
|
||
|
|
||
| def test_legendre_2(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_2. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| ], "The 2nd Legendre polynomial should be [-0.5, 0.0, 1.5]" | ||
|
|
||
|
|
||
| def test_legendre_3(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_3. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| ], "The 3rd Legendre polynomial should be [0.0, -1.5, 0.0, 2.5]" | ||
|
|
||
|
|
||
| def test_legendre_4(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_4. If the function does not return a value, please provide the type hint as: def function() -> None:
algorithms-keeper
bot
removed
require descriptive names
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
| """Test the 2nd Legendre polynomial.""" | ||
| assert compute_legendre_polynomial_coefficients(2) == [-0.5, 0.0, 1.5], | ||
| "The 2nd Legendre polynomial should be [-0.5, 0.0, 1.5]" | ||
|
|
There was a problem hiding this comment.
An error occurred while parsing the file: maths/polynomials/legendre.py
Traceback (most recent call last):
File "/opt/render/project/src/algorithms_keeper/parser/python_parser.py", line 146, in parse
reports = lint_file(
^^^^^^^^^^
libcst._exceptions.ParserSyntaxError: Syntax Error @ 40:1.
parser error: error at 39:4: expected one of +, -, ..., AWAIT, False, NAME, NUMBER, None, True, lambda, not, ~
"The 2nd Legendre polynomial should be [-0.5, 0.0, 1.5]"
^
algorithms-keeper
bot
added
require descriptive names
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
maths/polynomials/legendre.py
Outdated
| from numpy.polynomial import Polynomial | ||
|
|
||
|
|
||
| def legendre(n: int) -> [float]: |
There was a problem hiding this comment.
Please provide descriptive name for the parameter: n
maths/polynomials/legendre.py
Outdated
| return legendre_polynomial.deriv(n).coef.tolist() | ||
|
|
||
|
|
||
| def test_legendre_0(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_0. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| assert legendre(0) == [1.0], "The 0th Legendre polynomial should be [1.0]" | ||
|
|
||
|
|
||
| def test_legendre_1(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_1. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| assert legendre(1) == [0.0, 1.0], "The 1st Legendre polynomial should be [0.0, 1.0]" | ||
|
|
||
|
|
||
| def test_legendre_2(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_2. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| "The 2nd Legendre polynomial should be [-0.5, 0.0, 1.5]" | ||
|
|
||
|
|
||
| def test_legendre_3(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_3. If the function does not return a value, please provide the type hint as: def function() -> None:
maths/polynomials/legendre.py
Outdated
| "The 3rd Legendre polynomial should be [0.0, -1.5, 0.0, 2.5]" | ||
|
|
||
|
|
||
| def test_legendre_4(): |
There was a problem hiding this comment.
Please provide return type hint for the function: test_legendre_4. If the function does not return a value, please provide the type hint as: def function() -> None:
algorithms-keeper
bot
removed
the
require type hints
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
maths/polynomials/legendre.py
Outdated
| from numpy.polynomial import Polynomial | ||
|
|
||
|
|
||
| def legendre(n: int) -> [float]: |
There was a problem hiding this comment.
Please provide descriptive name for the parameter: n
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
maths/polynomials/legendre.py
Outdated
| from numpy.polynomial import Polynomial | ||
|
|
||
|
|
||
| def legendre(n: int) -> List[float]: |
There was a problem hiding this comment.
Please provide descriptive name for the parameter: n
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
| from numpy.polynomial import Polynomial | ||
|
|
||
|
|
||
| def legendre(n: int) -> list[float]: |
There was a problem hiding this comment.
Please provide descriptive name for the parameter: n
algorithms-keeper
bot
added
tests are failing
Describe your change:
This implementation provides a method to compute the coefficients of Legendre polynomials of degree n. Legendre polynomials are a sequence of orthogonal polynomials widely used in physics and engineering, particularly in solving differential equations and performing spherical harmonic expansions. The algorithm uses a recursive relation to derive the coefficients efficiently, ensuring numerical stability and correctness.
https://en.wikipedia.org/wiki/Legendre_polynomials
Checklist: