Updates in lecture #11

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

Open

acse-lw521 wants to merge 3 commits into ese-msc-2021:master from acse-lw521:lecture_updates

README.md

-Original file line number
+Diff line change
@@ -1,2 +1,2 @@
     # CI MPM
-    Toy repo for CI lecture.
+    Toy repo for with some simple functions for the CI lecture

simple_functions/__init__.py

-Original file line number
+Diff line change
@@ -1,5 +1,5 @@
     from .functions1 import * # noqa
+    from .constants import * # noqa
     from pkg_resources import get_distribution, DistributionNotFound
     try:
         __version__ = get_distribution(__name__).version
@@ Expand Down @@

simple_functions/constants.py

-Original file line number
+Diff line change
@@ -0,0 +1,15 @@
+    from numpy import sqrt
+    from simple_functions.functions1 import factorial
+    from functools import cache
+    __all__ = ['pi','rsum']
+    def pi(terms=1):
+        return 1./(2.*sqrt(2.)/9801.*rsum(terms))
+    @cache
+    def rsum(n):
+        t = factorial(4*n)*(1103+26390*n)/(factorial(n)**4*396**(4*n))
+        return t + rsum(n-1) if n else t

simple_functions/functions1.py

-Original file line number
+Diff line change
@@ -1,9 +1,15 @@
+    from functools import cache
-    __all__ = ['my_sum']
+    __all__ = ['my_sum','factorial']
     def my_sum(iterable):
         tot = 0
         for i in iterable:
             tot += i
         return tot
+    @cache
+    def factorial(n):
+        return n * factorial(n-1) if n else 1

tests/test_constants.py

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    import numpy as np
+    from simple_functions import pi
+    class TestPi(object):
+        '''Class to test our constants are computed correctly'''
+        def test_pi(self):
+            '''Test computation of pi'''
+            my_pi = pi(2)
+            assert np.isclose(my_pi, np.pi, atol=1e-12)

tests/test_simple_functions.py

-Original file line number
+Diff line change
@@ -1,6 +1,6 @@
     import pytest
-    from simple_functions import my_sum
+    from simple_functions import my_sum,factorial
     class TestSimpleFunctions(object):
@@ Expand All / @@ -14,3 +14,13 @@ def test_my_add(self, iterable, expected): @@
             '''Test our add function'''
             isum = my_sum(iterable)
             assert isum == expected
+        @pytest.mark.parametrize('number, expected', [
+            (5, 120),
+            (3, 6),
+            (1, 1)
+        ])
+        def test_factorial(self, number, expected):
+            '''Test our factorial function'''
+            answer = factorial(number)
+            assert answer == expected

Provide feedback