Skip to content

Commit e2941a6

Browse files
committed
Docu: add example usage
1 parent daaa811 commit e2941a6

1 file changed

Lines changed: 44 additions & 1 deletion

File tree

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,48 @@
1-
# DynamicArrayLib for C
1+
<h1>DynamicArrayLib for C</h1>
22

33
> [!IMPORTANT]
44
> For educational purposes only. Please don't use this library in a real-world implementation.
55
6+
## Table of contents
7+
8+
- [Table of contents](#table-of-contents)
9+
- [Examples](#examples)
10+
- [Create dynamic array of integers](#create-dynamic-array-of-integers)
11+
- [Create two dimensional dynamic array of integers](#create-two-dimensional-dynamic-array-of-integers)
12+
13+
## Examples
14+
15+
### Create dynamic array of integers
16+
17+
```C
18+
DynamicArray dynamic_array;
19+
init_array(&dynamic_array);
20+
21+
const int max_integers = 10;
22+
23+
for (int i=0; i <= max_integers; i++) {
24+
append_element(&dynamic_array, sizeof(int), (void*)&i);
25+
}
26+
27+
// Don't forget to deallocate
28+
clear_array(&dynamic_array);
29+
```
30+
31+
### Create two dimensional dynamic array of integers
32+
33+
```C
34+
DynamicArray dynamic_array;
35+
init_array(&dynamic_array);
36+
37+
DynamicArray sub_dynamic_array;
38+
const int max_sub_dyn_arrays = 10;
39+
40+
for (int array_counter = 0; array_counter <= max_sub_dyn_arrays; array_counter++) {
41+
init_array(&sub_dynamic_array);
42+
append_element(&sub_dynamic_array, sizeof(int), (void*)&array_counter);
43+
append_element(&dynamic_array, sizeof(DynamicArray), (void*)&sub_dynamic_array);
44+
}
45+
46+
// Don't forget to deallocate
47+
clear_array(&dynamic_array);
48+
```

0 commit comments

Comments
 (0)