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
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 50 additions & 9 deletions maths/trapezoidal_rule.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

# "extended trapezoidal rule"
# int(f) = dx/2 * (f1 + 2f2 + ... + fn)
h = (boundary[1] - boundary[0]) / steps
Expand All @@ -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?

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?

return y


def make_points(a, b, h):
x = a + h
while x < (b - h):
"""
Yields equally spaced points between a and b
>>> 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
Comment on lines +31 to +41
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


>>> x_i = make_points(0, 1, -0.2)
>>> next(x_i)
Traceback (most recent call last):
...
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

>>> next(x_i)
Traceback (most recent call last):
...
ValueError: a must be less than b
"""
if h <= 0:
raise ValueError("h must be positive")
if a >= b:
raise ValueError("a must be less than b")

x = round(a + h, 10)
while x <= (b - h):
yield x
x = x + h
x = round(x + h, 10)


def f(x): # enter your function here
y = (x - 0) * (x - 0)
return y
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)
Comment on lines +66 to +78
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?



def main():
a = 0.0 # Lower bound of integration
b = 1.0 # Upper bound of integration
steps = 10.0 # define number of steps or resolution
boundary = [a, b] # define boundary of integration
y = method_1(boundary, steps)
y = method_1(lambda x: x**2, boundary, steps)
print(f"y = {y}")


Expand Down