Initial commit

.gitignore

@@ -0,0 +1,4 @@
+# Packed files
+./*.tar.gz
+# Built object files
+./**/*.o

Box.cpp

@@ -0,0 +1,26 @@
+#include "Box.h"
+
+Box::Box() {
+    // initialize to unit cube by default
+    _size = 1.0;
+}
+
+Box::Box(const double SIZE) {
+    // if desired size is positive, assign
+    if(SIZE > 0) _size = SIZE;
+    // otherwise default to one
+    else _size = 1.0;
+}
+
+double Box::getBoxSize() const {
+    return _size;
+}
+void Box::setBoxSize(const double SIZE) {
+    // if desired size is positive, assign
+    if(SIZE > 0) _size = SIZE;
+}
+
+std::ostream& operator<<(std::ostream& os, const Box& BOX) {
+    os << BOX.getBoxSize();
+    return os;
+}

Box.h

@@ -0,0 +1,52 @@
+#ifndef BOX_H
+#define BOX_H
+
+#include <ostream>
+
+/**
+ * @brief Stores the size of a Box
+ * 
+ */
+class Box {
+public: // we'll explain momentarily
+    /**
+     * @brief Construct a new Box object
+     * of unit dimensions
+     * 
+     */
+    Box(); // default constructor
+    
+    /**
+     * @brief Construct a new Box object
+     * for given dimension.  If dimension
+     * is not positive, defaults dimension to 1
+     * 
+     * @param SIZE size of the Box
+     */
+    Box(const double SIZE); // parameterized constructor
+
+    /**
+     * @brief Get the Size of the Box
+     * 
+     * @return double current Box size
+     */
+    double getBoxSize() const; // accessor - getter
+    /**
+     * @brief Set the Size only
+     * if positive
+     * 
+     * @param SIZE size to set on Box
+     */
+    void setBoxSize(const double SIZE);// mutator - setter
+
+private:    
+    /**
+     * @brief current Box size
+     * 
+     */
+    double _size;
+};
+
+std::ostream& operator<<(std::ostream&, const Box&);
+
+#endif//BOX_H

LICENSE.md

@@ -0,0 +1,41 @@
+# Creative Commons CC0 1.0 Universal
+
+CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER.
+
+## Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. __Copyright and Related Rights.__ A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
+
+    i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
+
+    ii. moral rights retained by the original author(s) and/or performer(s);
+
+    iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
+
+    iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
+
+    v. rights protecting the extraction, dissemination, use and reuse of data in a Work;
+
+    vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
+
+    vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
+
+2. __Waiver.__ To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. __Public License Fallback.__ Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
+
+4. __Limitations and Disclaimers.__
+
+    a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
+
+    b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
+
+    c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
+
+    d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.

Makefile

