mp_lists

Direct links to Part 1 and Part 2

Goals

In this MP (machine problem) you will:

• learn to manipulate linked memory by writing functions to modify linked lists
• practice debugging more complex code
• practice using templates
• get familiar with iterators

Checking Out the Code

All assignments will be distributed via our release repo on github this semester. You will need to have set up your git directory to have our release as a remote repo as described in our git set up

You can merge the assignments as they are released into your personal repo with

git pull --no-edit --no-rebase release main
git push

if you are using multiple machines you may need to use the following to allow them to work correcly.

git pull --no-edit --no-rebase release main --allow-unrelated-histories
git push

The first git command will fetch and merge changes from the main branch on your remote repository named release into your personal. The --no-edit flag automatically generates a commit message for you, and the--no-rebase flag will merge the upstream branch into the current branch. Generally, these two flags shouldn’t be used, but are included for ease of merging assignments into your repo.

The second command will push to origin (your personal), which will allow it to track the new changes from release.

You will need to run these commands for every assignment that is released.

All the files for this lab are in the mp_lists directory.

Preparing Your Code

This semester for MPs we are using CMake rather than just make. This allows for us to use libraries such as Catch2 that can be installed in your system rather than providing them with each assignment. This change does mean that for each assignment you need to use CMake to build your own custom makefiles. To do this you need to run the following in the base directory of the assignment. Which in this assignment is the mp_lists directory.

mkdir build
cd build

This first makes a new directory in your assignment directory called build. This is where you will actually build the assignment and then moves to that directory. This is not included in the provided code since we are following industry standard practices and you would normally exclude the build directory from any source control system.

Now you need to actually run CMake as follows.

cmake ..

This runs CMake to initialize the current directory which is the build directory you just made as the location to build the assignment. The one argument to CMake here is .. which referes to the parent of the current directory which in this case is top of the assignment. This directory has the files CMake needs to setup your assignment to be build.

At this point you can in the build directory run make as described to build the various programs for the MP.

You will need to do the above once for each assignment. You will need to run make every time you change source code and want to compile it again.

Background Information: Template Classes

Identical to what you saw in lecture, template classes provide the ability to create generic container classes. In this MP, you will be writing a List class.

template <typename T>
class List {
    // implementation
};

This simply says that our class List has a parametrized type that we will call T. Similarly, the constructor will look like this:

template <typename T>
List<T>::List() {
    // implementation
}

We need the template <typename T> or template <class T> above all of our functions—it becomes part of the function signature. The keywords class and typename can be interchanged.

Template classes need access to the implementation for compilation. Every time a different class is used as the template, the code must be compiled to support containing it. For example, if you want to make a List<int>, the compiler must take the generic List<T> implementation code and replace all the Ts with ints inside it, and compile the result (this process is called template instantiation). Our solution to this is to #include "List.hpp" at the bottom of our List.h file, and not include List.h in our List.hpp file. This ensures that whenever a client includes our header file, he/she also gets the implementation as well for compilation purposes (there are other solutions, but this is how we will solve it in this course).

Background Information: Linked Lists

The interface of this List class is slightly different from what you have seen in lecture. This List has no sentinel nodes; the first node’s prev pointer, and the last node’s next pointer, are both NULL. In lieu of these sentinels, we keep a pointer head to the first node, and a pointer tail to the last node in the List. (In an empty list, both head and tail are NULL.) The List class also has an integer member variable, length, which represents the number of nodes in the List; you will need to maintain this variable.

Background Information: Iterators

If you are not familiar with iterators, please read our notes here. We use iterators to figure out where we currently are in the list, what is the next/previous node, and to access the data. Iterator class has one member variable, namely a pointer to the node in the list. Some of the core functionality includes moving the pointer, getting current location, and checking the location of the iterator.

Background Information: GDB

We have a reference guide for GDB here. You should read through it to get an idea of how to start gdb, what commands you have available, etc.

To summarize a bit, you could run:

gdb --args ./test "[part=1]"

to debug the part one test cases with gdb,

gdb --args ./test "*insert*"

to debug all the tests with “insert” in their name.

Once you start gdb to execute the tests you want to run, you can set breakpoints to help you debug. For example, we could set a breakpoint at the beginning of a test case we want to debug, or breakpoint(s) at the beginning or end of functions which are not behaving as we expect. For example, if we are failing the insertFront test, we could add a breakpoint at the end of the insertFront function and see if the list looks how we expect. This will let us know whether to focus our debugging on exactly what the function is doing, or what the test case is doing after this call to insertFront.

For example, we can set a breakpoint in line 25 of our List class like so:

(gdb) b List.hpp:25

or a breakpoint in line 50 of the part 1 test cases like so:

(gdb) b tests/tests_part1.cpp:50

We can also set breakpoints using function names:

(gdb) b main

sets a breakpoint at the beginning of main, and

(gdb) b List<int>::sort()

