Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/jackr276/mempool
Browse files Browse the repository at this point in the history
  • Loading branch information
jackr276 committed Sep 9, 2024
2 parents 886cbe5 + 47bd283 commit 82c78c0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ The `mempool_free` function releases the memory chunk that is pointed to by `ptr
- Releasing: O(n) for freeing blocks. This O(n) comes from the automatic defragmentation of the block allocated when `malloc_free` is called.

## Using mempool
**mempool** is designed to be used intelligently by a user who has a deep understanding of the memory needs and characteristics of their project, and gives you all the power. As such, making the right choices when it comes to default block size is very important. There is a [demo branch](https://github.com/jackr276/mempool/tree/demo) that shows the use of mempool in an A* solver. I would encourage anyone wishing to use it to look at the specific places where mempool is used, and the places where it is not used. The main branch just contains the header file `mempool.h` and the implementation file `mempool.c` that need to be included in your project if you wish to use mempool. `mempool.c` will need to be on the build path if you have it in your project.
**mempool** is designed to be used intelligently by a user who has a deep understanding of the memory needs and characteristics of their project, and gives you all the power. As such, making the right choices when it comes to default block size is very important. There is a [demo branch](https://github.com/jackr276/mempool/tree/demo) that shows the use of mempool in an A* solver. I would encourage anyone wishing to use it to look at the specific places where mempool is used, and the places where it is not used. The main branch just contains the header file `mempool.h` and the implementation file `mempool.c` that need to be included in your project if you wish to use mempool. `mempool.c` will need to be on the build path if you have it in your project. The [Makefile](https://github.com/jackr276/mempool/blob/main/Makefile) shows examples of how to include the program with make, and the example program [main.c](https://github.com/jackr276/mempool/blob/main/src/main.c) shows some very simple examples on usage.

0 comments on commit 82c78c0

Please sign in to comment.