ZSShen / C-Common-Data-Structures

Container Category

• Sequential Container
  • Vector --- The dynamically growable array
  • LinkedList --- The doubly linked list
• Associative Container
  • TreeMap --- The ordered map to store key value pairs
  • HashMap --- The unordered map to store key value pairs
  • HashSet --- The unordered set to store unique elements
  • Trie --- The string dictionary
• Simple Collection Container
  • Queue --- The FIFO queue
  • Stack --- The LIFO stack
  • PriorityQueue --- The queue to maintain priority ordering for elements

Installation

This section illustrates how to install LibCDS to your working directory.

First of all, we need to prepare the CMake build tool:

• CMake - A cross platform build system.

For Ubuntu 12.04 and above, it should be easy:

$ sudo apt-get install -qq cmake

Now we can build the entire source tree under the package root folder:

$ ./clean.py --rebuild
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/your/destination
$ make
$ make install

Upon finishing, the public header should locate at:
/path/to/your/destination/include/
Plus, the shared library should locate at:
/path/to/your/destination/lib/

If you plan for debug build, you can specify the CMake argument list like this:

$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/path/to/your/destination

Usage

This chapter illustrates how to link and apply LibCDS in your project.

For header file, you just need to include the main header:

#include "cds.h"

Assume that you apply gcc for compilation, then you need the following options:

-I/path/to/your/destination/include/
-L/path/to/your/destination/lib/
-lcds

Now you successfully link LibCDS with your project! But wait, to run your project, you need to tell the dynamic linker how to find LibCDS:

LD_LIBRARY_PATH=/path/to/your/destination/lib/

For detailed API usage, you can refer to the manual or check the demo programs.

Benchmark

Thanks for the HashMap benchmark with various key-value pair manipulations provided by kbench. The results are compared with the other 49 similar C data structure libraries.

• Criteria - C style string as hash key
• Platform - Linux nuc 3.2.0-4-amd64 #1 SMP Debian 3.2.81-1 x86_64 GNU/Linux
• Date - Tue Oct 25 13:25:20 CEST 2016
• Result sorted by CPU time

• Result sorted by memory usage

Contact

Please contact me via the mail [email protected].