diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1f30b54 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2025 Oliver Theimer + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..50cd417 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# BBDD Manipulation package + +A C++ library for creating, manipulating, and analyzing **Biconditional Binary Decision Diagrams (BBDDs)**. +It provides efficient data structures and algorithms for representing boolean functions in the form of BBDDs, with an intuitive API for integration into projects. + +--- + +## 📂 Project Structure + +Below is an overview of the main files and directories: + +- `include/` - Public headers + - `bbdd.hpp` - main functionality of merging and extending bbdds + - `bbdd_node.hpp` - bbdd node definition, hashing function, dumping node, compare nodes + - `bbdd_types.hpp` - bbdd cases, bbdd operations, and pointer sized + - `chain_variable_ordering.hpp` - creating and manipulating chain variable ordering + - `computed_table.hpp` - merge cache data structure + - `extend_table.hpp` - extend cache data structure + - `unique_table.hpp` - main storage structure with inserting and deleting functions + - `util.hpp` - converting cubes to boolean operation, progress bar + +- `examples/` - Usage demonstrations + - `example_basic.cpp` - TODO + +- `CMakeLists.txt` - Build configuration (CMake project setup) +- `README.md` - This file +- `LICENSE` - License file + +--- + +## Getting Started + +TODO + +### Installation requirements + +TODO + +### Build with CMake +```bash +git clone https://phabricator.ict.tuwien.ac.at/source/SoC_BBDD_Library.git +mkdir build && cd build +cmake .. +make +``` + +### Example + +TODO