Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.82 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.82 KB

genogrove

CMake Multi Platform Downloads License: GPL v3

genogrove is a C++ library for the Interval B+ Tree (IBPTree) data structure. It provides a simple and efficient way to store and search data in a tree-like structure.

Quick Start

To get started with genogrove, download the source code by either cloning the repository or downloading a release. In the source directory, configure the build by running cmake:

    cmake -S . -B build
    cmake --build build

If required, custom compilers can be specified by adding the option -DCMAKE_CXX_COMPILER=<compiler> and -DCMAKE_C_COMPILER=<compiler>. Note, that the compiler used to build the library must be the same as the one used.

Once you have the source code, change to the source directory and install the library by running the following commands:

    cmake --install build

Optionally, you can specify a custom installation directory by adding the option --prefix <desired/install/path> to the install command.

Usage

To use the library in your project, include the genogrove header file in your source code:

    #include "genogrove/all.hpp"

Create an instance of the IBPTree class and specify the order of the tree (k):

    int k = 3;
    genogrove::IBPTree tree(k);

Register the types of the data you want to store in the tree with the TypeRegistry (e.g., int):

    genogrove::TypeRegistry::registerType<int>();