Initial commit

This commit is contained in:
Tyler Beckman 2024-11-06 16:49:37 -07:00
commit 15fe835cc8
Signed by: Ty
GPG key ID: 2813440C772555A4
13 changed files with 653 additions and 0 deletions

43
.clang-format Normal file
View file

@ -0,0 +1,43 @@
# Tyler's personal code-style formatting file, make sure to use the class version before turning in
IndentWidth: 4
UseTab: Always
TabWidth: 4
InsertBraces: false
SortIncludes: true
IncludeBlocks: Regroup
IncludeCategories:
# System headers from C (hardcoded, it isn't really possible to automatically detect them with regex)
- Regex: '<c(assert|complex|ctype|errno|fenv|float|inttypes|iso646|limits|locale|math|setjmp|signal|stdalign|stdarg|stdatomic|stdbool|stddef|stdint|stdio|stdlib|stdnoreturn|string|tgmath|threads|time|uchar|wchar|wctype)>'
Priority: 3
# System headers without extension.
- Regex: '<([A-Za-z0-9\Q/-_\E])+>'
Priority: 2
# Local headers with extension.
- Regex: '"([A-Za-z0-9\Q/-_\E])+\.h(pp)?"'
Priority: 1
BraceWrapping:
AfterCaseLabel: false
AfterClass: false
AfterControlStatement: Never
AfterEnum: false
AfterFunction: false
AfterNamespace: false
AfterObjCDeclaration: false
AfterStruct: false
AfterUnion: false
AfterExternBlock: false
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
SplitEmptyFunction: false
SplitEmptyRecord: false
SplitEmptyNamespace: false
IndentCaseLabels: true
IntegerLiteralSeparator:
Binary: 0
Decimal: 3
Hex: -1
DerivePointerAlignment: false
PointerAlignment: Right
QualifierAlignment: Left

43
.class-clang-format Normal file
View file

@ -0,0 +1,43 @@
# A clang-format config to follow CSCI200's style guide, use before turning in
IndentWidth: 2
UseTab: Never
TabWidth: 2
InsertBraces: true
SortIncludes: true
IncludeBlocks: Regroup
IncludeCategories:
# System headers from C
- Regex: '<c(assert|complex|ctype|errno|fenv|float|inttypes|iso646|limits|locale|math|setjmp|signal|stdalign|stdarg|stdatomic|stdbool|stddef|stdint|stdio|stdlib|stdnoreturn|string|tgmath|threads|time|uchar|wchar|wctype)>'
Priority: 3
# System headers without extension.
- Regex: '<([A-Za-z0-9\Q/-_\E])+>'
Priority: 2
# Local headers with extension.
- Regex: '"([A-Za-z0-9\Q/-_\E])+\.h(pp)?"'
Priority: 1
BraceWrapping:
AfterCaseLabel: false
AfterClass: false
AfterControlStatement: Never
AfterEnum: false
AfterFunction: false
AfterNamespace: false
AfterObjCDeclaration: false
AfterStruct: false
AfterUnion: false
AfterExternBlock: false
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
SplitEmptyFunction: false
SplitEmptyRecord: false
SplitEmptyNamespace: false
IndentCaseLabels: true
IntegerLiteralSeparator:
Binary: -1
Decimal: -1
Hex: -1
DerivePointerAlignment: false
PointerAlignment: Left
QualifierAlignment: Left

4
.gitignore vendored Normal file
View file

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

18
.vscode/c_cpp_properties.json vendored Normal file
View file

@ -0,0 +1,18 @@
{
"configurations": [
{
"name": "linux-gcc-x64",
"includePath": [
"${workspaceFolder}/**"
],
"compilerPath": "/usr/bin/gcc",
"cStandard": "${default}",
"cppStandard": "${default}",
"intelliSenseMode": "linux-gcc-x64",
"compilerArgs": [
""
]
}
],
"version": 4
}

24
.vscode/launch.json vendored Normal file
View file

@ -0,0 +1,24 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "C/C++ Runner: Debug Session",
"type": "cppdbg",
"request": "launch",
"args": [],
"stopAtEntry": false,
"externalConsole": false,
"cwd": "/home/ty/Dev/School/CSCI200/Template",
"program": "/home/ty/Dev/School/CSCI200/Template/build/Debug/outDebug",
"MIMode": "gdb",
"miDebuggerPath": "gdb",
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": true
}
]
}
]
}

59
.vscode/settings.json vendored Normal file
View file