sets a breakpoint at the beginning of the sort function. You can tab complete this, so for example after typing b List<int>::ins you can press tab to see a list of possible functions starting with ins in the List class, templatized with int.

Remember that Catch will print not only the name of a failing test case, but also what file the test was in and the line number of the failing assertion. You can use this to decide which tests to run and where you might want to set breakpoints.

Part 1: Debugging & Implementing Linked Lists

In your mp_lists folder, you will find that the List class is split into four .h or .hpp files:

• List.h
• List.hpp
• List-ListIterator.hpp
• List-given.hpp

We have provided a partial implementation of a few List functions for this part of the MP. Some functions are written, and some are unwritten. Those functions which are already coded may have a few bugs in them! This part of the MP is to help get you used to debugging certain kinds of logical and memory related bugs, as well as writing pointer manipulation code. All the functions are specified in List.h, and their (potentially empty) implementations are in List.hpp or List-ListIterator.hpp for you to write.

You should use gdb, valgrind, and any other debugging tools or techniques you’re comfortable with to complete the first part of this MP (as well as general debugging in Part 2 and beyond).

See the Doxygen for details of the List class.

valgrind ./lists
valgrind ./test [part=1]

./test "List::reverse"
./test "*insert*"
valgrind ./test "*insert*"
gdb --args ./test "*insert*"

List()

This should default construct the list. Keep in mind everything mentioned in the background for the Linked List class.

~List() and _destroy()

Since the List class has dynamic memory associated with it, we need to define all of the Rule of Three. We have provided you with the Copy Constructor and overloaded operator=.

• You will need to implement the _destroy() helper function called by operator= (the assignment operator) and the destructor ~List()
• The _destroy() function should free all memory allocated for ListNode objects.

Insertion

The insertFront Function

(See the Doxygen for insertFront.)

• This function takes a data element and prepends it to the beginning of the list.
• If the list is empty before insertFront is called, the list should have one element with the same value as the parameter.
• You may allocate new ListNodes.

< 5 4 7 >

< 6 5 4 7 >

The insertBack Function

(See the Doxygen for insertBack.)

• This function takes a data element and appends it to the end of the list.
• If the list is empty before insertBack is called, the list should have one element with the same value as the parameter.
• You may allocate new ListNodes.

< 5 4 7 >

< 5 4 7 6 >

Testing Your insert Functions

Once you have completed insertFront and insertBack, you should compile and test them. These tests do not rely on your iterator

make test
./test "List::insertFront*"
./test "List::insertBack*"
./test "List::insert*"

Iterator

In order to provide the client code with the ability to read the data from the list in a uniform way, we need to have an iterator. We have provided a list iterator class List-ListIterator.hpp which has some functionality implemented. However, there are a few functions yet to be written as well as some functions with buggy implementations! You will need to worry about all the functions with a @TODO comment:

• ListIterator& operator++()
• ListIterator operator++(int)
• ListIterator& operator--()
• ListIterator operator--(int)
• bool operator!=(const ListIterator& rhs)

You will also need to implement the begin() and end() functions in List.hpp to have a way of obtaining an iterator from a List.

Many of the more advanced functionality will be tested by using your iterator. So, you should make sure to debug and implement these after you have finished your insert functions but before you start working too much on the later functionality.

The split Helper Function

(See the Doxygen for split.)

• This function takes in a pointer start and an integer splitPoint and splits the chain of ListNodes into two completely distinct chains of ListNodes after splitPoint many nodes.
• The split happens after splitPoint number of nodes, making that the head of the new sublist, which should be returned. In effect, there will be splitPoint number of nodes remaining in the current list.
• You may NOT allocate new ListNodes

list1 = < 1 2 3 4 5 >

list1 == < 1 2 >
list2 == < 3 4 5 >

Testing Your split Function

Once you have completed split, you should compile and test it.

make test
./test "List::split*"

You should see images actual-split_*.png created in the working directory (these are generated by repeatedly splitting split.png). Compare them against expected-split_*.png.

The waterfall Function

(See the Doxygen for waterfall.)

• This function modifies the list in a cascading manner as follows.
• Every other node (starting from the second one) is removed from the list, but appended at the back, becoming the new tail.
• This continues until the next thing to be removed is either the tail (not necessarily the original tail!) or NULL.
• You may NOT allocate new ListNodes.
• Note that since the tail should be continuously updated, some nodes will be moved more than once.

< 1 2 3 4 5 6 7 8 >

< 1 3 5 7 2 6 4 8 >

< 1 2 3 4 5 6 7 8 >

< 1 2 3 4 5 6 7 8 > - Skip the 1
  ^             ^
curr           tail

< 1 3 4 5 6 7 8 2 > - Remove the 2 and move it at the end
    ^           ^
  curr         tail

< 1 3 5 6 7 8 2 4 > - Skip the 3, and move the 4 to the end
      ^         ^
    curr       tail