@@ -0,0 +1,83 @@
+TARGET = L4B
+SRC_FILES = Box.cpp main.cpp
+
+# Tyler's custom makefile extensions for CSCI200 (anyone can use these if they want)
+.DEFAULT_GOAL := all # Necessary so `make` doesn't run the "pack" target, as it is declared before "all"
+.PHONY: pack clean-run c run fmt
+
+## Adds only the necessary files for build into a .tar.gz file, named appropriately
+ARCHIVED_FILES = Makefile $(SRC_FILES) $(SRC_FILES:.cpp=.h) $(SRC_FILES:.cpp=.hpp)
+pack: fmtc
+	tar --ignore-failed-read -czvf $(TARGET).tar.gz Warehouse.*
+
+## Runs the pack target and then attempts to build & run the program to make sure it functions correctly
+pack-test: pack
+	$(eval TMP := $(shell mktemp -d))
+	tar -xvzf $(TARGET).tar.gz --directory $(TMP)
+	make -C $(TMP)
+	$(TMP)/$(TARGET)
+	rm -rf $(TMP)
+
+## An extension of the clean command that is shorter to type and removes a potential .tar.gz file
+c: clean
+	$(DEL) -f $(TARGET).tar.gz
+
+## Simply builds and then executes the program
+run: all
+	./$(TARGET)
+
+## Formats all cpp, h, and hpp files with clang-format, using my personal clang-format config
+fmt:
+	find . -iname '*.hpp' -o -iname '*.h' -o -iname '*.cpp' | xargs clang-format --style=file:.clang-format -i
+
+## Formats all cpp, h, and hpp files with clang-format, using the class clang-format config
+fmtc:
+	find . -iname '*.hpp' -o -iname '*.h' -o -iname '*.cpp' | xargs clang-format --style=file:.class-clang-format -i
+
+## Modifies the SRC_FILES variable to have all .cpp files in the repo
+setupsrc:
+	sed -i "0,/SRC_FILE.\{0\}S = .*/ s//SRC_FILES = $(shell find . -iname '*.cpp' -printf '%P\n')/" Makefile
+
+## Alias to setup SRC_FILES and then dependencies
+setup: setupsrc depend
+
+# NO EDITS NEEDED BELOW THIS LINE
+
+CXX = g++
+CXXFLAGS = -Wall -Wextra -Werror -Wunreachable-code -Wshadow -Wpedantic
+CXXFLAGS_DEBUG = -g
+CXXVERSION = -std=c++17
+
+OBJECTS = $(SRC_FILES:.cpp=.o)
+
+ifeq ($(shell echo "Windows"), "Windows")
+	TARGET := $(TARGET).exe
+	DEL = del
+	Q=
+else
+	DEL = rm -f
+	Q="
+endif
+
+all: $(TARGET)
+
+$(TARGET): $(OBJECTS)
+	$(CXX) -o $@ $^
+
+.cpp.o:
+	$(CXX) $(CXXFLAGS) $(CXXVERSION) $(CXXFLAGS_DEBUG) -o $@ -c $<
+
+clean:
+	$(DEL) $(TARGET) $(OBJECTS) Makefile.bak
+
+depend:
+	@sed -i.bak '/^# DEPENDENCIES/,$$d' Makefile
+	@$(DEL) sed*
+	@echo $(Q)# DEPENDENCIES$(Q) >> Makefile
+	@$(CXX) -MM $(SRC_FILES) >> Makefile
+
+.PHONY: all clean depend
+
+# DEPENDENCIES
+Box.o: Box.cpp Box.h
+main.o: main.cpp Warehouse.hpp

Warehouse.cpp

@@ -0,0 +1,46 @@
+#include "Warehouse.h"
+
+Warehouse::Warehouse() {
+    _pItems = new std::vector<Box*>;
+}
+
+Warehouse::~Warehouse() {
+    while( !_pItems->empty() ) {
+        delete _pItems->back();
+        _pItems->pop_back();
+    }
+    delete _pItems;
+}
+
+void Warehouse::store(const int ITEM) {
+    _pItems->push_back( new Box(ITEM) );
+}
+
+Box& Warehouse::retrieve(const size_t ITEM_POS) const {
+    return *(_pItems->at(ITEM_POS));
+}
+
+size_t Warehouse::getNumberOfItems() const {
+    return _pItems->size();
+}
+
+char Warehouse::getWarehouseLetter() const {
+    return _warehouseLetter;
+}
+
+void Warehouse::setWarehouseLetter(const char warehouseLetter) {
+    _warehouseLetter = warehouseLetter;
+}
+
+std::ostream& operator<<(std::ostream& os, const Warehouse& WH) {
+    const size_t NUM_ITEMS = WH.getNumberOfItems();
+    os << "Warehouse " << WH.getWarehouseLetter() << " has " << NUM_ITEMS << " items (";
+    for(size_t i = 0; i < NUM_ITEMS; i++) {
+        os << WH.retrieve(i);
+        if(i < NUM_ITEMS - 1) {
+            os << ", ";
+        }
+    }
+    os << ")";
+    return os;
+}

Warehouse.hpp

