arr - ARRay

Tired of writing the same old allocation and reallocation code whenever you want to resize arrays in C? Sick of having separate variables to keep track of your array's length? Or initalizing its elements to zero? This library offers arrays with a few extra features bolted on.

• Easy to Use (library only has four functions)
  • void* arr_Create(size_t length, size_t size)
  • void arr_Destory(void *array)
  • size_t arr_Length(const void *array)
  • void* arr_Append(void *array, const void *source, size_t length)
• Generic (can hold any kind of data)
• Intuitive (behaves like a normal array with indexing e.g. arr[i])
• Lightweight (less than 50 lines of source code)
• Performant (memory aligned elements)
• Portable (only uses the C standard library)
  • stddef.h
  • stdlib.h
  • string.h
• Resizable (can grow in length)

Example Code

---

Compute factorial using a dynamic array:

int factorial(int number) {
  int *n = arr_Create(0, sizeof(int));
  for(int i = 2; i <= number; i++) {
    n = arr_Append(n, &i, 1);
  }
  number = 1;
  for(int i = 0; i < arr_Length(n); i++) {
    number *= n[i];
  }
  arr_Destroy(n);
  return number;
}

arr$ make factorial 
gcc -fPIC -shared -I ./include ./src/arr.c -o ./arr.so
gcc -I ./include ./arr.so ./examples/factorial.c -o ./factorial.bin
./factorial.bin
1! = 1
2! = 2
3! = 6
4! = 24
5! = 120
6! = 720
rm ./factorial.bin

---

Library Functions

---

void* arr_Create(size_t length, size_t size)

Returns a allocated array with the specified length and element size. Returns null if the allocation failed.

• length number of element in the array.
• size size of each element.

---

void arr_Destroy(void *array)

Deallocates array.

• array array returned by arr_Create. Non null value.

---

size_t arr_Length(const void *array)

Returns the number of elments in the array.

• array array returned by arr_Create. Non null value

---

void* arr_Append(void *array, const void *source, size_t length)

Returns the reallocated array with source elements appended. Returns null if the reallocation failed.

• array array returned by arr_Create. Non null value.
• source source array to be copied. Non null value.
• length length of the source array.

---