README.md

cpp-xor-list

C++11-compatible header-only implementation of XOR linked list with STL-like interface. Most of C++14 std::list methods are also supported.

Notes

Not supported methods:

• std::erase_if - will be added after C++20 release

Example

#include <xor_list/xor_list.h>
#include <iostream>

template<typename Range>
void printRange(Range &&range)
{
    for (auto &&val : range)
    {
        std::cout << val << ' ';
    }
}

int main(int argc, char *argv[])
{
    xor_list<int> list, list2{5, 6, 1, 6, 2, 4, 0};

    list.push_back(2);
    list.push_back(0);
    list.push_front(-1);
    list.push_back(1);

    // Will print "-1 2 0 1 "
    printRange(list);
    std::cout << std::endl;

    list.sort();
    list2.sort();

    list2.merge(list);

    // Will print "-1 0 0 1 1 2 2 4 5 6 6 "
    printRange(list2);
    std::cout << std::endl;

    // Nothing will be printed (list is empty)
    printRange(list);

    return 0;
}

Requirements

• Using the library:
  • C++11-compatible compiler
• For running tests, you need:
  • git
  • CMake >= v3.1
  • Additionally, if you want to measure code coverage, you need:
    • compiler, gcov [, optional: lcov] compatible with each other (for example, gcc 6.3.0, gcov 6.3.0 and lcov 1.13 are compatible)
    • genhtml
    • CMake >= v3.13

Build and run tests

See Requirements chapter first.

Just use CMake (run from project root):

# Build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

# Running tests
ctest -C Release -V

# You can also run benchmarks (example for Release build configuration):
#Release/sort_performance.exe

Note: This project uses GoogleTest for testing.

Code coverage measurement

See Requirements chapter first.

CMake scripts provides the next additional variables for setting up the measurement:

• COLLECT_CODE_COVERAGE=<LCOV|OTHER|OFF> - if set to LCOV then code coverage target collect_coverage will be created. OTHER assumes compiling/linking code for measuring via different than lcov instrument (gcov for example). OFF does nothing and set by default.
• GCOV_PATH - allows to specify path to gcov executable. gcov by default.

It's recommended to build the code in Debug mode for coverage measurement.

Example (run from project root):

# Build
cd build
cmake -DCMAKE_BUILD_TYPE=Debug \
-DCMAKE_C_COMPILER=gcc-6.3.0 \
-DCMAKE_CXX_COMPILER=g++-6.3.0 \
-DCOLLECT_CODE_COVERAGE=LCOV \
-DGCOV_PATH=gcov-6.3.0 \
..

# Collecting the coverage:
cmake --build . --target collect_coverage

# Html reports will be generated. Use browser to see it:
<your_browser_name> ./collect_coverage/index.html &