Completed Term Project Part 1 & 2

SDEV333-Term-Project.iml

@@ -4,8 +4,25 @@
     <exclude-output />
     <content url="file://$MODULE_DIR$">
       <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="module-library" scope="TEST">
+      <library name="JUnit5.8.1">
+        <CLASSES>
+          <root url="jar://$MAVEN_REPOSITORY$/org/junit/jupiter/junit-jupiter/5.8.1/junit-jupiter-5.8.1.jar!/" />
+          <root url="jar://$MAVEN_REPOSITORY$/org/junit/jupiter/junit-jupiter-api/5.8.1/junit-jupiter-api-5.8.1.jar!/" />
+          <root url="jar://$MAVEN_REPOSITORY$/org/opentest4j/opentest4j/1.2.0/opentest4j-1.2.0.jar!/" />
+          <root url="jar://$MAVEN_REPOSITORY$/org/junit/platform/junit-platform-commons/1.8.1/junit-platform-commons-1.8.1.jar!/" />
+          <root url="jar://$MAVEN_REPOSITORY$/org/apiguardian/apiguardian-api/1.1.2/apiguardian-api-1.1.2.jar!/" />
+          <root url="jar://$MAVEN_REPOSITORY$/org/junit/jupiter/junit-jupiter-params/5.8.1/junit-jupiter-params-5.8.1.jar!/" />
+          <root url="jar://$MAVEN_REPOSITORY$/org/junit/jupiter/junit-jupiter-engine/5.8.1/junit-jupiter-engine-5.8.1.jar!/" />
+          <root url="jar://$MAVEN_REPOSITORY$/org/junit/platform/junit-platform-engine/1.8.1/junit-platform-engine-1.8.1.jar!/" />
+        </CLASSES>
+        <JAVADOC />
+        <SOURCES />
+      </library>
+    </orderEntry>
   </component>
 </module>

src/Bag/Bag.java

@@ -0,0 +1,26 @@
+package Bag;
+
+/**
+ * An implementation of the Bag data structure
+ * @param <E> Class may store various types of values
+ * @author Zalman I.
+ */
+public interface Bag<E> extends Iterable<E> {
+    /**
+     * Adds the given item to the bag
+     * @param item the item to be added
+     */
+    void add(E item);
+
+    /**
+     * Checks whether the bag is empty, and returns true/false accordingly
+     * @return true if the bag is empty; otherwise false
+     */
+    boolean isEmpty();
+
+    /**
+     * Gets and returns the number of items stored in the bag
+     * @return the number of items stored in the bag
+     */
+    int size();
+}

src/Bag/LinkedBag.java

