icicle/examples/c++/ntt/README.md

Icicle example: Number-Theoretical Transform (NTT)

Key-Takeaway

Icicle provides CUDA C++ template function NTT for Number Theoretical Transform, also known as Discrete Fourier Transform.

Concise Usage Explanation

1. Include the curve api
2. Init NTT domain
3. Call ntt api

#include "icicle/api/bn254.h"
...
auto ntt_init_domain_cfg = default_ntt_init_domain_config();
...
bn254_ntt_init_domain(&basic_root, ntt_init_domain_cfg);
NTTConfig<scalar_t> config = default_ntt_config<scalar_t>();
...
bn254_ntt(input.get(), ntt_size, NTTDir::kForward, config, output.get())

Running the example

# for CPU
./run.sh -d CPU
# for CUDA
./run.sh -d CUDA -b /path/to/cuda/backend/install/dir

What's in the example

1. Define the size of the example
2. Initialize input
3. Run Radix2 NTT
4. Run MixedRadix NTT
5. Validate the data output