$25
CS30-Project 1 Solved
Project 1: The Year of the Quarantine
Apparently, 2020 didn’t get the memo. Every year, we like to celebrate milestones. That might be a graduation, whether it’s kindergarten, high school, or college. There were supposed to be weddings, whether here or at a destination. Most importantly, I was supposed to celebrate my 40th birthday during the summer. Big blowout, big barbecue, friends getting back together, enjoying memories, great food, and maybe one (or more) adult beverages. Alas, 2020 isn’t having any of that. In fact, every celebration is pretty much being sponsored by Zoom, Google Meet, or WebEx. In other words, it’s the Year of the Quarantine. Nevertheless, I’m going to celebrate…and you’ll be celebrating with me. I’m still going to have a big guest list, just virtually.
To help me out, you will write the implementation of the BirthdayParty using a doubly linked list, which should be sorted alphabetically according to last name, then first name. You will also implement a couple of algorithms that operate on a BirthdayParty. Implement BirthdayParty
Consider the following BirthdayParty interface:
typedef std::string BirthdayType;
class BirthdayParty
{ public:
BirthdayParty(); // Create an empty BirthdayParty list
bool noInvitees() const; // Return true if the BirthdayParty list // is empty, otherwise false.
int whosOnTheGuestList() const; // Return the number of players in
// the BirthdayParty list.
bool addInvitee(const std::string& firstName, const std::string& lastName, const BirthdayType& value);
// If the full name (both the first and last name) is not equal
// to any full name currently in the list then add it and return
// true. Elements should be added according to their last name.
// Elements with the same last name should be added according to
// their first names. Otherwise, make no change to the list and // return false (indicating that the name is already in the // list).
bool modifyInvitee(const std::string& firstName, const std::string& lastName, const BirthdayType& value);
// If the full name is equal to a full name currently in the
// list, then make that full name no longer map to the value it // currently maps to, but instead map to the value of the third // parameter; return true in this case. Otherwise, make no // change to the list and return false.
bool addOrModify(const std::string& firstName, const std::string& lastName, const BirthdayType& value);
// If full name is equal to a name currently in the list, then
// make that full name no longer map to the value it currently
// maps to, but instead map to the value of the third parameter;
// return true in this case. If the full name is not equal to
// any full name currently in the list then add it and return // true. In fact, this function always returns true.
bool dropFromGuestList(const std::string& firstName, const std::string& lastName);
// If the full name is equal to a full name currently in the
// list, remove the full name and value from the list and return // true. Otherwise, make no change to the list and return // false.
bool personOnGuestList(const std::string& firstName, const std::string& lastName) const;
// Return true if the full name is equal to a full name // currently in the list, otherwise false.
bool checkGuestList(const std::string& firstName, const std::string& lastName, BirthdayType& value) const;
// If the full name is equal to a full name currently in the
// list, set value to the value in the list that that full name // maps to, and return true. Otherwise, make no change to the // value parameter of this function and return false.
bool selectInvitee(int i, std::string& firstName, std::string& lastName, BirthdayType& value) const;
// If 0 <= i < size(), copy into firstName, lastName and value
// parameters the corresponding information of the element at
// position i in the list and return true. Otherwise, leave the
// parameters unchanged and return false. (See below for details
// about this function.)
void changeGuestList(BirthdayParty& other);
// Exchange the contents of this list with the other one. };
The addInvitee function primarily places elements so that they are sorted in the list based on last name. If there are multiple entries with the same last name then those elements, with the same last name, are added so that they are sorted by their first name. In other words, this code fragment
BirthdayParty theLastDance;
theLastDance.addInvitee ("Michael", "Jordan", 23); theLastDance.addInvitee ("Scottie", "Pippen", 33); theLastDance.addInvitee ("Dennis", "Rodman", 91); theLastDance.addInvitee ("Luc", "Longley", 13); theLastDance.addInvitee ("Ron", "Harper", 9);
for (int n = 0; n < theLastDance.whosOnTheGuestList(); n++)
{ string first; string last; int val; theLastDance.selectInvitee (n, first, last, val); cout << first << " " << last << " " << val << endl;
}
must result in the output:
Ron Harper 9
Michael Jordan 23 Luc Longley 13
Scottie Pippen 33
Dennis Rodman 91
Notice that the empty string is just as good a string as any other; you should not treat it in any special way:
BirthdayParty dodgers; dodgers.addInvitee("Clayton", "Kershaw", 31.0); dodgers.addInvitee("Cody", "Bellinger", 11.5); assert(!dodgers.personOnGuestList ("","")); dodgers.addInvitee("Mookie", "Betts", 27.0); dodgers.addInvitee("", "", 0.57); dodgers.addInvitee("Justin", "Turner", 20.0); assert(dodgers.personOnGuestList ("", "")); dodgers.dropFromGuestList("Mookie", "Betts"); assert(dodgers.whosOnTheGuestList() == 4
&& dodgers.personOnGuestList("Clayton", "Kershaw")
&& dodgers.personOnGuestList ("Cody", "Bellinger")
&& dodgers.personOnGuestList ("Justin", "Turner")
&& dodgers.personOnGuestList ("", ""));
When comparing keys for addInvitee, modifyInvitee, addOrModify, dropFromGuestList, personOnGuestList, and checkGuestList, just use the == or != operators provided for the string type by the library. These do case-sensitive comparisons, and that's fine.
For this project, implement this BirthdayParty interface using a doubly-linked list. (You must not use any container from the C++ library.)
For your implementation, if you let the compiler write the destructor, copy constructor, and assignment operator, they will do the wrong thing, so you will have to declare and implement these public member functions as well:
Destructor
When a BirthdayParty is destroyed, all dynamic memory must be deallocated.
Copy Constructor
When a brand new BirthdayParty is created as a copy of an existing BirthdayParty, a deep copy should be made.
Assignment Operator
When an existing BirthdayParty (the left-hand side) is assigned the value of another BirthdayParty (the right-hand side), the result must be that the left-hand side object is a duplicate of the right-hand side object, with no memory leak (i.e. no memory from the old value of the left-hand side should be still allocated yet inaccessible).
Notice that there is no a priori limit on the maximum number of elements in the
BirthdayParty (so addOrModify should always return true). Also, if a BirthdayParty has a size of n, then the values of the first parameter to the selectInvitee member function are 0, 1, 2, ..., n – 1; for other values, it returns false without setting its parameters.
Implement Some Non-Member Functions
Using only the public interface of BirthdayParty, implement the following two functions. (Notice that they are non-member functions; they are not members of BirthdayParty or any other class.)
bool combineGuestLists(const BirthdayParty & bpOne, const BirthdayParty & bpTwo,
BirthdayParty & bpJoined);
When this function returns, bpJoined must consist of pairs determined by these rules:
If a full name appears in exactly one of bpOne and bpTwo, then bpJoined must contain an element consisting of that full name and its corresponding value.
If a full name appears in both bpOne and bpTwo, with the same corresponding value in both, then bpJoined must contain an element with that full name and value.
When this function returns, bpJoined must contain no elements other than those required by these rules. (You must not assume bpJoined is empty when it is passed in to this function; it might not be.)
If there exists a full name that appears in both bpOne and bpTwo, but with different corresponding values, then this function returns false; if there is no full name like this, the function returns true. Even if the function returns false, result must be constituted as defined by the above rules.
For example, suppose a BirthdayParty maps the full name to integers. If bpOne consists of these three elements
"Kobe" "Bryant" 8 "AC" "Green" 45 "Shaquille" "Oneal" 34 and bpTwo consists of
"Kobe" "Bryant" 8 "Horace" "Grant" 54
then no matter what value it had before, bpJoined must end up as a list consisting of
"Kobe" "Bryant" 8 "Horace" "Grant" 54 "AC" "Green" 45
"Shaquille" "Oneal" 34
and combineGuestLists must return true.
If instead, bpOne consists of
"Kobe" "Bryant" 8 "AC" "Green" 45 "Shaquille" "Oneal" 34 and bpTwo consists of
"Kobe" "Bryant" 24 "Pau" "Gasol" 16
then no matter what value it had before, bpJoined must end up as a list consisting of
"Pau" "Gasol" 16 "AC" "Green" 45 "Shaquille" "Oneal" 34
and combineGuestLists must return false.
void verifyGuestList (const std::string& fsearch, const std::string& lsearch, const BirthdayParty& bpOne,
BirthdayParty& bpResult);
When this function returns, bpResult must contain a copy of all the elements in bpOne that match the search terms; it must not contain any other elements. You can wildcard the first name, last name or both by supplying "*". (You must not assume result is empty when it is passed in to this function; it may not be.)
For example, if memories consists of the three elements
"Gianna" "Bryant" 13 "Kobe" "Bryant" 41 "Little" "Richard"
87 "Jerry" "Stiller" 92 and the following call is made:
verifyGuestList("*", "Bryant", memories, bpResult);
then no matter what value it had before, bpResult must end up as a BirthdayParty consisting of
"Gianna" "Bryant" 13 "Kobe" "Bryant" 41
If instead, moreMemories were
"Kirk" "Douglas" 103 "Fred" "Neal" 77 "Pop" "Smoke" 20
"Fred" "Willard" 86
and the following call is made:
verifyGuestList("Fred", "*", moreMemories, result);
then no matter what value it had before, result must end up as a list consisting of
"Fred" "Neal" 77 "Fred" "Willard" 86
If the following call is made:
verifyGuestList("*", "*", memories, result);
then no matter what value it had before, result must end up being a copy of memories.
Be sure these functions behave correctly in the face of aliasing: What if moreMemories and result refer to the same BirthdayParty, for example?
Other Requirements
Regardless of how much work you put into the assignment, your program will receive a low score for correctness if you violate these requirements:
• Your class definition, declarations for the two required non-member functions, and the implementations of any functions you choose to inline must be in a file named BirthdayParty.h, which must have appropriate include guards. The implementations of the functions you declared in BirthdayParty.h that you did not inline must be in a file named BirthdayParty.cpp. Neither of those files may have a main routine (unless it's commented out). You may use a separate file for the main routine to test your BirthdayParty class; you won't turn in that separate file.
• Except to add a destructor, copy constructor, assignment operator, and dump function (described below), you must not add functions to, delete functions from, or change the public interface of the BirthdayParty class. You must not declare any additional struct/class outside the BirthdayParty class, and you must not declare any public struct/class inside the BirthdayParty class. You may add whatever private data members and private member functions you like, and you may declare private structs/classes inside the BirthdayParty class if you like. The source files you submit for this project must not contain the word friend. You must not use any global variables whose values may be changed during execution.
• If you wish, you may add a public member function with the signature void dump() const. The intent of this function is that for your own testing purposes, you can call it to print information about the map; we will never call it. You do not have to add this function if you don't want to, but if you do add it, it must not make any changes to the map; if we were to replace your implementation of this function with one that simply returned immediately, your code must still work correctly. The dump function must not write to cout, but it's allowed to write to cerr.
• Your code must build successfully (either Xcode or Visual C++) if linked with a file that contains a main routine, but it must also use standard C++.
• You must have an implementation for every member function of
BirthdayParty, as well as the non-member functions combineGuestLists and verifyGuestList. Even if you can't get a function implemented correctly, it must have an implementation that at least builds successfully. For example, if you don't have time to correctly implement
BirthdayParty::dropFromGuestList or verifyGuestList, say, here
are implementations that meet this requirement in that they at least build successfully:
bool BirthdayParty::dropFromGuestList(const std::string& fname, const std::string& lname)
{ return false; // not correct, but at least this code compiles
}
void verifyGuestList(const std::string& fsearch, const std::string& lsearch, const BirthdayParty& bpOne, BirthdayParty& bpResult)
{ return; // not correct, but at least this code compiles }
You've probably met this requirement if the following file compiles and links with your code. (This uses magic beyond the scope of CS 30.)
#include "BirthdayParty.h"
#include <type_traits>
#define CHECKTYPE(f, t) { auto p = (t)(f); (void)p; }
static_assert(std::is_default_constructible<BirthdayParty>::valu e,
"Map must be default-constructible.");
static_assert(std::is_copy_constructible<BirthdayParty>::value,
"Map must be copy-constructible.");
void ThisFunctionWillNeverBeCalled()
{
CHECKTYPE(&BirthdayParty::operator=, BirthdayParty&
(BirthdayParty::*)(const BirthdayParty&));
CHECKTYPE(&BirthdayParty::noInvitees, bool
(BirthdayParty::*)() const);
CHECKTYPE(&BirthdayParty::whosOnTheGuestList, int
(BirthdayParty::*)() const);
CHECKTYPE(&BirthdayParty::addInvitee, bool (BirthdayParty::*)
(const std::string&, const std::string&, const
BirthdayType&));
CHECKTYPE(&BirthdayParty::modifyInvitee, bool
(BirthdayParty::*)(const std::string&, const std::string&, const BirthdayType&));
CHECKTYPE(&BirthdayParty::addOrModify, bool
(BirthdayParty::*)(const std::string&, const std::string&, const BirthdayType&));
CHECKTYPE(&BirthdayParty::dropFromGuestList, bool
(BirthdayParty::*)
(const std::string&, const std::string&));
CHECKTYPE(&BirthdayParty::personOnGuestList, bool
(BirthdayParty::*)(const std::string&, const std::string&) const);
CHECKTYPE(&BirthdayParty::checkGuestList, bool
(BirthdayParty::*)
(const std::string&, const std::string&, BirthdayType&) const);
CHECKTYPE(&BirthdayParty::selectInvitee, bool
(BirthdayParty::*)
(int, std::string&, std::string&, BirthdayType&) const);
CHECKTYPE(&BirthdayParty::changeGuestList, void
(BirthdayParty::*)(BirthdayParty&));
CHECKTYPE(combineGuestLists, bool (*)(const BirthdayParty&, const
BirthdayParty&, BirthdayParty&));
CHECKTYPE(verifyGuestList, void (*)(const std::string&, const std::string&, const BirthdayParty&, BirthdayParty&));
}
int main()
{}
If you add #include <string> to BirthdayParty.h, have the typedef define
BirthdayType as std::string, and link your code to a file containing
#include "BirthdayParty.h"
#include <string>
#include <iostream> #include <cassert> using namespace std;
void test()
{
BirthdayParty aListCommissioners;
assert(aListCommissioners.addInvitee("Adam", "Silver",
"asilver@nba.com")); assert(aListCommissioners.addInvitee("Roger", "Goodell",
"rgoodell@nfl.com")); assert(aListCommissioners.whosOnTheGuestList() == 2);
string first, last, e;
assert(aListCommissioners.selectInvitee(0, first, last, e)
&& e == "rgoodell@nfl.com"); assert(aListCommissioners.selectInvitee(1, first, last, e)
&& (first == "Adam" && e == "asilver@nba.com"));
return; }
int main() { test(); cout << "Passed all tests" << endl; return 0;
}
the linking must succeed. When the resulting executable is run, it must write Passed all tests to cout and nothing else to cout.
If we successfully do the above, then make no changes to BirthdayParty.h other than to change the typedefs for BirthdayParty so that BirthdayType specifies int, recompile BirthdayParty.cpp, and link it to a file containing
#include " BirthdayParty.h"
#include <string>
#include <iostream> #include <cassert> using namespace std;
void test()
{
BirthdayParty terribleCommissioners;
assert(terribleCommissioners.addInvitee("Gary", "Bettman",
68)); assert(terribleCommissioners.addInvitee("Robert", "Manfred",
61)); assert(terribleCommissioners.whosOnTheGuestList() == 2);
string first, last; int a; assert(terribleCommissioners.selectInvitee(0, first, last, a)
&& a == 68); assert(terribleCommissioners.selectInvitee(1, first, last, a)
&& (first == "Robert" && a == 61));
return;
} int main() { test(); cout << "Passed all tests" << endl; return 0;
}
the linking must succeed. When the resulting executable is run, it must write Passed all tests to cout and nothing else to cout.
During execution, if a client performs actions whose behavior is defined by this spec, your program must not perform any undefined actions, such as dereferencing a null or uninitialized pointer.
Your code in BirthdayParty.h and BirthdayParty.cpp must not read anything from cin and must not write anything whatsoever to cout. If you want to print things out for debugging purposes, write to cerr instead of cout. cerr is the standard error destination; items written to it by default go to the screen. When we test your program, we will cause everything written to cerr to be discarded instead — we will never see that output, so you may leave those debugging output statements in your program if you wish.
Grading
Here is the grading scale for the amount you can earn on this project for picking a data structure.
Data Structure
Possible Points
Dynamically resizable array
126 (out of 140)
Linked list (singly)
140
Linked list (doubly)
147 (up to 7 extra credit points)
Binary tree
147 (up to 7 extra credit points)
Hash table
154 (up to 14 extra credit points)
Turn It In
There will be a link on Canvas that will enable you to turn in your source files and report. You will turn in a zip file containing these files:
• BirthdayParty.h. When you turn in this file, the typedefs must specify std::string as the BirthdayType.
• BirthdayParty.cpp. Function implementations should be appropriately commented to guide a reader of the code.
• A file named report.doc or report.docx (in Microsoft Word format) or report.pdf that contains:
o A description of the design of your implementation and why you chose it. (A couple of sentences will probably suffice, perhaps with a picture of a typical List and an empty List. Is your list circular? Does it have a dummy node? What's in your nodes?)
o A brief description of notable obstacles you overcame. o Pseudocode for non-trivial algorithms (e.g.,
BirthdayParty::dropFromGuestList and combineGuestLists)
o A list of test cases that would thoroughly test the functions. Be sure to indicate the purpose of the tests. For example, here's the beginning of a presentation in the form of code:
The tests were performed on a map from strings to integers:
// default constructor
BirthdayParty lal; // For an empty list: assert(lal.whosOnTheGuestList() == 0); // test size assert(lal.noInvitees()); // test empty assert(!lal.dropFromTheGuestList("JR", "Smith")); // nothing to erase
Even if you do not correctly implement all the functions, you must still list test cases that would test them. Don't lose points by thinking "Well, I didn't implement this function, so I won't bother saying how I would have tested it if I had implemented it."