@@ -0,0 +1,169 @@
+package Bag;
+
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+/**
+ * Implementation of a Bag using a "list" of nodes and a Bag interface for generics
+ * @param <E> Class may store various types of values
+ * @author Zalman I.
+ */
+public class LinkedBag<E> implements Bag<E> {
+    /**
+     * A container which contains an item and a connection to another Node
+     */
+    private class Node {
+        /**
+         * The item stored within the Node
+         */
+        E item;
+
+        /**
+         * The node this Node is pointing to
+         */
+        Node next;
+
+        /**
+         * Creates a node, and stores the given item within it
+         *
+         * Runtime: O(1) as it always takes the same runtime to conduct this operation
+         *
+         * @param item the item being stored in node
+         */
+        public Node(E item) {
+            // store given item
+            this.item = item;
+
+            // node starts off disconnected
+            next = null;
+        }
+    }
+
+    /**
+     * The first node in bag
+     */
+    private Node first;
+
+    /**
+     * The number of items stored in this bag
+     */
+    private int size;
+
+    /**
+     * Constructs an empty LinkedBag
+     *
+     * Runtime: O(1) as it always takes the same runtime to conduct this operation
+     */
+    public LinkedBag() {
+        // bag starts off empty
+        first = null;
+        size = 0;
+    }
+
+    /**
+     * Adds the given item to the bag
+     *
+     * Runtime: O(1) as we can instantly add a new item to start of list via the first variable,
+     * regardless of how many nodes exist in bag.
+     *
+     * @param item the item to be added
+     */
+    @Override
+    public void add(E item) {
+        // create new node containing given item
+        Node newNode = new Node(item);
+
+        // if the bag is not empty
+        if(!isEmpty()) {
+            // point new node at first, so it isn't lost
+            newNode.next = first;
+        }
+
+        // override first with newly created node
+        // (making new node first node in bag)
+        first = newNode;
+
+        // account for new item in bag
+        size++;
+    }
+
+    /**
+     * Checks whether the bag is empty, and returns true/false accordingly
+     *
+     * Runtime: O(1) as we are instantly accessing variables and checking a condition.
+     * This operation would always take the same runtime to conduct.
+     *
+     * @return true if the bag is empty; otherwise false
+     */
+    @Override
+    public boolean isEmpty() {
+        return size == 0 && first == null;
+    }
+
+    /**
+     * Gets and returns the number of items stored in the bag
+     *
+     * Runtime: O(1) as we are instantly retrieving a variable.
+     * This operation would always take the same runtime to conduct.
+     *
+     * @return the number of items stored in the bag
+     */
+    @Override
+    public int size() {
+        return size;
+    }
+
+    /**
+     * Returns an iterator over elements of type {@code T}.
+     *
+     * @return an Iterator.
+     */
+    @Override
+    public Iterator<E> iterator() {
+        return new LinkedBagIterator();
+    }
+
+    /**
+     * Implementation of an Iterator for the LinkedBag class
+     */
+    private class LinkedBagIterator implements Iterator<E>
+    {
+        /**
+         * The current Node being tracked by the Iterator
+         */
+        private Node current;
+
+        /**
+         * Constructs a LinkedBag iterator, with the first node tracked first
+         */
+        LinkedBagIterator() {
+            current = first;
+        }
+
+        /**
+         * Checks if list contains another element, and returns true/false accordingly
+         * @return true if list contains another element; otherwise false
+         */
+        public boolean hasNext() {
+            return current != null;
+        }
+
+        /**
+         * Gets and returns the first item in the list
+         * @return the first item in the list
+         */
+        public E next() {
+            if(!hasNext()) {
+                throw new NoSuchElementException();
+            }
+
+            // get first item of list
+            E currItem = current.item;
+
+            // move on to the next item
+            current = current.next;
+
+            return currItem;
+        }
+    }
+}

src/Bag/Stats.java

@@ -0,0 +1,44 @@
+package Bag;
+
+import java.util.Scanner;
+
+public class Stats
+{
+    public static void main(String[] args) {
+        // setup storage bag
+        Bag<Double> numbers = new LinkedBag<Double>();
+
+        // setup scanner, taking in given string
+        Scanner line = new Scanner("100 99 101 120 98 107 109 81 101 90");
+
+        // run through line
+        while (line.hasNextDouble()) {
+            // get current item and add to bag
+            numbers.add(line.nextDouble());
+        }
+
+        // track number of items in bag
+        int size = numbers.size();
+
+        // run through bag and add up all items
+        double sum = 0.0;
+        for (double currNum : numbers) {
+            sum += currNum;
+        }
+
+        // get the mean of all numbers in bag
+        double mean = sum / size;
+
+        // clear total tracker and use again to calculate standard dev
+        sum = 0.0;
+        for (double currNum : numbers) {
+            sum += (currNum - mean) * (currNum - mean);
+        }
+
+        double std = Math.sqrt(sum / (size - 1));
+
+        // display calculation results
+        System.out.printf("Mean: %.2f\n", mean);
+        System.out.printf("Std dev: %.2f\n", std);
+    }
+}

src/Deque.java → src/Examples/Deque.java

@@ -1,3 +1,5 @@
+package Examples;
+
 /**
  * Deque: double-ended queue API
  * Supports adding and removing items at both ends.

src/MathSet.java → src/Examples/MathSet.java

@@ -1,3 +1,5 @@
+package Examples;
+
 /**
  * MathSet API (interface / abstract data type)
  * represents a mathematical set. Sets in mathematics