lzcomplexity 0.9.6

LempelZiv-76 complexity engine. Suited for complexity analysis of time series.

lzcomplexity: the LempelZiv analysis library

lzcomplexity

lzcomplexity is a C++ library that provides a suite of entropy measures for time series data, based on the Lempel-Ziv 76 (LZ76) factorization algorithm.

Prerequisites

• CMake version >= 3.5
• C++20 compatible compiler:
  • apple-clang >= 14
  • clang >= 17
  • GNU >= 9.4

Prepare the Local Workspace

The project uses the submodules oneTBB for parallel works and pybind11 for building the Python binding of the library.

1. Initialize the submodules:

git submodule init

2. Clone the submodules into your local directory:

git submodule update --recursive

3. Apply the oneTBB patch:

patch external/tbb/CMakeLists.txt patches/tbb.patch 

Build and install locally

---

1. Create a build directory and navigate to it:

mkdir build && cd build

2. Configure the build process using CMake:

cmake -DCMAKE_BUILD_TYPE=Release ..

3. Build and install the library:

make install
lzcomplexity

CMake Options

---

• BUILTIN_TBB (OFF by default): use local oneTBB project instead of system one.
• LZ_SHARE (ON by default): build shared library.
• LZ_ONLY_LIBS (OFF by default): build only the libraries (lzcore, lzapp and lzdist).
• LZ_ONLY_CORE (OFF by default): build only the core library.
• LZ_APP (ON by default): build the lzcomplexity standalone application.
• LZ_DISTANCE (ON by default): build the lzdistance standalone application.
• BUILD_PYTHON (OFF by default): enable python binding.
• ASAN (OFF by default): configure the build with sanitizer for debug the application (only for clang).
• ENABLE_ADDRESS_SANITIZER (OFF by default): activate the sanitizer address option for detect memory error.
• ENABLE_MEMORY_SANITIZER (OFF by default): activate the sanitizer memory option for detect uninitialized memory reads.
• ENABLE_UNDEFINED_SANITIZER (OFF by default): activate the sanitizer undefined option for detect undefined behavior.

Example Usage

C++ Example

#include <lz/lempelziv.h>

int main() {
    lz::sequence seq = "some data sequence";
    int result = lz::lz76Factorization(seq);
    double entropy = lz::lz76EntropyDensity(seq);
    std::cout << "LZ76 Complexity: " << result << std::endl;
    std::cout << "Entropy density: " << entropy << std::endl;
    return 0;
}

Python Example

import lzcomplexity as lz

seq = "some data sequence"
result = lz.lz76(seq)
print("LZ76 Complexity:", result.complexity)
print("Entropy density:", result.entropy)

License

---

This project is licensed under the MIT License - see the LICENSE file for details.