@ -0,0 +1,59 @@
{
"C_Cpp_Runner.cCompilerPath": "gcc",
"C_Cpp_Runner.cppCompilerPath": "g++",
"C_Cpp_Runner.debuggerPath": "gdb",
"C_Cpp_Runner.cStandard": "",
"C_Cpp_Runner.cppStandard": "",
"C_Cpp_Runner.msvcBatchPath": "",
"C_Cpp_Runner.useMsvc": false,
"C_Cpp_Runner.warnings": [
"-Wall",
"-Wextra",
"-Wpedantic",
"-Wshadow",
"-Wformat=2",
"-Wcast-align",
"-Wconversion",
"-Wsign-conversion",
"-Wnull-dereference"
],
"C_Cpp_Runner.msvcWarnings": [
"/W4",
"/permissive-",
"/w14242",
"/w14287",
"/w14296",
"/w14311",
"/w14826",
"/w44062",
"/w44242",
"/w14905",
"/w14906",
"/w14263",
"/w44265",
"/w14928"
],
"C_Cpp_Runner.enableWarnings": true,
"C_Cpp_Runner.warningsAsError": false,
"C_Cpp_Runner.compilerArgs": [],
"C_Cpp_Runner.linkerArgs": [],
"C_Cpp_Runner.includePaths": [],
"C_Cpp_Runner.includeSearch": [
"*",
"**/*"
],
"C_Cpp_Runner.excludeSearch": [
"**/build",
"**/build/**",
"**/.*",
"**/.*/**",
"**/.vscode",
"**/.vscode/**"
],
"C_Cpp_Runner.useAddressSanitizer": false,
"C_Cpp_Runner.useUndefinedSanitizer": false,
"C_Cpp_Runner.useLeakSanitizer": false,
"C_Cpp_Runner.showCompilationTime": false,
"C_Cpp_Runner.useLinkTimeOptimization": false,
"C_Cpp_Runner.msvcSecureNoWarnings": false
}

25
Box.cpp Normal file
View file

@ -0,0 +1,25 @@
#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() { return _size; }
void Box::setBoxSize(const double SIZE) {
// if desired size is positive, assign
if (SIZE > 0) {
_size = SIZE;
}
}

48
Box.h Normal file
View file

@ -0,0 +1,48 @@
#ifndef BOX_H
#define BOX_H
/**
* @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(); // 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;
};
#endif // BOX_H

41
LICENSE.md Normal file
View file

@ -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.

84
Makefile Normal file
View file

@ -0,0 +1,84 @@
TARGET = L4A
SRC_FILES = Box.cpp Warehouse.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 -pedantic-errors
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
main.o: main.cpp Warehouse.h Box.h
Warehouse.o: Warehouse.cpp Warehouse.h Box.h
Box.o: Box.cpp Box.h

87
Warehouse.cpp Normal file
View file

@ -0,0 +1,87 @@
/**
* @author Tyler Beckman (tyler_beckman@mines.edu)
* @brief A program to store boxes of custom size into a warehouse,
* using pointers and proper memory-management techniques.
* @version 1
* @date 2024-10-22
*/
#include "Warehouse.h"
#include "Box.h"
#include <iostream>
#include <vector>
using namespace std;
Warehouse::Warehouse() {
_pBoxen = new vector<Box *>;
_warehouseLetter = '?';
}
Warehouse::Warehouse(const Warehouse &OTHER) {
this->_pBoxen = new std::vector<Box *>;
this->_warehouseLetter = OTHER._warehouseLetter;
for (size_t i = 0; i < OTHER._pBoxen->size(); i++) {
this->_pBoxen->push_back(new Box(OTHER._pBoxen->at(i)->getBoxSize()));
}
}
Warehouse &Warehouse::operator=(const Warehouse &OTHER) {
// Check for self assignment
if (this == &OTHER) {
return *this;
}
std::cout << "hi" << std::endl;
// Clear existing contents
for (size_t i = 0; i < this->_pBoxen->size(); i++) {
delete this->_pBoxen->at(i);
}
this->_pBoxen->clear();
// Deep copy OTHER into this
for (size_t i = 0; i < OTHER._pBoxen->size(); i++) {
this->_pBoxen->push_back(new Box(OTHER._pBoxen->at(i)->getBoxSize()));
}
this->_warehouseLetter = OTHER._warehouseLetter;
return *this;
}
Warehouse::~Warehouse() {
for (size_t i = 0; i < this->_pBoxen->size(); i++) {
delete this->_pBoxen->at(i);
}
delete this->_pBoxen;
}
void Warehouse::storeInBox(const int SIZE) {
_pBoxen->push_back(new Box(SIZE));
}
Box *Warehouse::getBox(const int BOX_POS) const { return _pBoxen->at(BOX_POS); }
int Warehouse::getNumberOfBoxes() const { return _pBoxen->size(); }
char Warehouse::getWarehouseLetter() const { return _warehouseLetter; }
void Warehouse::setWarehouseLetter(const char warehouseLetter) {
_warehouseLetter = warehouseLetter;
}
std::ostream &operator<<(ostream &os, const Warehouse &WH) {
os << "Warehouse " << WH.getWarehouseLetter() << " has "
<< WH.getNumberOfBoxes() << " boxes (";
for (int i = 0; i < WH.getNumberOfBoxes(); i++) {
os << WH.getBox(i)->getBoxSize();
if (i < WH.getNumberOfBoxes() - 1) {
os << ", ";
}
}
os << ")";
return os;
}

