qalloc

qalloc copied to clipboard

QAlloc

A quick pool allocator for c++ with type info and gc support
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

The project is a simple, fast, and memory-efficient pool allocator for c and c++. It is still underdevelopment and not production ready. More testing is needed to ensure it works in general cases.

Features:

• Header only
• Type-aware memory management
• Garbage collection
• Dynamic pool size

Requirements

• Compiler that supports c++ 11 or later

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

A c++ compiler supporting c++ 11 or later is required.

For example:

• clang++ (linux, macos, windows, etc.)
• g++ (linux, macos, windows, etc.)
• msvc (windows)
• mingw (windows)
• cygwin-gcc (windows)

Installation

This is a header-only library. Doesn't require any other dependencies.

1. Clone the repo

   git clone https://github.com/yusing/qalloc.git
   

2. Add include as include path to your project
3. Include <qalloc/qalloc.hpp> in your project

(back to top)

Usage

For examples, please refer to example.cpp

(back to top)

Benchmark Results

See benchmark.cpp for source code

Running Platform:

• Windows 11 21H1
• Intel i7-10700K CPU @ 5.00GHz 16GB RAM
• Clang 14.0.6 c++17 x64 build

String vector emplace and reset

Int vector emplace and reset

String creation

String append and reset

unordered_map<int, int> insert and reset

list<double> emplace and reset

(back to top)

Roadmap

• [ ] Diagrams on how it works internally
• [ ] More tests on different memory patterns
• [ ] Compare to other pool allocators
• [ ] Better benchmark cases
• [ ] Full documentation
• [ ] Full multi-thread support
• [ ] c++20 constexpr
• [ ] Memory allocation visualization

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Alternatively, you can create feature requests on the open issues page.

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

yusing - [email protected]

Project Link: https://github.com/yusing/qalloc

(back to top)