Compare commits

...

12 Commits

Author SHA1 Message Date
5b69fe25b4 Link from Day 5 2025-10-24 20:34:06 +00:00
97d4d9c9a7 Fix #12
accidentally opening a jupyter notebook in api/
caused apidoc to try to incorporate that into
the api docs.
2025-10-24 15:10:13 -05:00
e3ffd2210b Merge pull request 'Implement Unit Testing for fancymath' (#8) from unit_tests into main
Reviewed-on: #8
2025-10-24 17:10:58 +00:00
aa7dc496dc Merge pull request 'Add subtests for test_cross_product.' (#11) from test/vector-cross-subtests into unit_tests
Reviewed-on: #11
Reviewed-by: Tim Diller <tim@dillerdigital.com>
2025-10-24 16:09:11 +00:00
Corran Webster
66123f6064 Add subtests for test_cross_product. 2025-10-24 16:54:47 +01:00
913169fe68 Merge pull request 'unit_tests_ambar' (#10) from unit_tests_ambar into unit_tests
Reviewed-on: #10
Reviewed-by: Tim Diller <tim@dillerdigital.com>
2025-10-24 15:42:56 +00:00
5850743394 Merge branch 'unit_tests' into unit_tests_ambar 2025-10-24 10:42:22 -05:00
79b6c10b70 Corrected syntax for vecotr.abs() test 2025-10-24 11:38:26 -04:00
491c531ed8 Merge pull request 'Add cross-product and tests' (#9) from enh/cross-product into unit_tests
Reviewed-on: #9
2025-10-24 15:25:26 +00:00
Corran Webster
437be17f51 Add cross product impleimentation 2025-10-24 16:21:50 +01:00
b613241807 Add unit test for Vector.abs 2025-10-24 11:17:40 -04:00
35a1705570 Add unit test for Vecotr.abs method 2025-10-24 11:10:39 -04:00
5 changed files with 42 additions and 12 deletions

1
.gitignore vendored
View File

@@ -4,3 +4,4 @@
*.egg-info
doc/_build/
*.ipynb_checkpoints/
fancymath.log

View File

@@ -50,3 +50,6 @@ $ pip install -e .
python -m line_profiler -rmt module_to_profile.py.lprof
> python -m line_profiler -rmt module_to_profile.py.lprof
```
# Day 5 Resources
- [5 Worlds](https://www.joelonsoftware.com/2002/05/06/five-worlds/) from Joel Spolsky's blog.

View File

@@ -17,7 +17,13 @@ release = '0.0.1'
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.ipynb_checkpoints']
exclude_patterns = [
'_build',
'Thumbs.db',
'.DS_Store',
'.ipynb_checkpoints',
'api/.ipynb_checkpoints'
]

View File

@@ -36,6 +36,14 @@ class Vector(object):
z = self.z + other.z
return self.__class__(x, y, z)
def __mul__(self, other):
if not isinstance(other, Vector):
return NotImplemented
x = self.y * other.z - self.z * other.y
y = self.z * other.x - self.x * other.z
z = self.x * other.y - self.y * other.x
return self.__class__(x, y, z)
if __name__ == "__main__":
v1 = Vector(3, 4, 0)

View File

@@ -5,18 +5,22 @@ from fancymath.vector import Vector
class TestVector(unittest.TestCase):
def test_cross_product(self):
# given
v1 = Vector(1, 2, 3)
v2 = Vector(3, 2, 1)
# Dictionary of (v1, v2): v3
values = {
(Vector(1, 2, 3), Vector(3, 2, 1)): Vector(-4, 8, -4),
(Vector(0, 0, 0), Vector(1, 2, 3)): Vector(0, 0, 0),
(Vector(1, 0, 0), Vector(1, 0, 0)): Vector(0, 0, 0),
}
# when
v3 = v1 * v2
for inputs, expected in values.items():
v1, v2 = inputs
with self.subTest(v1=v1, v2=v2):
v3 = v1 * v2
# then
self.assertIsInstance(v3, Vector)
self.assertEqual(v3.x, -4)
self.assertEqual(v3.y, 8)
self.assertEqual(v3.z, -4)
self.assertIsInstance(v3, Vector)
self.assertEqual(v3.x, expected.x)
self.assertEqual(v3.y, expected.y)
self.assertEqual(v3.z, expected.z)
def test_cross_product_failure(self):
v1 = Vector(1, 2, 3)
@@ -33,6 +37,14 @@ class TestVector(unittest.TestCase):
self.assertIsInstance(v3, Vector)
self.assertEqual(v3.x, v1.x + v2.x)
def test_abs(self):
v1 = Vector(0, 0, 0)
v2 = Vector(1, 2, 2)
v3 = Vector(1, -2, 2)
self.assertEqual(v1.abs(), 0)
self.assertEqual(v2.abs(), 3)
self.assertEqual(v2.abs(), v3.abs())
def test_dot_failure(self):
with self.assertRaises(ValueError):
v1 = Vector(1, 2, 3)