Cardigan

This is a repository dedicated to implementing algorithms and data structures in C++.

Contents

• Getting started
• Building
• Testing
• Implementation status

Getting started

If you wish to contribute to the repo, then view the contributing guide. Otherwise, you can clone the repo with git clone https://github.com/camilne/cardigan.git. Then, checkout how to build the library and run tests.

Building

Follow these steps (from the root directory of the project) if you wish to build the library.

mkdir build
cd build
cmake ..
make

Testing

Follow these steps (from the root directory of the project) if you with to test the library.

mkdir build
cd build
cmake -Dtests=ON ..
make
./cardigan.test

Implementation status

This section details the current status of the contents of the library.

Feature	Implemented	Has Tests	Location
AVL Tree	☑️	✅	avl.hpp
Binary Search Tree	☑️	✅	bst.hpp
Bubble sort	☑️	✅	bubble_sort.hpp
Euclid's Algorithm	☑️	✅	euclid.hpp
Fisher-Yates shuffle	☑️	✅	fisher_yates.hpp
Longest common substring	☑️	✅	longest_common_substring.hpp
Quicksort	☑️	✅	quicksort.hpp