Skip to content
/ farray Public

Initialize / Fill C++ array fast - O(1) time with only 1 extra bit of memory.

License

Notifications You must be signed in to change notification settings

tomhea/farray

Farray logo: Initialize Arrays in O(1)

Tests Badge GitHub file size in bytes GitHub release (latest by date) GitHub Website

Initialize arrays in constant time

C++ Header-only Implementation of the In-Place Initializable Arrays paper.

It's a templated array with constant-time fill(v), read(i), write(i,v) operations, all with just 1 bit of extra memory.
You can really sense the speedup it provides.

This single-file library is thoroughly tested, and is Embedded-friendly as it has no exceptions, and use no other library. It can also use no dynamic allocations.

The paper is based on the simpler Initializing an array in constant time - which uses 2n extra memory words.
I wrote a Medium article about array initialization and this project. Read it and come back 🧑‍💻.

Basic Use:

To use the array, just download and include the header file. That's it.

#include "farray1.hpp"

If you want to compile it without any dynamic allocations:

#define FARRAY1_NO_DYNAMIC_ALLOCATIONS
#include "farray1.hpp"

Using the Farray1 class:

// initialization (all to 1s)
Farray1<int> A(n, 1);   // Farray1 allocated an array be itself. 
                        // It can also take an already allocated array as a parameter.

// read & write
A[3] = 5;
int x = A[12] + A[19] + A[3];   // reading (1+1+5)

cout << "This must be seven: " << x << endl;

// simple initialization - all values are now 2020
A = 2020;     

for (int i = 5; i <= 10; i++)
    A[i] = i*i;
    
for (int i = 3; i <= 12; i++)
    cout << A[i] << " ";

The output will be:

This must be seven: 7
2020 2020 25 36 49 64 81 100 2020 2020 

You can also use the A.fill(v), A.read(i), A.write(i,v) syntax, instead of A=v, A[i], A[i]=v.

Also, indexing is circular, so A[i] is A[i % n] (e.g A[2n+5] == A[5] == A[-n+5]).

How much Faster? 🚀

Take a look at the time speedups gained by using Farray1 over a regular array.

Speedups of the average operation (read/write/fill) on Farray1/c-arrays of size 1000000:

When 10% of the operations are array-fills:
  Farray1<int64_t, 1000000> is 547 times(!) faster than int64_t[1000000].

When 2% of the operations are array-fills:
  Farray1<int64_t, 1000000> is 110 times(!) faster than int64_t[1000000].

When Only 0.2% of the operations are array-fills:
  Farray1<int64_t, 1000000> is  12 times(!) faster than int64_t[1000000].

When Only 0.05% of the operations are array-fills:
  Farray1<int64_t, 1000000> is   3 times(!) faster than int64_t[1000000].

You can also run the timings benchmark on your pc with times_farray1.cpp (takes about 5 minutes).

Farray Website!

This project has a Website! It covers to following topics: