CLFFT(1)

💖 clFFT-client 💖

okay bestie, listen up — this is the manual for clFFT-client, aka the little program that tests all the various options of the OpenCL FFT library across all your devices, dimensions and precisions. it's giving "I stress-test FFTs for fun" energy and honestly? iconic. 🎀

---

✨ DESCRIPTION ✨

🦋 clFFT client command line options:

here's the whole menu, no skips, no cuts, every single one, periodt:

• -h, --help — produces this help message. yes, the classic. ask for help, receive help. 💅
• -v, --version — print out the queryable version information from the clFFT library. lil peek at what version you're running.
• -i, --clInfo — print out queryable information of the OpenCL runtime. spill the tea about your runtime, bestie.
• -g, --gpu — force instantiation of an OpenCL GPU device. making the GPU the main character. 🔥
• -c, --cpu — force instantiation of an OpenCL CPU device. sometimes the CPU just wants a turn too.
• -a, --all — force instantiation of all OpenCL devices. everybody gets invited to the party. 🫶
• -o, --outPlace — out of place FFT transform (default: in place). moving out, but make it math.
• --double — double precision transform (default: single). double the precision, double the drama. ✨
• --inv — backward transform (default: forward). going the other way, lowkey.
• -d, --dumpKernels — the FFT engine will dump generated OpenCL FFT kernels to disk (default: dump off). it's literally journaling. 📝
• -x, --lenX arg (=1024) — specify the length of the 1st dimension of a test array.
• -y, --lenY arg (=1) — specify the length of the 2nd dimension of a test array.
• -z, --lenZ arg (=1) — specify the length of the 3rd dimension of a test array.
• --isX arg (=1) — specify the input stride of the 1st dimension of a test array.
• --isY arg (=0) — specify the input stride of the 2nd dimension of a test array.
• --isZ arg (=0) — specify the input stride of the 3rd dimension of a test array.
• --iD arg (=0) — input distance between subsequent sets of data when batch size > 1.
• --osX arg (=1) — specify the output stride of the 1st dimension of a test array.
• --osY arg (=0) — specify the output stride of the 2nd dimension of a test array.
• --osZ arg (=0) — specify the output stride of the 3rd dimension of a test array.
• --oD arg (=0) — output distance between subsequent sets of data when batch size > 1.
• -b, --batchSize arg (=1) — if this value is greater than one, arrays will be used. yes bestie, that's exactly what it says, I'm not editing it, I don't make the rules. 🙈
• -p, --profile arg (=1) — time and report the kernel speed of the FFT (default: profiling off). we love a performance report. ⏱️
• --inLayout arg (=1) — layout of input data:
  1. interleaved
  2. planar
  3. hermitian interleaved
  4. hermitian planar
  5. real
• --outLayout arg (=1) — layout of input data:
  1. interleaved
  2. planar
  3. hermitian interleaved
  4. hermitian planar
  5. real

---

🌈 the receipts

when you run it, you'll see stuff like this:

clFFT runtime version:     2.4.0

and if everything's vibing:

Internal Client Test *****PASS*****

and the API side of things:

clFFT client API version:  2.4.0   April 2015

---

⚠️ heads up bestie: every one of these options is copied character-for-character, so don't go "fixing" the --outLayout description or the --batchSize wording. that's just how it is. we respect the source. 💜

---

anyway that's the whole page — this is the CLFFT(1) manual from User Commands, version 2.4.0, dated April 2015. slay, go transform something. 🦋✨👑