83
Warehouse.h Normal file
View file

@ -0,0 +1,83 @@
#ifndef WAREHOUSE_H
#define WAREHOUSE_H
#include "Box.h"
#include <ostream>
#include <vector>
/**
* @brief takes in sized things and puts them into boxes. stores
* all the boxes internally
*
*/
class Warehouse {
public:
/**
* @brief Construct a new Warehouse object with
* no boxes by default
*
*/
Warehouse();
/**
* @brief Construct a new Warehouse object with the exact contents
* of the OTHER warehouse
*
* @param OTHER The warehouse to copy contents from
*/
Warehouse(const Warehouse &OTHER);
/**
* @brief Deep copies all data from one warehouse to the other
*
* @param OTHER The warehouse to copy from
* @return Warehouse& A reference to the current warehouse
*/
Warehouse &operator=(const Warehouse &OTHER);
/**
* @brief Destroy the Warehouse object, freeing up all memory
*
*/
~Warehouse();
/**
* @brief puts the item into a Box of given size
* @param SIZE size of the cube shaped box to store
*/
void storeInBox(const int SIZE);
/**
* @brief Get the Box object at given position within the list
* @param BOX_POS position within the list to retrieve
* @return Box* pointer to the corresponding Box object
*/
Box *getBox(const int BOX_POS) const;
/**
* @brief Get the Number Of Boxes object
*
* @return int
*/
int getNumberOfBoxes() 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<Box *> *_pBoxen;
/**
* @brief Warehouse letter identifier
*/
char _warehouseLetter;
};
std::ostream &operator<<(std::ostream &, const Warehouse &);
#endif // WAREHOUSE_H

94
main.cpp Normal file
View file

@ -0,0 +1,94 @@
#include "Warehouse.h"
#include <iostream>
using namespace std;
void print_warehouse(Warehouse wh) { cout << wh << endl; }
int main() {
Warehouse warehouseH;
warehouseH.setWarehouseLetter('H');
warehouseH.storeInBox(4);
warehouseH.storeInBox(2);
cout << "> Made Warehouse H with 2 boxes of sizes 4 and 2" << endl;
cout << warehouseH << endl;
Warehouse warehouseC;
warehouseC.setWarehouseLetter('C');
warehouseC.storeInBox(3);
cout << endl << "> Made Warehouse C with 1 box of size 3" << endl;
cout << warehouseC << endl;
warehouseC = warehouseH;
warehouseC.setWarehouseLetter('C');
cout << endl
<< "> Used copy assignment operator to copy from H to C, both have 2 "
"boxes of sizes 4 and 2"
<< endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
warehouseH.storeInBox(3);
cout << endl
<< "> Added box of size 3 to H, H has 3 boxes and C has 2 boxes"
<< endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
warehouseC.storeInBox(7);
cout << endl
<< "> Adding box of size 7 to C, H has 3 boxes and C has 3 boxes"
<< endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
warehouseH.getBox(1)->setBoxSize(15);
cout << endl << "> Changed H Box 1 from size 2 to size 15" << endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
Warehouse warehouseD(warehouseH);
warehouseD.setWarehouseLetter('D');
cout << endl
<< "> Used copy constructor to construct D from H, both have 3 boxes "
"of "
"sizes 4 15 and 3"
<< endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
cout << warehouseD << endl;
warehouseH.storeInBox(5);
cout << endl
<< "> Added box of size 5 to H, H has 4 boxes, C has 3 boxes, and D "
"has "
"3 boxes"
<< endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
cout << warehouseD << endl;
warehouseD.storeInBox(6);
cout << endl
<< "> Added box of size 6 to D, H has 4 boxes and D has 4 boxes"
<< endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
cout << warehouseD << endl;
warehouseH.getBox(2)->setBoxSize(25);
cout << endl << "> Changed H Box 2 from size 3 to size 25" << endl;
cout << warehouseH << endl;
cout << warehouseC << endl;
cout << warehouseD << endl;
cout << endl
<< "> Passing objects to function by value to print (copy constructor "
"and destructor implicitly called)"
<< endl;
print_warehouse(warehouseH);
print_warehouse(warehouseC);
print_warehouse(warehouseD);
return 0;
}