Skip to content
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

Add doctest to trapezoidal_rule #11274

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kyrtsouv
Copy link

@kyrtsouv kyrtsouv commented Feb 5, 2024

Describe your change:

Contributes to #9943

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass labels Feb 5, 2024
Copy link
Contributor

@imSanko imSanko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recheck the tests

@kyrtsouv
Copy link
Author

kyrtsouv commented Feb 6, 2024

What do you mean? Are the doctests wrong or are you talking about the ruff check failing?
Because I don't know why it fails I didn't change anything to the directories that it checks.

@tianyizheng02
Copy link
Contributor

@kyrtsouv The doctests seem to be fine since the build passes. The ruff errors are probably due to newly added ruff rules—try rebasing your code to get it up-to-date and see if that fixes things.

Copy link
Contributor

@tianyizheng02 tianyizheng02 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from changes requested in my other comments, all of the functions also need type hints

@@ -9,7 +9,7 @@
"""


def method_1(boundary, steps):
def method_1(func, boundary, steps):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is entirely untested

@@ -20,29 +20,70 @@ def method_1(boundary, steps):
y += (h / 2.0) * f(a)
for i in x_i:
# print(i)
y += h * f(i)
y += h * f(func, i)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see the need for the function f. Why not just run func directly?

@@ -20,29 +20,70 @@ def method_1(boundary, steps):
y += (h / 2.0) * f(a)
for i in x_i:
# print(i)
y += h * f(i)
y += h * f(func, i)
y += (h / 2.0) * f(b)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this instance of f meant to be changed to func as well?

Comment on lines +66 to +78
def f(y, x): # enter your function here
"""
Returns the value of a lambda functiοn y at x
>>> f(lambda x: x**2,2)
4
>>> f(lambda x: x**2,-1)
1
>>> f(lambda x: (x+1)/2,5)
3.0
>>> f(lambda x: (x+1)/2,0)
0.5
"""
return y(x)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous comment: why have a wrapper function for a function rather than just running the function directly?

Comment on lines +31 to +41
>>> x_i = make_points(0, 0.4, 0.1)
>>> next(x_i)
0.1
>>> next(x_i)
0.2
>>> next(x_i)
0.3
>>> next(x_i)
Traceback (most recent call last):
...
StopIteration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
>>> x_i = make_points(0, 0.4, 0.1)
>>> next(x_i)
0.1
>>> next(x_i)
0.2
>>> next(x_i)
0.3
>>> next(x_i)
Traceback (most recent call last):
...
StopIteration
>>> x_i = list(make_points(0, 0.4, 0.1))
>>> x_i
[0.1, 0.2, 0.3]

Instead of iterating through the iterator manually, it's simpler to just cast it to a list and check the list

...
ValueError: h must be positive

>>> x_i = make_points(1,0,0.2)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
>>> x_i = make_points(1,0,0.2)
>>> x_i = make_points(1, 0, 0.2)

Minor formatting stuff

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files tests are failing Do not merge until tests pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants