start on oo assignment

Author: d-chambers

.gitignore

@@ -0,0 +1,70 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# logs:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv python configuration file
+.python-version
+
+# pycharm
+.idea
+
+# linux/osx garbage
+*~
+*.swp
+.DS_store*

README.md

@@ -0,0 +1,12 @@
+# Object-Oriented assignment
+
+Object-oriented (OO) programming and design is an entire semester course (or more). The goal of this
+assignment is to give you an idea how to use basic OO features of python.
+
+# Task 1: 1D array (10 points)
+
+Task1 involved creating a 1D array object pattern after numpy's [ndarray](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html),
+but much less efficient. Start by looking at task_1.py and filling in the implementation details. You
+can see how your implementation is performing by running `pytest test_task_1.py` after installing
+pytest.
+

task_1.py

@@ -0,0 +1,10 @@
+"""
+A module which implements a gloriously inefficient 1D array class.
+"""
+
+
+class Array1D:
+    """
+    This class behaves similar to numpy arrays, but for one dimension.
+    """
+

test_task_1.py

@@ -0,0 +1,34 @@
+"""
+Tests for task_1's Array1D.
+
+You need to first install pytest, then run this from the command line
+via: `pytest test_task_1.py`
+"""
+import pytest
+
+from task_1 import Array1D
+
+INPUT_ARRAYS = (
+    (1, 0, 0, 1),
+    (1j+2, 0, 12),
+    (0.0, 0.00001, 0.0),
+    (None, 10, -10.0),
+    tuple(range(1000)),
+)
+
+
+class TestInit:
+    """Tests for initializing the Array1D with various parameters."""
+
+    def test_empty(self):
+        """Should be able to init empty array."""
+        ar = Array1D()
+        assert isinstance(ar, Array1D)
+
+    @pytest.mark.parametrize("array_input", INPUT_ARRAYS)
+    def test_list(self, array_input):
+        """All INPUT_ARRAY entries should be valid."""
+        ar = Array1D(array_input)
+        assert isinstance(ar, Array1D)
+
+