@@ -0,0 +1,132 @@
+#ifndef WAREHOUSE_HPP
+#define WAREHOUSE_HPP
+
+// Since this is depended on in main.cpp this has to be here even though
+// Box.h is not directly used in this file :c
+#include "Box.h"
+
+#include <ostream>
+#include <vector>
+
+/**
+ * @brief takes in things and puts them into a list.  stores all the items internally
+ */
+template<typename T>
+class Warehouse {
+public:
+    /**
+     * @brief Construct a new Warehouse object with no items by default
+     */
+    Warehouse();
+    /**
+     * @brief Don't allow a Warehouse to be copied
+     */
+    Warehouse(const Warehouse&) = delete;
+    /**
+     * @brief Don't allow a Warehouse to be copied
+     */
+    Warehouse& operator=(const Warehouse&) = delete;
+    /**
+     * @brief Destroy the Warehouse object
+     */
+    ~Warehouse();
+
+    /**
+     * @brief puts the item into the warhouse
+     * @param ITEM item to store
+     */
+    void store(const T ITEM);
+
+    /**
+     * @brief Get the item at given position with the warehouse
+     * @param ITEM_POS position to retrieve
+     * @return T& corresponding item
+     */
+    T& retrieve(const size_t ITEM_POS) const;
+
+    /**
+     * @brief Get the Number Of items
+     * @return int 
+     */
+    size_t getNumberOfItems() const;
+    /**
+     * @brief retrieves the warehouse letter identifier
+     * @return char warehouse letter identifier
+     */
+    char getWarehouseLetter() const;
+    /**
+     * @brief sets the warehouse letter identifier
+     * @param warehouseLetter letter to identify warehouse by
+     */
+     void setWarehouseLetter(char warehouseLetter);
+private:
+    /**
+     * @brief holds a list of pointers to Boxes
+     * 
+     */
+    std::vector<T*>* _pItems;
+    /**
+     * @brief Warehouse letter identifier
+     */
+    char _warehouseLetter;
+};
+
+template<typename T>
+std::ostream& operator<<(std::ostream&, const Warehouse<T>&);
+
+//----------------------------------------------------------------------------
+
+template<typename T>
+Warehouse<T>::Warehouse() {
+    _pItems = new std::vector<T*>;
+}
+
+template<typename T>
+Warehouse<T>::~Warehouse() {
+    while( !_pItems->empty() ) {
+        delete _pItems->back();
+        _pItems->pop_back();
+    }
+    delete _pItems;
+}
+
+template<typename T>
+void Warehouse<T>::store(const T ITEM) {
+    _pItems->push_back( new T(ITEM) );
+}
+
+template<typename T>
+T& Warehouse<T>::retrieve(const size_t ITEM_POS) const {
+    return *(_pItems->at(ITEM_POS));
+}
+
+template<typename T>
+size_t Warehouse<T>::getNumberOfItems() const {
+    return _pItems->size();
+}
+
+template<typename T>
+char Warehouse<T>::getWarehouseLetter() const {
+    return _warehouseLetter;
+}
+
+template<typename T>
+void Warehouse<T>::setWarehouseLetter(const char warehouseLetter) {
+    _warehouseLetter = warehouseLetter;
+}
+
+template<typename T>
+std::ostream& operator<<(std::ostream& os, const Warehouse<T>& WH) {
+    const size_t NUM_ITEMS = WH.getNumberOfItems();
+    os << "Warehouse " << WH.getWarehouseLetter() << " has " << NUM_ITEMS << " items (";
+    for(size_t i = 0; i < NUM_ITEMS; i++) {
+        os << WH.retrieve(i);
+        if(i < NUM_ITEMS - 1) {
+            os << ", ";
+        }
+    }
+    os << ")";
+    return os;
+}
+
+#endif//WAREHOUSE_HPP

expectedoutput.txt

@@ -0,0 +1,11 @@
+Made Warehouse H with 2 boxes
+Warehouse H has 2 items (4, 2)
+
+Setting Box 0 to size 5
+Warehouse H has 2 items (5, 2)
+
+Made Warehouse C with 3 strings
+Warehouse C has 3 items (This, Is, template)
+
+Manipulating strings 1 and 2
+Warehouse C has 3 items (This, is, templated.)

main.cpp

@@ -0,0 +1,33 @@
+#include "Warehouse.hpp"
+
+#include <iostream>
+#include <string>
+using namespace std;
+
+int main() {
+  cout << "Made Warehouse H with 2 boxes" << endl;
+  Warehouse<Box> warehouseH;
+  warehouseH.setWarehouseLetter('H');
+  warehouseH.store( Box(4) );
+  warehouseH.store( Box(2) );
+  cout << warehouseH << endl;
+
+  cout << endl << "Setting Box 0 to size 5" << endl;
+  warehouseH.retrieve(0).setBoxSize(5);
+  cout << warehouseH << endl;
+
+  cout << endl << "Made Warehouse C with 3 strings" << endl;
+  Warehouse<string> warehouseC;
+  warehouseC.setWarehouseLetter('C');
+  warehouseC.store( "This" );
+  warehouseC.store( "Is" );
+  warehouseC.store( "template" );
+  cout << warehouseC << endl;
+
+  cout << endl << "Manipulating strings 1 and 2" << endl;
+  warehouseC.retrieve(1) = "is";
+  warehouseC.retrieve(2) += "d.";
+  cout << warehouseC << endl;
+
+  return 0;
+}