https://github.com/erikerlandson/st_tree

A fast and flexible c++ template class for tree data structures
https://github.com/erikerlandson/st_tree

c-plus-plus data-structure data-structures standard-template-library stl stl-container tree

Last synced: 3 months ago
JSON representation

A fast and flexible c++ template class for tree data structures

• Host: GitHub
• URL: https://github.com/erikerlandson/st_tree
• Owner: erikerlandson
• License: apache-2.0
• Created: 2010-09-28T02:42:24.000Z (over 14 years ago)
• Default Branch: develop
• Last Pushed: 2022-03-13T01:03:05.000Z (almost 3 years ago)
• Last Synced: 2024-06-13T23:26:44.180Z (8 months ago)
• Topics: c-plus-plus, data-structure, data-structures, standard-template-library, stl, stl-container, tree
• Language: C++
• Homepage: https://github.com/erikerlandson/st_tree/wiki
• Size: 179 KB
• Stars: 91
• Watchers: 8
• Forks: 19
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# st_tree: A fast and flexible c++ template class for tree data structures

![Build Status](https://github.com/erikerlandson/st_tree/workflows/build/badge.svg?branch=develop)

## Introduction

The st_tree library implements a C++ template tree container class for storing data in arbitrary tree structures. st_tree is short for “standard template tree,” and supports STL-compatible interfaces including iterators, allocators and standard STL container methods.

The st_tree library allows the programmer to easily declare and manipulate data in a tree:

```cpp

// declare a tree of integers, where children are stored using a vector storage model

tree t1;  

// declare a tree of strings, where node children are maintained in sorted order

tree > t2;

// declare a tree of floating point, where children are indexed by a string label

tree > t3;

```

## Features

The st_tree template container class provides the following features

* Fully featured standard STL container interface, including standard container methods, iterators, typedefs and allocators

* Common tree-related methods, including `ply()`, `depth()`, `subtree_size()`, `is_root()` and `parent()`

* Computational efficiency — all operations execute in logarithmic time, except those involving deep copy

* Configurable storage models for child nodes — children of a node may be managed using a `vector<>` (“raw”), `multiset<>` (“ordered”) or `map<>` (“keyed”) container model.

* Compiles under standard ANSI C++

* Unit tested

* Memory tested with valgrind

* Open sourced under the Apache 2.0 License

## Documentation

Documentation for the st_tree template container class and its components can be found here:

https://github.com/erikerlandson/st_tree/wiki/st_tree-documentation

The st_tree wiki is here:

https://github.com/erikerlandson/st_tree/wiki

## Install

The st_tree project home is here:

https://github.com/erikerlandson/st_tree

Instructions for download and install are here:

https://github.com/erikerlandson/st_tree/wiki/st_tree-installation-and-building

Quick start:

```sh

# generate makefiles from cmake

$ cd /path/to/st_tree

$ cmake .

# generate makefiles to build examples from cmake

$ cd /path/to/st_tree

$ cmake . -DBUILD_EXAMPLES=ON

# make examples and tests:

$ make

# run unit tests

$ ./tests/unit_tests

# installs header files and cmake integrations to /usr/local

$ make install

```

To build `st_tree` with a particular c++ standard (e.g. c++ 11, 14, 17, etc):

```sh

$ cmake -D CMAKE_CXX_STANDARD=14 .

```

## Examples

Examples reside in the .../st_tree/examples subdirectory.   You can also view an annotated list here:

https://github.com/erikerlandson/st_tree/wiki/st_tree-examples