< 1 3 5 7 8 2 4 6 > - Skip the 5 and move the 6 to the end
        ^       ^
      curr     tail

< 1 3 5 7 2 4 6 8 > - Skip the 7 and move the 8 to the end
          ^     ^
        curr   tail

< 1 3 5 7 2 6 8 4 > - We have moved past the original tail of the list.
            ^   ^       This is okay! Skip the 2 and move the 4 to the end,
          curr tail     now for the second time!

< 1 3 5 7 2 6 4 8 > Skip the 6 and move the 8 to the end, now for the second time!
              ^ ^
           curr tail

Testing Your waterfall Function

Once you have completed waterfall, you should compile and test it.

make test
./test "List::waterfall"

Testing Part 1

Compile your code using the following command:

make test

After compiling, you can run all of the part one tests at once with the following command:

./test [part=1]

Extra Credit Submission

For extra credit, you can submit the code you have implemented and tested for part one of mp_lists. Follow the submission instructions section for handing in your code.

Part 2

The reverse Helper Function

(See the Doxygen for reverse.)

In List.hpp you will see that a public reverse method is already defined and given to you. You are to write the helper function that the method calls.

• This function will reverse a chain of linked memory beginning at startPoint and ending at endPoint.
• The startPoint and endPoint pointers should point at the new start and end of the chain of linked memory.
• The next member of the ListNode before the sequence should point at the new start, and the prev member of the ListNode after the sequence should point to the new end.
• You may NOT allocate new ListNodes.

< 1 2 3 4 5 6 7 >

< 7 6 5 4 3 2 1 >

The reverseNth Function

(See the Doxygen for reverseNth.)

• This function accepts as a parameter an integer, \(n\), and reverses blocks of \(n\) elements in the list.
• The order of the blocks should not be changed.
• If the final block (that is, the one containing the tail) is not long enough to have \(n\) elements, then just reverse what remains in the list. In particular, if \(n\) is larger than the length of the list, this will do the same thing as reverse.
• You may NOT allocate new ListNodes.

< 1 2 3 4 5 6 7 8 9 >

< 3 2 1 6 5 4 9 8 7 >

< 1 2 3 4 5 6 >

< 4 3 2 1 6 5 >

Testing Your reverse Functions

Once you have completed reverse and reverseNth, you should compile and test them.

make test
./test "List::reverse"
./test "List::reverseNth #1"
./test "List::reverseNth #2"

Sorting

You will be implementing the helper functions for one more member function of the List template class: sort. This is designed to help you practice pointer manipulation and solve an interesting algorithm problem. In the process of solving this problem, you will implement several helper functions along the way—we have provided public interfaces for these helper functions to help you test your code.

The merge Helper Function

(See the Doxygen for merge.)

• This function takes in two pointers to heads of sublists and merges the two lists into one in sorted order (increasing).
• You can assume both lists are sorted, and the final list should remain sorted.
• You should use operator< on the data fields of ListNode objects. This allows you to perform the comparisons necessary for maintaining the sorted order.
• You may NOT allocate new ListNodes!

list1 = < 1 3 4 6 >
list2 = < 2 5 7 >

list1 == < 1 2 3 4 5 6 7 >
list2 == < >

Testing Your merge Function

Once you have completed merge, you should compile and test it.

make test
./test "List::merge"

You should see the image actual-merge.png created in the working directory if your program terminates properly. This is generated by merging the images tests/merge1.png and tests/merge2.png. Compare this against expected-merge.png.

The mergesort Helper Function

(See the Doxygen for mergesort.)

• This function sorts the list using the merge sort algorithm, explained below.
• You should use operator< on the data fields of ListNode objects. This allows you to perform the comparisons necessary for sorting.
• You should use the private helper functions you wrote above to help you solve this problem.
• You may NOT allocate new ListNodes
• This function’s runtime will be graded for efficiency (correct Big-Oh runtime)

< 6 1 5 8 4 3 7 2 9 >

< 1 2 3 4 5 6 7 8 9 >

Merge Sort — Algorithm Details

Merge Sort is a recursive sorting algorithm that behaves as follows:

• Base Case: A list of size 1 is sorted. Return.
• Recursive Case:
  • Split the current list into two smaller, more manageable parts
  • Sort the two halves (this should be a recursive call)
  • Merge the two sorted halves back together into a single list

In other words, Merge Sort operates on the principle of breaking the problem into smaller and smaller pieces, and merging the sorted, smaller lists together to finally end up at a completely sorted list.

Testing Part 2

Compile your code using the following command:

make test

After compiling, you can run the part two tests at once with the following command:

./test [part=2]

compare out.png out_01.png out_difference.png

Grading Information

You must submit your work to git for grading. We will use the following files for grading:

• List.h
• List.hpp
• List-ListIterator.hpp

All other files including any testing files you have added will not be used for grading.

To submit your assignment you upload these file to the mp_lists questions on PrairieLearn.

Good Luck!