Data Structures and Algorithms in C++ & Python

About This Project

This project is based on the book "Data Structures and Algorithms in C++", "Intro to Python for Computer Science and Data Science: Learning to Program with AI, Big Data and The Cloud".

Download Submodules

This project uses GoogleTest and HippoMocks to create test codes (e.g., unit test). In this repository, GoogleTest and HippoMocks are included as the submodule. You can download the submodules with

$ git submodule update --init

Then, please locate each submodule's directory and reference their README.md to install the related programs. For GoogleTest,

$ cd googletest        # Main directory of the cloned GoogleTest repository.
$ mkdir build          # Create a directory to hold the build output.
$ cd build
$ cmake ..             # Generate native build scripts for GoogleTest.
$ make
$ sudo make install    # Install GoogleTest in /usr/local/ by default

For HippoMocks,

$ cd hippomocks        # Main directory of the cloned HippoMocks repository.
$ sudo make install    # Install HippoMocks in /usr/include/ by default.

Build and Debug the C++ Program

Before starting to build or debug this project, you might need to be familiar with the visual studio code tutorial. Also, a C++11 compiler is required for compilation.

Build

Build methods are explained below.

1. Visual Studio Code-based Method.

• You may need to modify the compiler's path in the tasks.json file in the .vscode directory.
• Click Run Build Task in the Terminal tab.

2. Command line-based Method.

By referring the contents of tasks.json file in the .vscode directory, input the below command,

$ g++ -O3 -g -Wall -Werror -fopenmp -I Cplusplus/include/ \
    Cplusplus/source/*/*.cpp Cplusplus/source/*.cpp \
    -o Cplusplus/bin/project_entry

Run this from the workspace root. Cplusplus/source/*/*.cpp are all of the module sources, and Cplusplus/source/*.cpp is the entry point (Main.cpp) plus ProjectConfiguration.cpp. Any C++11 compiler can replace g++; -Werror turns warnings into errors, matching tasks.json.

3. Build and run a unit test (command line).

Each test file compiles to its own executable, linking the module sources, ProjectConfiguration.cpp, the single test file, and the GoogleTest/HippoMocks libraries installed in the Download Submodules section above (there is no aggregate test runner). For example,

$ g++ -O0 -g -Wall -Werror -fopenmp -I Cplusplus/include/ \
    Cplusplus/source/*/*.cpp Cplusplus/source/ProjectConfiguration.cpp \
    Cplusplus/test/LinkedList/SinglyLinkedList_UnitTest.cpp \
    -lgtest -lgtest_main -lgmock -lgmock_main \
    -o Cplusplus/bin/SinglyLinkedList_UnitTest
$ ./Cplusplus/bin/SinglyLinkedList_UnitTest

Swap in any file under Cplusplus/test/ to run a different suite. In VS Code, the equivalent is the Build active test by specified optimization task.

Debug

Debug methods are explained below.

1. Visual Studio Code-based Method.

• You may need to modify the debugger's path in the launch.json file in the .vscode directory.
• Click Start Debugging in the Run tab.

2. Command line-based Method.

By referring the contents of launch.json file in the .vscode directory, input the below command,

$ gdb --args ./Cplusplus/bin/project_entry --help

The executable is compiled with -g, so it is ready for gdb (or load it through launch.json in VS Code).

Run C++ Program

According to the build setting in the /tasks.json file, input the command like,

$ Cplusplus/bin/project_entry

where [project_entry] is the executable file's name.

Miscellaneous

...