https://github.com/ryanoutcome20/dynamic-arrays
Adds support for dynamic arrays in base C.
https://github.com/ryanoutcome20/dynamic-arrays
array c dynamic-array dynamic-arrays memory
Last synced: 3 months ago
JSON representation
Adds support for dynamic arrays in base C.
- Host: GitHub
- URL: https://github.com/ryanoutcome20/dynamic-arrays
- Owner: ryanoutcome20
- License: gpl-3.0
- Created: 2024-11-16T05:51:58.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T07:55:48.000Z (12 months ago)
- Last Synced: 2025-02-01T07:25:20.401Z (9 months ago)
- Topics: array, c, dynamic-array, dynamic-arrays, memory
- Language: C
- Homepage:
- Size: 217 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dynamic-Arrays
Dynamic-Arrays is a simple lightweight library that brings dynamic array functionality to the C programming language. Simply include the header file ("*dynamic_array.h*"). This was made as a proof of concept to make sure I understood memory management & pointers in C.
## Features
- **Core Functionality**: Provides operations to add, remove, fetch elements, and get the current size of the array.
- **Extensible Design**: Future updates will add support for advanced operations and the library is simple to edit and improve.
- **Ease of Integration**: Designed to easily integrate into existing C projects with minimal setup.
## Getting Started
### Prerequisites
Before you begin, make sure you have the following installed on your system:
- [GCC](https://gcc.gnu.org/) or similar C compiler.
Afterwhich ensure your compiler supports the C99 or newer standard. Use the -std=c99 flag with GCC if needed.
### Installation
1. Cloning the repository:
```bash
git clone https://github.com/ryanoutcome20/Dynamic-Arrays.git
```
2. Copy the "*dynamic_array.h*" & "*dynamic_array.c*" file to your working directory.
3. Include the header file in your project:
```c
#include "dynamic_array.h"
```
### Usage
For a full usage documentation refer to both the *tests* folder and documentation. Full documentation is auto-generated using [Doxygen](https://www.doxygen.nl/manual/starting.html). See the docs folder or generate it yourself using the provided Doxyfile. The header file contains special information that you can read as well.
### Contributing
If you find a bug or want to add a new feature, feel free to fork the repository and submit a pull request.
## License
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](./LICENSE) file for more details.